Répertoriez les clés et les versions dans Azure Key Vault avec JavaScript

Créez le KeyClient avec les informations d’identification de l’authentification par programmation adéquates.

Répertorier toutes les clés

Répertoriez la version actuelle de toutes les clés avec la méthode itérable listPropertiesOfKeys.

import { KeyClient, CreateKeyOptions, KeyVaultKey } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

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

// Get latest version of (not soft-deleted) keys 
for await (const keyProperties of client.listPropertiesOfKeys()) {
    console.log(keyProperties.version);
}

L’objet KeyProperties retourné contient la version de la clé.

Répertorier toutes les clés par page

Pour lister toutes les clés dans Azure Key Vault, utilisez la méthode listPropertiesOfKeys pour obtenir les propriétés secrètes d’une page à la fois, en définissant l’objet PageSettings.

import { KeyClient } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

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

let page = 1;
const maxPageSize = 5;

// Get latest version of not-deleted keys 
for await (const keyProperties of client.listPropertiesOfKeys().byPage({maxPageSize})) {
    console.log(`Page ${page++} ---------------------`)
    
    for (const props of keyProperties) {
        console.log(`${props.name}`);
    }
}

L’objet KeyProperties retourné contient la version de la clé.

Lister toutes les versions d’une clé

Pour lister toutes les versions d’une clé dans Azure Key Vault, utilisez la méthode listPropertiesOfKeyVersions.

import { KeyClient } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

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

// Get all versions of key
for await (const versionProperties of client.listPropertiesOfKeyVersions(
    keyName
)) {
    console.log(`\tversion: ${versionProperties.version} created on ${versionProperties.createdOn}`);
}

L’objet KeyProperties retourné contient la version de la clé.

Consultez l’exemple Lister toutes les clés par page pour découvrir comment parcourir les résultats.

Lister les clés supprimées

Pour répertorier toutes les clés supprimées dans Azure Key Vault, utilisez la méthode listDeletedKeys.

import { KeyClient } from '@azure/keyvault-keys';
import { DefaultAzureCredential } from '@azure/identity';

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

for await (const deletedKey of client.listDeletedKeys()) {
    console.log(
        `Deleted: ${deletedKey.name} deleted on ${deletedKey.properties.deletedOn}, to be purged on ${deletedKey.properties.scheduledPurgeDate}`
    );
}

L’objet deletedKey est un objet DeletedKey qui contient l’objet KeyProperties avec des propriétés supplémentaires telles que :

  • deletedOn - Heure à laquelle la clé a été supprimée.
  • scheduledPurgeDate - Date de planification de la suppression définitive de la clé. Une fois une clé supprimée définitivement, elle ne peut pas être récupérée. Si vous avez sauvegardé la clé, vous pouvez la restaurer avec le même nom et toutes ses versions.

Consultez l’exemple Lister toutes les clés par page pour découvrir comment parcourir les résultats.

Étapes suivantes