Compartir a través de

Enumeración de claves y versiones en Azure Key Vault con JavaScript

  • Artículo

Cree KeyClient con las credenciales de autenticación mediante programación adecuadas.

Enumerar todas las claves

Enumere la versión actual de todas las claves con listPropertiesOfKeys iterable.

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

El objeto KeyProperties devuelto incluye la versión de la clave.

Enumerar todas las claves por página

Para enumerar todas las claves en Azure Key Vault, use el método listPropertiesOfKeys para obtener las propiedades de un secreto de una página a la vez estableciendo el 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}`);
    }
}

El objeto KeyProperties devuelto incluye la versión de la clave.

Enumerar todas las versiones de una clave

Para enumerar todas las claves de un secreto en Azure Key Vault, use el 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}`);
}

El objeto KeyProperties devuelto incluye la versión de la clave.

Consulte el ejemplo Enumerar todas las claves por página para ver cómo pasar las páginas de los resultados.

Enumeración de claves eliminadas

Para enumerar todas las páginas eliminadas en Azure Key Vault, use el 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}`
    );
}

El objeto deletedKey es un objeto DeletedKey que incluye el objeto KeyProperties con propiedades adicionales, como:

  • deletedOn - Hora en que se eliminó la clave.
  • scheduledPurgeDate - Fecha en la que se programa la purga de la clave. Después de purgar una clave, no se puede recuperar. Si realizó una copia de seguridad de la clave, podrá restaurarla con el mismo nombre y todas sus versiones.

Consulte el ejemplo Enumerar todas las claves por página para ver cómo pasar las páginas de los resultados.

Pasos siguientes