Utveckla Azure AI-tjänstprogram med Azure Key Vault

• En giltig Azure-prenumeration – Skapa en kostnadsfritt
• Visual Studio IDE
• Ett Azure Key Vault
• En Azure AI-tjänstresurs

• En giltig Azure-prenumeration – Skapa en kostnadsfritt.
• Python 3.7 eller senare
• Azure CLI eller Azure PowerShell
• Ett Azure Key Vault
• En Azure AI-tjänstresurs

• En giltig Azure-prenumeration – Skapa en kostnadsfritt.
• Java Development Kit (JDK) version 8 eller senare
• Azure CLI eller Azure PowerShell
• Ett Azure Key Vault
• En Azure AI-tjänstresurs

• En giltig Azure-prenumeration – Skapa en kostnadsfritt.
• Aktuell Node.js v14 LTS eller senare
• Azure CLI eller Azure PowerShell
• Ett Azure Key Vault
• En Azure AI-tjänstresurs

Autentisera till Azure med Visual Studio

Utvecklare som använder Visual Studio 2017 eller senare kan autentisera ett Microsoft Entra-konto via Visual Studio. På så sätt kan du komma åt hemligheter i ditt nyckelvalv genom att logga in på din Azure-prenumeration inifrån IDE:t.

Om du vill autentisera i Visual Studio väljer du Verktyg på den översta navigeringsmenyn och väljer Alternativ. Gå till alternativet Azure Service Authentication för att logga in med ditt användarnamn och lösenord.

Autentisera med hjälp av kommandoraden

Innan du kan ge åtkomst till ditt nyckelvalv måste du autentisera med ditt Microsoft Entra-användarnamn och lösenord.

az login

Connect-AzAccount

Bevilja åtkomst till ditt nyckelvalv

Skapa en åtkomstprincip för ditt nyckelvalv som ger ditt användarkonto hemliga behörigheter.

az keyvault set-policy --name Your-Key-Vault-Name --upn user@domain.com --secret-permissions delete get list set purge

Set-AzKeyVaultAccessPolicy -VaultName 'Your-Key-Vault-Name' -UserPrincipalName 'user@domain.com' -PermissionsToSecrets delete,get,list,set,purge -PassThru

Skapa ett nytt C#-program

Skapa en ny .NET Core-konsolapp med Visual Studio IDE. Då skapas ett "Hello World"-projekt med en enda C#-källfil: program.cs.

Installera följande klientbibliotek genom att högerklicka på lösningen i Istraživač rešenja och välja Hantera NuGet-paket. I pakethanteraren som öppnas väljer du Bläddra och söker efter följande bibliotek och väljer Installera för var och en:

• Azure.Security.KeyVault.Secrets
• Azure.Identity

Importera exempelkoden

Kopiera följande exempelkod till filen program.cs . Ersätt Your-Key-Secret-Name och Your-Endpoint-Secret-Name med de hemliga namn som du angav i nyckelvalvet.

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Identity;
using Azure.Security.KeyVault.Secrets;
using System.Net;

namespace key_vault_console_app
{
    class Program
    {
        static async Task Main(string[] args)
        {
            //Name of your key vault
            var keyVaultName = Environment.GetEnvironmentVariable("KEY_VAULT_NAME");

            //variables for retrieving the key and endpoint from your key vault.
            //Set these variables to the names you created for your secrets
            const string keySecretName = "Your-Key-Secret-Name";
            const string endpointSecretName = "Your-Endpoint-Secret-Name";

            //Endpoint for accessing your key vault
            var kvUri = $"https://{keyVaultName}.vault.azure.net";

            var keyVaultClient = new SecretClient(new Uri(kvUri), new DefaultAzureCredential());

            Console.WriteLine($"Retrieving your secrets from {keyVaultName}.");

            //Key and endpoint secrets retrieved from your key vault
            var keySecret = await keyVaultClient.GetSecretAsync(keySecretName);
            var endpointSecret = await keyVaultClient.GetSecretAsync(endpointSecretName);
            Console.WriteLine($"Your key secret value is: {keySecret.Value.Value}");
            Console.WriteLine($"Your endpoint secret value is: {endpointSecret.Value.Value}");
            Console.WriteLine("Secrets retrieved successfully");

        }
    }
}

Kör appen

Kör programmet genom att välja knappen Felsök överst i Visual Studio. Dina nyckel- och slutpunktshemligheter hämtas från nyckelvalvet.

Skicka ett testspråktjänstanrop (valfritt)

Om du använder en resurs för flera tjänster eller en språkresurs kan du uppdatera ditt program genom att följa de här stegen för att skicka ett exempel på ett anrop för namngiven entitetsigenkänning genom att hämta en nyckel och en slutpunkt från nyckelvalvet.

1. Azure.AI.TextAnalytics Installera biblioteket genom att högerklicka på lösningen i Istraživač rešenja och välja Hantera NuGet-paket. I pakethanteraren som öppnas väljer du Bläddra och söker efter följande bibliotek och väljer Installera för var och en:

2. Lägg till följande direktiv överst program.cs i filen.

   using Azure.AI.TextAnalytics;
   

3. Lägg till följande kodexempel i ditt program.

   // Example method for extracting named entities from text 
   private static void EntityRecognitionExample(string keySecret, string endpointSecret)
   {
       //String to be sent for Named Entity Recognition
       var exampleString = "I had a wonderful trip to Seattle last week.";
   
       AzureKeyCredential azureKeyCredential = new AzureKeyCredential(keySecret);
       Uri endpoint = new Uri(endpointSecret);
       var languageServiceClient = new TextAnalyticsClient(endpoint, azureKeyCredential);
   
       Console.WriteLine($"Sending a Named Entity Recognition (NER) request");
       var response = languageServiceClient.RecognizeEntities(exampleString);
       Console.WriteLine("Named Entities:");
       foreach (var entity in response.Value)
       {
           Console.WriteLine($"\tText: {entity.Text},\tCategory: {entity.Category},\tSub-Category: {entity.SubCategory}");
           Console.WriteLine($"\t\tScore: {entity.ConfidenceScore:F2},\tLength: {entity.Length},\tOffset: {entity.Offset}\n");
       }
   }
   

4. Lägg till följande kod för att anropa EntityRecognitionExample() från huvudmetoden med dina nyckel- och slutpunktsvärden.

   EntityRecognitionExample(keySecret.Value.Value, endpointSecret.Value.Value);
   

5. Kör programmet.

Autentisera programmet

Innan du kan ge åtkomst till ditt nyckelvalv måste du autentisera med ditt Microsoft Entra-användarnamn och lösenord.

az login

Connect-AzAccount

Bevilja åtkomst till ditt nyckelvalv

Skapa en åtkomstprincip för ditt nyckelvalv som ger ditt användarkonto hemliga behörigheter.

az keyvault set-policy --name Your-Key-Vault-Name --upn user@domain.com --secret-permissions delete get list set purge

Set-AzKeyVaultAccessPolicy -VaultName 'Your-Key-Vault-Name' -UserPrincipalName 'user@domain.com' -PermissionsToSecrets delete,get,list,set,purge -PassThru

Skapa ett Python-program

Skapa en ny mapp med namnet keyVaultExample. Använd sedan önskad kodredigerare för att skapa en fil med namnet program.py i den nyligen skapade mappen.

Installera key vault- och språktjänstpaket

1. I en terminal eller kommandotolk går du till projektmappen och installerar Microsoft Entra-identitetsbiblioteket:

   pip install azure-identity
   

2. Installera key vault-hemlighetsbiblioteket:

   pip install azure-keyvault-secrets
   

Importera exempelkoden

Lägg till följande kodexempel i filen med namnet program.py. Ersätt Your-Key-Secret-Name och Your-Endpoint-Secret-Name med de hemliga namn som du angav i nyckelvalvet.

import os
from azure.keyvault.secrets import SecretClient
from azure.identity import DefaultAzureCredential
from azure.core.credentials import AzureKeyCredential

keyVaultName = os.environ["KEY_VAULT_NAME"]

# Set these variables to the names you created for your secrets
keySecretName = "Your-Key-Secret-Name"
endpointSecretName = "Your-Endpoint-Secret-Name"

# URI for accessing key vault
KVUri = f"https://{keyVaultName}.vault.azure.net"

# Instantiate the client and retrieve secrets
credential = DefaultAzureCredential()
kv_client = SecretClient(vault_url=KVUri, credential=credential)

print(f"Retrieving your secrets from {keyVaultName}.")

retrieved_key = kv_client.get_secret(keySecretName).value
retrieved_endpoint = kv_client.get_secret(endpointSecretName).value

print(f"Your secret key value is {retrieved_key}.");
print(f"Your secret endpoint value is {retrieved_endpoint}.");

Kör appen

Använd följande kommando för att köra programmet. Dina nyckel- och slutpunktshemligheter hämtas från nyckelvalvet.

python ./program.py

Skicka ett testspråktjänstanrop (valfritt)

Om du använder en resurs för flera tjänster eller en språkresurs kan du uppdatera ditt program genom att följa de här stegen för att skicka ett exempel på ett anrop för namngiven entitetsigenkänning genom att hämta en nyckel och en slutpunkt från nyckelvalvet.

1. Installera språktjänstbiblioteket:

   pip install azure-ai-textanalytics==5.1.0
   

2. Lägg till följande kod i ditt program

   from azure.ai.textanalytics import TextAnalyticsClient
   # Authenticate the key vault secrets client using your key and endpoint 
   azure_key_credential = AzureKeyCredential(retrieved_key)
   # Now you can use key vault credentials with the Language service
   language_service_client = TextAnalyticsClient(
       endpoint=retrieved_endpoint, 
       credential=azure_key_credential)
   
   # Example of recognizing entities from text
   
   print("Sending NER request")
   
   try:
       documents = ["I had a wonderful trip to Seattle last week."]
       result = language_service_client.recognize_entities(documents = documents)[0]
       print("Named Entities:\n")
       for entity in result.entities:
           print("\tText: \t", entity.text, "\tCategory: \t", entity.category, "\tSubCategory: \t", entity.subcategory,
                   "\n\tConfidence Score: \t", round(entity.confidence_score, 2), "\tLength: \t", entity.length, "\tOffset: \t", entity.offset, "\n")
   
   except Exception as err:
       print("Encountered exception. {}".format(err))
   

3. Kör programmet.

Autentisera programmet

Innan du kan ge åtkomst till ditt nyckelvalv måste du autentisera med ditt Microsoft Entra-användarnamn och lösenord.

az login

Connect-AzAccount

Bevilja åtkomst till ditt nyckelvalv

Skapa en åtkomstprincip för ditt nyckelvalv som ger ditt användarkonto hemliga behörigheter.

az keyvault set-policy --name Your-Key-Vault-Name --upn user@domain.com --secret-permissions delete get list set purge

Set-AzKeyVaultAccessPolicy -VaultName 'Your-Key-Vault-Name' -UserPrincipalName 'user@domain.com' -PermissionsToSecrets delete,get,list,set,purge -PassThru

Skapa ett Java-program

I önskad IDE skapar du ett nytt Java-konsolprogramprojekt och skapar en klass med namnet Example.

Lägga till beroenden

I projektet lägger du till följande beroenden i pom.xml filen.

<dependencies>
    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-security-keyvault-secrets</artifactId>
        <version>4.2.3</version>
    </dependency>
    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-identity</artifactId>
        <version>1.2.0</version>
    </dependency>
</dependencies>

Importera exempelkoden

Kopiera följande kod till en fil med namnet Example.java. Ersätt Your-Key-Secret-Name och Your-Endpoint-Secret-Name med de hemliga namn som du angav i nyckelvalvet.

import com.azure.identity.DefaultAzureCredentialBuilder;
import com.azure.security.keyvault.secrets.SecretClient;
import com.azure.security.keyvault.secrets.SecretClientBuilder;
import com.azure.core.credential.AzureKeyCredential;

public class Example {

    public static void main(String[] args) {

        String keyVaultName = System.getenv("KEY_VAULT_NAME");
        String keyVaultUri = "https://" + keyVaultName + ".vault.azure.net";

        //variables for retrieving the key and endpoint from your key vault.
        //Set these variables to the names you created for your secrets
        String keySecretName = "Your-Key-Secret-Name";
        String endpointSecretName = "Your-Endpoint-Secret-Name";

        //Create key vault secrets client
        SecretClient secretClient = new SecretClientBuilder()
                .vaultUrl(keyVaultUri)
                .credential(new DefaultAzureCredentialBuilder().build())
                .buildClient();

        //retrieve key and endpoint from key vault
        String keyValue = secretClient.getSecret(keySecretName).getValue();
        String endpointValue = secretClient.getSecret(endpointSecretName).getValue();
        System.out.printf("Your secret key value is: %s", keyValue)
        System.out.printf("Your secret endpoint value is: %s", endpointValue)
    }
}

Skicka ett testspråktjänstanrop (valfritt)

Om du använder en resurs för flera tjänster eller en språkresurs kan du uppdatera ditt program genom att följa de här stegen för att skicka ett exempel på ett anrop för namngiven entitetsigenkänning genom att hämta en nyckel och en slutpunkt från nyckelvalvet.

1. Lägg till följande beroende i ditt program:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-ai-textanalytics</artifactId>
       <version>5.1.12</version>
   </dependency>
   

2. lägg till följande importinstruktioner i filen.

   import com.azure.ai.textanalytics.models.*;
   import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
   import com.azure.ai.textanalytics.TextAnalyticsClient;
   

3. Lägg till följande kod i main() -metoden i ditt program:

   
   TextAnalyticsClient languageClient = new TextAnalyticsClientBuilder()
           .credential(new AzureKeyCredential(keyValue))
           .endpoint(endpointValue)
           .buildClient();
   
   // Example for recognizing entities in text
   String text = "I had a wonderful trip to Seattle last week.";
   
   for (CategorizedEntity entity : languageClient.recognizeEntities(text)) {
       System.out.printf(
               "Recognized entity: %s, entity category: %s, entity sub-category: %s, score: %s, offset: %s, length: %s.%n",
               entity.getText(),
               entity.getCategory(),
               entity.getSubcategory(),
               entity.getConfidenceScore(),
               entity.getOffset(),
               entity.getLength());
   }
   

4. Köra ditt program

Autentisera programmet

Innan du kan ge åtkomst till ditt nyckelvalv måste du autentisera med ditt Microsoft Entra-användarnamn och lösenord.

az login

Connect-AzAccount

Bevilja åtkomst till ditt nyckelvalv

Skapa en åtkomstprincip för ditt nyckelvalv som ger ditt användarkonto hemliga behörigheter.

az keyvault set-policy --name Your-Key-Vault-Name --upn user@domain.com --secret-permissions delete get list set purge

Set-AzKeyVaultAccessPolicy -VaultName 'Your-Key-Vault-Name' -UserPrincipalName 'user@domain.com' -PermissionsToSecrets delete,get,list,set,purge -PassThru

Skapa ett nytt Node.js-program

Skapa ett Node.js program som använder ditt nyckelvalv.

I en terminal skapar du en mapp med namnet key-vault-js-example och ändrar till den mappen:

mkdir key-vault-js-example && cd key-vault-js-example

Initiera Node.js projektet:

npm init -y

Installera key vault- och språktjänstpaket

1. Använd terminalen och installera Azure Key Vault-hemlighetsbiblioteket @azure/keyvault-secrets för Node.js.

   npm install @azure/keyvault-secrets
   

2. Installera Azure Identity-biblioteket @azure /identitetspaketet för att autentisera till ett Nyckelvalv.

   npm install @azure/identity
   

Importera kodexemplet

Lägg till följande kodexempel i en fil med namnet index.js. Ersätt Your-Key-Secret-Name och Your-Endpoint-Secret-Name med de hemliga namn som du angav i nyckelvalvet.

const { SecretClient } = require("@azure/keyvault-secrets");
const { DefaultAzureCredential } = require("@azure/identity");
// Load the .env file if it exists
const dotenv = require("dotenv");
dotenv.config();

async function main() {
    const credential = new DefaultAzureCredential();

    const keyVaultName = process.env["KEY_VAULT_NAME"];
    const url = "https://" + keyVaultName + ".vault.azure.net";

    const kvClient = new SecretClient(url, credential);

    // Set these variables to the names you created for your secrets
    const keySecretName = "Your-Key-Secret-Name";
    const endpointSecretName = "Your-Endpoint-Secret-Name";

    console.log("Retrieving secrets from ", keyVaultName);
    const retrievedKey = await (await kvClient.getSecret(keySecretName)).value;
    const retrievedEndpoint = await (await kvClient.getSecret(endpointSecretName)).value;
    console.log("Your secret key value is: ", retrievedKey);
    console.log("Your secret endpoint value is: ", retrievedEndpoint);
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Köra exempelprogrammet

Använd följande kommando för att köra programmet. Dina nyckel- och slutpunktshemligheter hämtas från nyckelvalvet.

node index.js

Skicka ett testspråktjänstanrop (valfritt)

Om du använder en resurs för flera tjänster eller en språkresurs kan du uppdatera ditt program genom att följa de här stegen för att skicka ett exempel på ett anrop för namngiven entitetsigenkänning genom att hämta en nyckel och en slutpunkt från nyckelvalvet.

1. Installera Azure AI-tjänsten för språkbiblioteket @azure /ai-text-analytics för att skicka API-begäranden till språktjänsten.

   npm install @azure/ai-text-analytics@5.1.0
   

2. Lägg till följande kod i programmet:

   const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
   // Authenticate the language client with your key and endpoint
   const languageClient = new TextAnalyticsClient(retrievedEndpoint,  new AzureKeyCredential(retrievedKey));
   
   // Example for recognizing entities in text
   console.log("Sending NER request")
   const entityInputs = [
       "I had a wonderful trip to Seattle last week."
   ];
   const entityResults = await languageClient.recognizeEntities(entityInputs);
   entityResults.forEach(document => {
       console.log(`Document ID: ${document.id}`);
       document.entities.forEach(entity => {
           console.log(`\tName: ${entity.text} \tCategory: ${entity.category} \tSubcategory: ${entity.subCategory ? entity.subCategory : "N/A"}`);
           console.log(`\tScore: ${entity.confidenceScore}`);
       });
   });
   

3. Kör programmet.