Compartilhar via

Listar as chaves e versões no Azure Key Vault com JavaScript

  • Artigo

Crie o KeyClient com as credenciais de autenticação programáticas apropriadas.

Listar todas as chaves

Liste a versão atual de todas as chaves usando o método iterável 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);
}

O objeto KeyProperties retornado inclui a versão da chave.

Listar todas as chaves por página

Para listar todas as chaves no Azure Key Vault, use o método listPropertiesOfKeys para obter propriedades do segredo de uma página por vez definindo o objeto 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}`);
    }
}

O objeto KeyProperties retornado inclui a versão da chave.

Listar todas as versões de uma chave

Para listar todas as versões de uma chave no Azure Key Vault, use o método 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}`);
}

O objeto KeyProperties retornado inclui a versão da chave.

Consulte o exemplo Listar todas as chaves por página para saber como navegar pelos resultados.

Listar chaves excluídas

Para listar todas as chaves excluídas no Azure Key Vault, use o método 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}`
    );
}

O objeto deletedKey é um objeto DeletedKey que inclui o objeto KeyProperties com propriedades adicionais, como:

  • deletedOn - A hora em que a chave foi excluída.
  • scheduledPurgeDate - A data em que a chave está agendada para ser eliminada. Depois que uma chave é eliminada, ela não pode ser recuperada. Se você fez o backup da chave, poderá restaurá-la com o mesmo nome e todas as suas versões.

Consulte o exemplo Listar todas as chaves por página para saber como navegar pelos resultados.

Próximas etapas