Comece com Azure Key Vault secrets em JavaScript

Este artigo mostra-lhe como se ligar ao Azure Key Vault utilizando a biblioteca cliente Azure Key Vault Secrets para JavaScript. Uma vez conectado, seu código pode operar em segredos e propriedades secretas no cofre.

API reference | Package (npm) | Código-fonte da biblioteca | Samples | Dá feedback

Pré-requisitos

• Uma subscrição da Azure - crie uma gratuitamente.
• Azure Key Vault instância. Certifique-se de que a identidade que executa o seu código tem o papel Azure RBAC adequado para as tarefas específicas realizadas em código.
• Node.js versão LTS

Configure o seu projeto

1. Abra um prompt de comando e mude para a pasta do projeto. Altere <project-directory> para o nome da pasta:

   cd <project-directory>
   

2. Se você ainda não tiver um package.json arquivo no diretório, inicialize o projeto para criar o arquivo:

   npm init -y
   

3. Instale a biblioteca cliente Azure Key Vault Secrets para JavaScript:

   npm install @azure/keyvault-secrets
   

4. Se quiser usar ligações sem palavra-passe usando o Microsoft Entra ID, instale a biblioteca cliente Azure Identity para JavaScript:

   npm install @azure/identity
   

Autorizar o acesso e ligar-se ao Key Vault

Microsoft Entra ID proporciona a ligação mais segura ao gerir a identidade da ligação (identidade gerida). Esta funcionalidade sem palavra-passe permite-lhe desenvolver uma aplicação que não requer quaisquer segredos (chaves ou cadeias de ligação) armazenados no código.

Antes de autenticar programaticamente no Azure para usar os segredos do Azure Key Vault, certifique-se de configurar o seu ambiente.

az login

Connect-AzAccount

Compilar a aplicação

À medida que você cria seu aplicativo, seu código interage com dois tipos de recursos:

• KeyVaultSecret, que inclui:
  • Nome secreto, um valor de cadeia de caracteres.
  • Valor secreto, que é uma cadeia de caracteres do segredo. Você fornece a serialização e a desserialização do valor secreto para dentro e para fora de uma cadeia de caracteres, conforme necessário.
  • Propriedades secretas.
• SecretProperties, que incluem os metadados do segredo, como nome, versão, tags, dados de expiração e se ele está habilitado.

Se você precisar do valor de KeyVaultSecret, use métodos que retornem o KeyVaultSecret:

• getSecret
• setSecret

O restante dos métodos retorna o objeto SecretProperties ou outra forma das propriedades, como:

• Propriedades de DeletedSecret

Criar um objeto SecretClient

O objeto SecretClient é o objeto superior no SDK. Este cliente permite-lhe manipular os segredos.

Depois de configurados os seus papéis de acesso Azure Key Vault e o ambiente local, crie um ficheiro JavaScript, que inclua o pacote @azure/identity. Crie uma credencial, como DefaultAzureCredential, para implementar conexões sem palavra-passe ao seu repositório. Use essa credencial para autenticar com um objeto SecretClient .

// Include required dependencies
import { DefaultAzureCredential } from '@azure/identity';  
import { SecretClient } from '@azure/keyvault-secrets';  

// Authenticate to Azure
const credential = new DefaultAzureCredential(); 

// Create SecretClient
const vaultName = '<vault-name>';  
const url = `https://${vaultName}.vault.azure.net`;  
const client = new SecretClient(url, credential);  

// Get secret
const secret = await client.getSecret("MySecretName");

Ver também

• Pacote (npm)
• Amostras
• Referência da API
• Dá Feedback

Próximos passos

• Adicionar um segredo