Compartilhar via

Obtenha uma chave no Azure Key Vault por meio do JavaScript

  • Artigo

Crie a KeyClient com as credenciais de autenticação programática apropriadas e use o cliente para definir, atualizar e rotacionar uma chave existente do Azure Key Vault.

Obter chave

Você pode obter a versão mais recente de uma chave ou uma versão específica de uma chave com o método getKey . A versão está dentro das propriedades do objeto KeyVaultKey .

  • Obter a versão mais recente: await client.getKey(name);
  • Obter a versão 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}`);

Obter todas as versões de uma chave

Para obter todas as versões de uma chave no Azure Key Vault, use o método listPropertiesOfKeyVersions da Classe KeyClient para obter uma lista iterável das propriedades da versão da chave. Isso retorna um objeto KeyProperties, que não inclui o valor da versão. Se você quiser o valor da versão, use a versão retornada na propriedade para obter o valor da chave com o método getKey.

Método Retorna um valor Retorna propriedades
getKey Sim Sim
listPropertiesOfKeyVersions Não Sim 
// 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
}

Obter chave desabilitada

Use a tabela a seguir para entender o que você pode fazer com uma chave desabilitada.

Permitido Não permitido
Habilitar chave
Atualizar as propriedades		 Obter valor

Próximas etapas