Obtenha um segredo do Azure Key Vault com JavaScript

Artigo
08/07/2024

Crie o SecretClient com as credenciais de autenticação programática apropriadas e use o cliente para obter um segredo do Cofre de Chaves do Azure.

Obter a versão atual do segredo

Para obter um segredo no Cofre da Chave do Azure, use o método getSecret da classe SecretClient .

const name = 'mySecret';

const { name, properties, value } = await client.getSecret(secretName);

Esse método retorna o objeto KeyVaultSecret .

Obtenha qualquer versão do segredo

Para obter uma versão específica de um segredo no Cofre da Chave do Azure, use o objeto GetSecretOptions ao chamar o método getSecret da classe SecretClient. Esse método retorna o objeto KeyVaultSecret .

const name = 'mySecret';
const options = {
    version: 'd9f2f96f120d4537ba7d82fecd913043'
};
 
const { name, properties, value } = await client.getSecret(secretName, options);

Esse método retorna o objeto KeyVaultSecret .

Obter todas as versões de um segredo

Para obter todas as versões de um segredo no Cofre da Chave do Azure, use o método listPropertiesOfSecretVersions da classe SecretClient para obter uma lista iterável das propriedades da versão do segredo. Isso retorna um objeto SecretProperties , 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 do segredo com o método getSecret .

Método	Devolve valor	Retorna propriedades
getSecret	Sim	Sim
listPropertiesOfSecretVersions	Não	Sim

const versions = [];

for await (const secretProperties of client.listPropertiesOfSecretVersions(
secretName
)) {
    const { value } = await client.getSecret(secretName, {
        version: secretProperties?.version,
    });

    versions.push({
        name: secretName,
        version: secretProperties?.version,
        value: value,
        createdOn: secretProperties?.createdOn,
    });
}

Obter segredo desativado

Use a tabela a seguir para entender o que você pode fazer com um segredo desativado.

Permitido	Não permitido
Ativar segredo Atualizar propriedades	Obtenha valor

Próximos passos

Ativar e desativar segredo

Partilhar via