Erste Schritte mit Azure Key Vault-Geheimnissen in JavaScript

  • Artikel

In diesem Artikel erfahren Sie, wie Sie mithilfe der Clientbibliothek für Azure Key Vault-Geheimnisse für JavaScript eine Verbindung mit Azure Key Vault herstellen. Sobald die Verbindung hergestellt ist, kann Ihr Code mit Geheimnissen und geheimen Eigenschaften im Tresor arbeiten.

API-Referenz | Paket (npm) | Quellcode der Bibliothek | Beispiele | Feedback geben

Voraussetzungen

Einrichten des Projekts

  1. Öffnen Sie eine Eingabeaufforderung, und wechseln Sie in Ihren Projektordner. Ändern Sie YOUR-DIRECTORY in den Ordnernamen:

    cd YOUR-DIRECTORY

  2. Wenn Sie noch keine package.json-Datei in Ihrem Verzeichnis haben, initialisieren Sie das Projekt, um die Datei zu erstellen:

    npm init -y

  3. Installieren Sie die Clientbibliothek für Azure Key Vault-Geheimnisse für JavaScript:

    npm install @azure/keyvault-secrets

  4. Wenn Sie kennwortlose Verbindungen mit Microsoft Entra ID verwenden möchten, installieren Sie die Azure Identity-Clientbibliothek für JavaScript:

    npm install @azure/identity

Autorisieren des Zugriffs und Herstellen einer Verbindung mit Key Vault

Microsoft Entra ID bietet die sicherste Verbindung, durch die Verwaltung der Verbindungsidentität (verwaltete Identität). Mit der kennwortlosen Funktionalität können Sie eine Anwendung entwickeln, die keine Speicherung von Geheimnissen (Schlüsseln oder Verbindungszeichenfolgen) im Code erfordert.

Bevor Sie sich bei Azure programmgesteuert authentifizieren, um Azure Key Vault-Geheimnisse zu verwenden, stellen Sie sicher, dass Sie Ihre Umgebung einrichten.

Diagram of Azure SDK for JavaScript credential flow.

Ein Entwickler sollte die Azure CLI installieren und sich interaktiv mit dem Befehl az login bei Azure anmelden, bevor er „DefaultAzureCredential“ im Code verwendet.

az login

Erstellen Ihrer Anwendung

Wenn Sie Ihre Anwendung erstellen, interagiert Ihr Code mit zwei Arten von Ressourcen:

  • KeyVaultSecret, das Folgendes umfasst:
    • Geheimnisname, ein Zeichenfolgenwert.
    • Geheimniswert, bei dem es sich um eine Zeichenfolge des Geheimnisses handelt. Sie stellen die Serialisierung und Deserialisierung des Geheimniswerts nach Bedarf in und aus einer Zeichenfolge bereit.
    • Geheimniseigenschaften:
  • SecretProperties, die die Metadaten des Geheimnisses enthalten, wie Name, Version, Tags, Ablaufdaten und Aktivierungsstatus.

Wenn Sie den Wert von „KeyVaultSecret“ benötigen, verwenden Sie Methoden, die KeyVaultSecret zurückgeben:

Die übrigen Methoden geben das SecretProperties-Objekt oder eine andere Form der Eigenschaften zurück. Beispiel:

Erstellen eines SecretClient-Objekts

Das SecretClient-Objekt ist das oberste Objekt im SDK. Dieser Client ermöglicht es Ihnen, die Geheimnisse zu manipulieren.

Sobald Ihre Azure Key Vault-Zugriffsrollen und Ihre lokale Umgebung festgelegt sind, erstellen Sie eine JavaScript-Datei, die das Paket @azure/identity enthält. Erstellen Sie Anmeldeinformationen, z. B. DefaultAzureCredential, um kennwortlose Verbindungen mit Ihrem Tresor zu implementieren. Verwenden Sie diese Anmeldeinformationen zur Authentifizierung mit einem SecretClient-Objekt.

// Include required dependencies
import { DefaultAzureCredential } from '@azure/identity';  
import { SecretClient } from '@azure/keyvault-secrets';  

// Authenticate to Azure
const credential = new DefaultAzureCredential(); 

// Create SecretClient
const vaultName = '<your-vault-name>';  
const url = `https://${vaultName}.vault.azure.net`;  
const client = new SecretClient(url, credential);  

// Get secret
const secret = await client.getSecret("MySecretName");

Siehe auch

Nächste Schritte