Condividi tramite

Elencare chiavi e versioni in Azure Key Vault con JavaScript

  • Articolo

Elencare KeyClient con le credenziali di autenticazione programmatica appropriate.

Elencare tutte le chiavi

Elencare la versione corrente di tutte le chiavi con il metodo listPropertiesOfKeys iterabile.

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'oggetto restituito KeyProperties include la versione chiave.

Elencare tutte le chiavi per pagina

Per elencare tutte le chiavi in Azure Key Vault, usare il metodo listPropertiesOfKeys per ottenere le proprietà del segreto una pagina alla volta impostando l'oggetto 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'oggetto restituito KeyProperties include la versione chiave.

Elencare tutte le versioni di una chiave

Per elencare tutte le versioni di una chiave in Azure Key Vault, usare il metodo 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'oggetto restituito KeyProperties include la versione chiave.

Fare riferimento all'esempio Elencare tutte le chiavi per pagina per vedere come restituire una pagina di dati tramite i risultati.

Elencare le chiavi eliminate

Per elencare tutte le chiavi eliminata in Azure Key Vault, usare il metodo 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'oggetto deletedKey è un oggetto DeletedKey che include l'oggetto KeyProperties con proprietà aggiuntive, come:

  • deletedOn: l'ora in cui la chiave è stata eliminata.
  • scheduledPurgeDate: la data in cui è stata pianificata la rimozione definitiva della chiave. In seguito alla rimozione definitiva di una chiave, non potrà essere recuperata. Se è stato effettuato il backup di una chiave, sarà possibile ripristinarla con lo stesso nome e tutte le relative versioni.

Fare riferimento all'esempio Elencare tutte le chiavi per pagina per vedere come restituire una pagina di dati tramite i risultati.

Passaggi successivi