Compartir a través de

SecretClient class

  • Referencia
Paquete:
@azure/keyvault-secrets

SecretClient proporciona métodos para administrar keyVaultSecret en Azure Key Vault. El cliente admite la creación, recuperación, actualización, eliminación, purgado, copia de seguridad, restauración y enumeración de KeyVaultSecrets. El cliente también admite la enumeración de DeletedSecret para una instancia de Azure Key Vault habilitada para eliminación temporal.

Constructores

SecretClient(string, TokenCredential, SecretClientOptions)

Crea una instancia de SecretClient.

Uso de ejemplo:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

Propiedades

vaultUrl

Dirección URL base del almacén

Métodos

backupSecret(string, BackupSecretOptions)

Solicita que se descargue una copia de seguridad del secreto especificado en el cliente. Se descargarán todas las versiones del secreto. Esta operación requiere el permiso secretos o copia de seguridad.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Realiza una copia de seguridad del secreto especificado.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Elimina un secreto almacenado en Azure Key Vault. Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se elimine el secreto.

Esta operación requiere el permiso secrets/delete.

Uso de ejemplo:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Elimina un secreto de un almacén de claves especificado.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Recupera el secreto eliminado en el almacén especificado. Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se recupere el secreto.

Esta operación requiere el permiso secrets/recover.

Uso de ejemplo:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Recupera el secreto eliminado a la versión más reciente.
getDeletedSecret(string, GetDeletedSecretOptions)

El método getDeletedSecret devuelve el secreto eliminado especificado junto con sus atributos. Esta operación requiere el permiso secrets/get.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Obtiene el secreto eliminado especificado.
getSecret(string, GetSecretOptions)

El método getSecret se aplica a cualquier secreto almacenado en Azure Key Vault. Esta operación requiere el permiso secrets/get.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Obtenga un secreto especificado de un almacén de claves determinado.
listDeletedSecrets(ListDeletedSecretsOptions)

Itera los secretos eliminados en el almacén. El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Enumere todos los secretos del almacén.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itera la versión más reciente de todos los secretos del almacén. El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Enumere todos los secretos del almacén.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itera todas las versiones del secreto especificado en el almacén. El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}
purgeDeletedSecret(string, PurgeDeletedSecretOptions)

La operación de purga del secreto eliminado quita el secreto de forma permanente, sin la posibilidad de recuperación. Esta operación solo se puede habilitar en un almacén habilitado para eliminación temporal. Esta operación requiere el permiso secrets/purge.

Uso de ejemplo:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Elimina permanentemente el secreto especificado.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaura un secreto de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso secretos o restauración.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Restaura un secreto de copia de seguridad en un almacén.
setSecret(string, string, SetSecretOptions)

El método setSecret agrega un secreto o una versión secreta a Azure Key Vault. Si el secreto con nombre ya existe, Azure Key Vault crea una nueva versión de ese secreto. Esta operación requiere el permiso secrets/set.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Agrega un secreto en un almacén de claves especificado.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

El método updateSecret cambia los atributos especificados de un secreto almacenado existente. Las propiedades que no se especifican en la solicitud se dejan sin cambios. No se puede cambiar el valor de un secreto. Esta operación requiere el permiso secrets/set.

Uso de ejemplo:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Actualiza los atributos asociados a un secreto especificado en un almacén de claves determinado.

Detalles del constructor

SecretClient(string, TokenCredential, SecretClientOptions)

Crea una instancia de SecretClient.

Uso de ejemplo:

import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let client = new SecretClient(vaultUrl, credentials);

new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)

Parámetros

vaultUrl

string

Dirección URL base del almacén. Debe validar que esta dirección URL hace referencia a un recurso de Key Vault válido. Consulte https://aka.ms/azsdk/blog/vault-uri para obtener más información.

credential
TokenCredential

Objeto que implementa la interfaz TokenCredential utilizada para autenticar las solicitudes al servicio. Use el paquete @azure/identity para crear una credencial que se adapte a sus necesidades.

pipelineOptions
SecretClientOptions

Opciones de canalización que se usan para configurar solicitudes de API de Key Vault. Omita este parámetro para usar la configuración de canalización predeterminada.

Detalles de las propiedades

vaultUrl

Dirección URL base del almacén

vaultUrl: string

Valor de propiedad

string

Detalles del método

backupSecret(string, BackupSecretOptions)

Solicita que se descargue una copia de seguridad del secreto especificado en el cliente. Se descargarán todas las versiones del secreto. Esta operación requiere el permiso secretos o copia de seguridad.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");

Realiza una copia de seguridad del secreto especificado.

function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>

Parámetros

secretName

string

Nombre del secreto.

options
BackupSecretOptions

Parámetros opcionales.

Devoluciones

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Elimina un secreto almacenado en Azure Key Vault. Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se elimine el secreto.

Esta operación requiere el permiso secrets/delete.

Uso de ejemplo:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");

// Serializing the poller
const serialized = deletePoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);

Elimina un secreto de un almacén de claves especificado.

function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

Parámetros

name

string

options
BeginDeleteSecretOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Recupera el secreto eliminado en el almacén especificado. Esta función devuelve un sondeo de operación de ejecución prolongada que permite esperar indefinidamente hasta que se recupere el secreto.

Esta operación requiere el permiso secrets/recover.

Uso de ejemplo:

const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();

const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");

// Serializing the poller
const serialized = recoverPoller.toString();

// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });

// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);

Recupera el secreto eliminado a la versión más reciente.

function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

Parámetros

name

string

options
BeginRecoverDeletedSecretOptions

Parámetros opcionales.

Devoluciones

Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>

getDeletedSecret(string, GetDeletedSecretOptions)

El método getDeletedSecret devuelve el secreto eliminado especificado junto con sus atributos. Esta operación requiere el permiso secrets/get.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");

Obtiene el secreto eliminado especificado.

function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>

Parámetros

secretName

string

Nombre del secreto.

options
GetDeletedSecretOptions

Parámetros opcionales.

Devoluciones

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

El método getSecret se aplica a cualquier secreto almacenado en Azure Key Vault. Esta operación requiere el permiso secrets/get.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");

Obtenga un secreto especificado de un almacén de claves determinado.

function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>

Parámetros

secretName

string

Nombre del secreto.

options
GetSecretOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Itera los secretos eliminados en el almacén. El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
  console.log("deleted secret: ", deletedSecret);
}

Enumere todos los secretos del almacén.

function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

Parámetros

options
ListDeletedSecretsOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itera la versión más reciente de todos los secretos del almacén. El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret: ", secret);
}

Enumere todos los secretos del almacén.

function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Parámetros

options
ListPropertiesOfSecretsOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itera todas las versiones del secreto especificado en el almacén. El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
  const secret = await client.getSecret(secretProperties.name);
  console.log("secret version: ", secret);
}

function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

Parámetros

secretName

string

Nombre del secreto para el que se van a capturar versiones.

options
ListPropertiesOfSecretVersionsOptions

Parámetros opcionales.

Devoluciones

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

La operación de purga del secreto eliminado quita el secreto de forma permanente, sin la posibilidad de recuperación. Esta operación solo se puede habilitar en un almacén habilitado para eliminación temporal. Esta operación requiere el permiso secrets/purge.

Uso de ejemplo:

const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");

Elimina permanentemente el secreto especificado.

function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>

Parámetros

secretName

string

Nombre del secreto.

options
PurgeDeletedSecretOptions

Parámetros opcionales.

Devoluciones

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaura un secreto de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso secretos o restauración.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);

Restaura un secreto de copia de seguridad en un almacén.

function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>

Parámetros

secretBundleBackup

Uint8Array

Blob de copia de seguridad asociado a un conjunto de secretos.

options
RestoreSecretBackupOptions

Parámetros opcionales.

Devoluciones

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

El método setSecret agrega un secreto o una versión secreta a Azure Key Vault. Si el secreto con nombre ya existe, Azure Key Vault crea una nueva versión de ese secreto. Esta operación requiere el permiso secrets/set.

Uso de ejemplo:

let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");

Agrega un secreto en un almacén de claves especificado.

function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>

Parámetros

secretName

string

Nombre del secreto.

value

string

Valor del secreto.

options
SetSecretOptions

Parámetros opcionales.

Devoluciones

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

El método updateSecret cambia los atributos especificados de un secreto almacenado existente. Las propiedades que no se especifican en la solicitud se dejan sin cambios. No se puede cambiar el valor de un secreto. Esta operación requiere el permiso secrets/set.

Uso de ejemplo:

let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });

Actualiza los atributos asociados a un secreto especificado en un almacén de claves determinado.

function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>

Parámetros

secretName

string

Nombre del secreto.

secretVersion

string

Versión del secreto.

options
UpdateSecretPropertiesOptions

Parámetros opcionales.

Devoluciones

Promise<SecretProperties>