Freigeben über

Abrufen eines Schlüssels in Azure Key Vault mit JavaScript

  • Artikel

Erstellen Sie den KeyClient mit den entsprechenden Anmeldeinformationen für die programmgesteuerte Authentifizierung, und verwenden Sie dann den Client, um einen Schlüssel in Azure Key Vault festzulegen, zu aktivieren und zu rotieren.

Abrufen des Schlüssels

Sie können die neueste Version eines Schlüssels oder eine bestimmte Version eines Schlüssels mit der getKey-Methode abrufen. Die Version befindet sich in den Eigenschaften des KeyVaultKey-Objekts.

  • Letzte Version abrufen: await client.getKey(name);
  • Spezifische Version abrufen: await client.getKey(name, { version });
// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
    KeyClient,
} from '@azure/keyvault-keys';

// Authenticate to Azure Key Vault
const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

const name = `myRsaKey`;

// Get latest key
const latestKey = await client.getKey(name);
console.log(`${latestKey.name} version is ${latestKey.properties.version}`);

// Get previous key by version id
const keyPreviousVersionId = '2f2ec6d43db64d66ad8ffa12489acc8b';
const keyByVersion = await client.getKey(name, {
    version: keyPreviousVersionId
});
console.log(`Previous key version is ${keyByVersion.properties.version}`);

Abrufen aller Versionen eines Schlüssels

Um alle Schlüsselversionen in Azure Key Vault abzurufen, verwenden Sie die listPropertiesOfKeyVersions-Methode der KeyClient-Klasse, um eine kursierbare Liste der Eigenschaften der Schlüsselversion abzurufen. Dadurch wird ein KeyProperties-Objekt zurückgegeben, das den Wert der Version nicht enthält. Wenn Sie den Wert der Version wünschen, verwenden Sie die in der -Eigenschaft zurückgegebene Version, um den Wert des Geheimnisses mit der getKey-Methode abzurufen.

Methode Rückgabewert Gibt Eigenschaften zurück
getKey Ja Ja
listPropertiesOfKeyVersions Nein Ja 
// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
    KeyClient,
} from '@azure/keyvault-keys';

// Authenticate to Azure Key Vault
const credential = new DefaultAzureCredential();
const client = new KeyClient(
    `https://${process.env.AZURE_KEYVAULT_NAME}.vault.azure.net`,
    credential
);

const name = `myRsaKey`;

for await (const keyProperties of client.listPropertiesOfKeyVersions(name)) {
    const thisVersion = keyProperties.version;
    
    const { key } = await client.getKey(name, {
        version: thisVersion
    });

    // do something with version's key value
}

Abrufen des deaktivierten Schlüssels

Verwenden Sie die folgende Tabelle, um zu verstehen, was Sie mit einem deaktivierten Schlüssel tun können.

Zulässig Nicht zulässig
Aktivieren des Schlüssels
Aktualisieren von Eigenschaften		 Wert abrufen

Nächste Schritte