Abrufen eines Schlüssels in Azure Key Vault mit JavaScript

Erstellen Sie den KeyClient mit den entsprechenden programmgesteuerten Authentifizierungsanmeldeinformationen, und verwenden Sie dann den Client, um einen Schlüssel im Azure Key Vault festzulegen, zu aktualisieren und zu drehen.

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 innerhalb der Eigenschaften des KeyVaultKey-Objekts .

• Aktuelle Version abrufen: await client.getKey(name);
• Bestimmte 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 Versionen eines Schlüssels in Azure Key Vault abzurufen, verwenden Sie die listPropertiesOfKeyVersions Methode der KeyClient-Klasse, um eine iterierbare Liste der Eigenschaften des Schlüssels abzurufen. Dadurch wird ein KeyProperties-Objekt zurückgegeben, das nicht den Wert der Version enthält. Wenn Sie den Wert der Version verwenden möchten, verwenden Sie die in der Eigenschaft zurückgegebene Version, um den Wert des Schlüssels mit der getKey-Methode abzurufen.

Methode	Gibt den Wert zurück.	Gibt Eigenschaften zurück.
getKey	Yes	Yes
listPropertiesOfKeyVersions	Nein	Yes

// 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
}

Deaktivierten Schlüssel abrufen

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

Zulässig	Nicht zulässig
Taste aktivieren Aktualisieren von Eigenschaften	Wert abrufen

Nächste Schritte

• Aktivieren und Deaktivieren des Schlüssels im JavaScript SDK