Partager via


Obtenir une clé dans Azure Key Vault avec JavaScript

Créez le KeyClient avec les informations d’identification d’authentification par programmation appropriées, puis utilisez le client pour définir, mettre à jour et faire pivoter une clé dans Azure Key Vault.

Obtenir la clé

Vous pouvez obtenir la dernière version d’une clé ou une version spécifique d’une clé avec la méthode getKey. La version se trouve dans les propriétés de l’objet KeyVaultKey.

  • Obtenir la version la plus récente : await client.getKey(name);
  • Obtenir une version spécifique : 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}`);

Obtenir toutes les versions d’une clé

Pour obtenir toutes les versions d’une clé dans Azure Key Vault, utilisez la méthode listPropertiesOfKeyVersions de la classe KeyClient pour obtenir une liste itérable des propriétés de la version de la clé. Cela renvoie un objet KeyProperties qui n’inclut pas la valeur de la version. Si vous souhaitez obtenir la valeur de la version, utilisez la version retournée dans la propriété pour obtenir la valeur de la clé avec la méthode getKey.

Méthode Renvoie une valeur Renvoie des propriétés
getKey Oui Oui
listPropertiesOfKeyVersions Non Oui
// 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
}

Obtenir une clé désactivée

Utilisez le tableau suivant pour comprendre ce que vous pouvez faire avec une clé désactivée.

Autorisé Non autorisé
Activer la clé
Mettre à jour des propriétés
Obtenir la valeur

Étapes suivantes