Lista nycklar och versioner i Azure Key Vault med JavaScript

Skapa KeyClient med lämpliga autentiseringsuppgifter för programmering.

Visa en lista över alla nycklar

Visa en lista över den aktuella versionen av alla nycklar med den iterbara listanPropertiesOfKeys.

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);
}

Det returnerade KeyProperties-objektet innehåller nyckelversionen.

Visa en lista över alla nycklar efter sida

Om du vill visa en lista över alla nycklar i Azure Key Vault använder du metoden listPropertiesOfKeys för att hämta hemliga egenskaper en sida i taget genom att ange PageSettings-objektet.

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}`);
    }
}

Det returnerade KeyProperties-objektet innehåller nyckelversionen.

Visa en lista över alla versioner av en nyckel

Om du vill visa en lista över alla versioner av en nyckel i Azure Key Vault använder du metoden 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}`);
}

Det returnerade KeyProperties-objektet innehåller nyckelversionen.

Se exemplet Lista alla nycklar efter sida för att se hur du bläddrar igenom resultaten.

Lista borttagna nycklar

Om du vill visa en lista över alla borttagna nycklar i Azure Key Vault använder du metoden 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}`
    );
}

Objektet deletedKey är ett DeletedKey-objekt som innehåller KeyProperties-objektet med ytterligare egenskaper som:

  • deletedOn – Tiden då nyckeln togs bort.
  • scheduledPurgeDate – Det datum då nyckeln är schemalagd att tas bort. När en nyckel har rensats kan den inte återställas. Om du säkerhetskopierade nyckeln kan du återställa den med samma namn och alla dess versioner.

Se exemplet Lista alla nycklar efter sida för att se hur du bläddrar igenom resultaten.

Nästa steg