Compartir a través de

Obtener una clave en Azure Key Vault con JavaScript

  • Artículo

Cree KeyClient con las credenciales de autenticación de programación adecuadas y, después, use la clave para establecer, actualizar y alternar una clave de Azure Key Vault.

Obtener clave

Puede obtener la versión más reciente de una clave o una versión específica de una clave con el método getKey. La versión está dentro de las propiedades del objeto KeyVaultKey.

  • Obtener la última versión: await client.getKey(name);
  • Obtener versión específica: await client.getKey(name, { version });
// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
    KeyClient,
} from '@azure/keyvault-keys';

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

const name = `myRsaKey`;

// Get latest key
const latestKey = await client.getKey(name);
console.log(`${latestKey.name} version is ${latestKey.properties.version}`);

// Get previous key by version id
const keyPreviousVersionId = '2f2ec6d43db64d66ad8ffa12489acc8b';
const keyByVersion = await client.getKey(name, {
    version: keyPreviousVersionId
});
console.log(`Previous key version is ${keyByVersion.properties.version}`);

Obtener todas las versiones de un clave

Para obtener todas las versiones de una clave en Azure Key Vault, use el método listPropertiesOfKeyVersions de la clase KeyClient para obtener una lista iterable de las propiedades de la versión de la clave. Esto devuelve un objeto KeyProperties, que no incluye el valor de la versión. Si desea el valor de la versión, use la versión devuelta en la propiedad para obtener el valor de la clave con el método getKey.

Método Valor devuelto Devuelve propiedades
getKey Sí Sí
listPropertiesOfKeyVersions No Sí 
// Azure client libraries
import { DefaultAzureCredential } from '@azure/identity';
import {
    KeyClient,
} from '@azure/keyvault-keys';

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

const name = `myRsaKey`;

for await (const keyProperties of client.listPropertiesOfKeyVersions(name)) {
    const thisVersion = keyProperties.version;
    
    const { key } = await client.getKey(name, {
        version: thisVersion
    });

    // do something with version's key value
}

Obtener clave deshabilitada

Use la tabla siguiente para comprender lo que puede hacer con una clave deshabilitada.

Permitida No permitida
Habilitación de la clave
Actualización de propiedades		 Obtener un valor

Pasos siguientes