Introducción a los secretos de Azure Key Vault en JavaScript

En este artículo se muestra cómo conectarse a Azure Key Vault mediante la biblioteca cliente de secretos de Azure Key Vault para JavaScript. Una vez conectado, el código puede funcionar con secretos y propiedades de secretos en el almacén.

Referencia de la API | Paquete (npm) | Código fuente de la biblioteca | Ejemplos | Dar feedback

Prerrequisitos

• Una suscripción Azure: crear una gratuita.
• Azure Key Vault instancia. Asegúrese de que la identidad que ejecuta el código tiene el rol Azure RBAC adecuado para las tareas específicas realizadas en el código.
• Node.js versión LTS

Configurar su proyecto

1. Abra una línea de comandos y cambie a la carpeta de su proyecto. Cambie <project-directory> al nombre de la carpeta:

   cd <project-directory>
   

2. Si aún no tiene un archivo package.json en el directorio, inicialice el proyecto para crearlo:

   npm init -y
   

3. Instale la biblioteca cliente de secretos de Azure Key Vault para JavaScript:

   npm install @azure/keyvault-secrets
   

4. Si quiere usar conexiones sin contraseña mediante Microsoft Entra ID, instale la biblioteca cliente de Azure Identity para JavaScript:

   npm install @azure/identity
   

Autorización del acceso y conexión a Key Vault

Microsoft Entra ID proporciona la conexión más segura mediante la administración de la identidad de conexión ( identidad administrada). Esta funcionalidad sin contraseña le permite desarrollar una aplicación que no requiera secretos (claves o cadenas de conexión) almacenados en el código.

Antes de autenticarse mediante programación en Azure para usar secretos de Azure Key Vault, asegúrese de configurar el entorno.

az login

Connect-AzAccount

Compilación de la aplicación

A medida que compila la aplicación, el código interactúa con dos tipos de recursos:

• KeyVaultSecret, que incluye:
  • Nombre del secreto, un valor de tipo string.
  • Valor del secreto, que es una cadena del secreto. Proporcione la serialización y deserialización del valor del secreto en una cadena y fuera de ella según sea necesario.
  • Propiedades secretas.
• SecretProperties, que incluyen los metadatos del secreto, como su nombre, versión, etiquetas, datos de expiración y si está habilitado.

Si necesita el valor de KeyVaultSecret, use métodos que devuelvan KeyVaultSecret:

• getSecret
• setSecret

El resto de los métodos devuelven el objeto SecretProperties u otra forma de las propiedades como:

• Propiedades de DeletedSecret

Creación de un objeto SecretClient

El objeto SecretClient es el objeto superior del SDK. Este cliente permite manipular los secretos.

Una vez configurados los roles de acceso Azure Key Vault y el entorno local, cree un archivo JavaScript, que incluye el paquete @azure/identity. Cree una credencial, como DefaultAzureCredential, para implementar conexiones sin contraseña a su bóveda. Use esa credencial para autenticarse con un 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");

Consulte también

• Paquete (npm)
• Muestras
• Referencia de las API
• código fuente de Library
• Dar comentarios

Pasos siguientes

• Agregar un secreto