SecretClient class

  • Referência
Pacote:
@azure/keyvault-secrets

O SecretClient fornece métodos para gerenciar KeyVaultSecret no Key Vault do Azure. O cliente dá suporte à criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem de KeyVaultSecrets. O cliente também dá suporte à listagem de DeletedSecret para uma Key Vault do Azure habilitada para exclusão reversível.

Construtores

SecretClient(string, TokenCredential, SecretClientOptions)

Cria uma instância de SecretClient.

Exemplo de uso:

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);

Propriedades

vaultUrl

A URL base para o cofre

Métodos

backupSecret(string, BackupSecretOptions)

Solicita que um backup do segredo especificado seja baixado para o cliente. Todas as versões do segredo serão baixadas. Essa operação requer a permissão de segredos/backup.

Exemplo de uso:

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

Faz backup do segredo especificado.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Exclui um segredo armazenado no Key Vault do Azure. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o segredo seja excluído.

Essa operação requer a permissão de segredos/exclusão.

Exemplo de uso:

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);

Exclui um segredo de um cofre de chaves especificado.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Recupera o segredo excluído no cofre especificado. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o segredo seja recuperado.

Essa operação requer a permissão de segredos/recuperação.

Exemplo de uso:

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 o segredo excluído para a versão mais recente.
getDeletedSecret(string, GetDeletedSecretOptions)

O método getDeletedSecret retorna o segredo excluído especificado junto com seus atributos. Essa operação requer a permissão secrets/get.

Exemplo de uso:

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

Obtém o segredo excluído especificado.
getSecret(string, GetSecretOptions)

O método getSecret é aplicável a qualquer segredo armazenado no Azure Key Vault. Essa operação requer a permissão secrets/get.

Exemplo de uso:

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

Obtenha um segredo especificado de um determinado cofre de chaves.
listDeletedSecrets(ListDeletedSecretsOptions)

Itera os segredos excluídos no cofre. O identificador completo do segredo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.

Exemplo de uso:

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

Listar todos os segredos no cofre.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itera a versão mais recente de todos os segredos no cofre. O identificador completo do segredo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.

Exemplo de uso:

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

Listar todos os segredos no cofre.
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itera todas as versões do segredo especificado no cofre. O identificador completo do segredo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.

Exemplo de uso:

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)

A operação secreta de limpeza excluída remove o segredo permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de segredos/limpeza.

Exemplo de uso:

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

Exclui permanentemente o segredo especificado.
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaura um segredo de backup e todas as suas versões para um cofre. Essa operação requer a permissão de segredos/restauração.

Exemplo de uso:

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

Restaura um segredo de backup em um cofre.
setSecret(string, string, SetSecretOptions)

O método setSecret adiciona uma versão secreta ou secreta ao Key Vault do Azure. Se o segredo denominado já existir, o Cofre de Chaves do Azure cria uma nova versão do segredo. Essa operação requer a permissão secrets/set.

Exemplo de uso:

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

Adiciona um segredo em um cofre de chaves especificado.
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

O método updateSecret altera os atributos especificados de um segredo armazenado existente. As propriedades que não são especificadas na solicitação são deixadas inalteradas. O valor de um segredo em si não pode ser alterado. Essa operação requer a permissão secrets/set.

Exemplo de uso:

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

Atualizações os atributos associados a um segredo especificado em um determinado cofre de chaves.

Detalhes do construtor

SecretClient(string, TokenCredential, SecretClientOptions)

Cria uma instância de SecretClient.

Exemplo de uso:

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

A URL base para o cofre. Você deve validar se essa URL faz referência a um recurso de Key Vault válido. Para obter detalhes, consulte https://aka.ms/azsdk/blog/vault-uri.

credential
TokenCredential

Um objeto que implementa a TokenCredential interface usada para autenticar solicitações para o serviço. Use o @azure/identity pacote para criar uma credencial que atenda às suas necessidades.

pipelineOptions
SecretClientOptions

Opções de pipeline usadas para configurar Key Vault solicitações de API. Omita esse parâmetro para usar a configuração de pipeline padrão.

Detalhes da propriedade

vaultUrl

A URL base para o cofre

vaultUrl: string

Valor da propriedade

string

Detalhes do método

backupSecret(string, BackupSecretOptions)

Solicita que um backup do segredo especificado seja baixado para o cliente. Todas as versões do segredo serão baixadas. Essa operação requer a permissão de segredos/backup.

Exemplo de uso:

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

Faz backup do segredo especificado.

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

Parâmetros

secretName

string

O nome do segredo.

options
BackupSecretOptions

Os parâmetros opcionais.

Retornos

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Exclui um segredo armazenado no Key Vault do Azure. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o segredo seja excluído.

Essa operação requer a permissão de segredos/exclusão.

Exemplo de uso:

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);

Exclui um segredo de um cofre de chaves especificado.

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

Parâmetros

name

string

options
BeginDeleteSecretOptions

Os parâmetros opcionais.

Retornos

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Recupera o segredo excluído no cofre especificado. Essa função retorna um sondador de Operação de Execução Longa que permite que você aguarde indefinidamente até que o segredo seja recuperado.

Essa operação requer a permissão de segredos/recuperação.

Exemplo de uso:

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 o segredo excluído para a versão mais recente.

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

Parâmetros

name

string

options
BeginRecoverDeletedSecretOptions

Os parâmetros opcionais.

Retornos

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

getDeletedSecret(string, GetDeletedSecretOptions)

O método getDeletedSecret retorna o segredo excluído especificado junto com seus atributos. Essa operação requer a permissão secrets/get.

Exemplo de uso:

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

Obtém o segredo excluído especificado.

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

Parâmetros

secretName

string

O nome do segredo.

options
GetDeletedSecretOptions

Os parâmetros opcionais.

Retornos

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

O método getSecret é aplicável a qualquer segredo armazenado no Azure Key Vault. Essa operação requer a permissão secrets/get.

Exemplo de uso:

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

Obtenha um segredo especificado de um determinado cofre de chaves.

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

Parâmetros

secretName

string

O nome do segredo.

options
GetSecretOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Itera os segredos excluídos no cofre. O identificador completo do segredo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.

Exemplo de uso:

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

Listar todos os segredos no cofre.

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

Parâmetros

options
ListDeletedSecretsOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itera a versão mais recente de todos os segredos no cofre. O identificador completo do segredo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.

Exemplo de uso:

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

Listar todos os segredos no cofre.

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

Parâmetros

options
ListPropertiesOfSecretsOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itera todas as versões do segredo especificado no cofre. O identificador completo do segredo e os atributos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Essas operações exigem a permissão secrets/list.

Exemplo de uso:

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

Nome do segredo para o qual buscar versões.

options
ListPropertiesOfSecretVersionsOptions

Os parâmetros opcionais.

Retornos

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

A operação secreta de limpeza excluída remove o segredo permanentemente, sem a possibilidade de recuperação. Essa operação só pode ser habilitada em um cofre habilitado para exclusão reversível. Essa operação requer a permissão de segredos/limpeza.

Exemplo de uso:

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

Exclui permanentemente o segredo especificado.

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

Parâmetros

secretName

string

O nome do segredo.

options
PurgeDeletedSecretOptions

Os parâmetros opcionais.

Retornos

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaura um segredo de backup e todas as suas versões para um cofre. Essa operação requer a permissão de segredos/restauração.

Exemplo de uso:

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

Restaura um segredo de backup em um cofre.

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

Parâmetros

secretBundleBackup

Uint8Array

O blob de backup associado a um pacote secreto.

options
RestoreSecretBackupOptions

Os parâmetros opcionais.

Retornos

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

O método setSecret adiciona uma versão secreta ou secreta ao Key Vault do Azure. Se o segredo denominado já existir, o Cofre de Chaves do Azure cria uma nova versão do segredo. Essa operação requer a permissão secrets/set.

Exemplo de uso:

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

Adiciona um segredo em um cofre de chaves especificado.

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

Parâmetros

secretName

string

O nome do segredo.

value

string

O valor do segredo.

options
SetSecretOptions

Os parâmetros opcionais.

Retornos

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

O método updateSecret altera os atributos especificados de um segredo armazenado existente. As propriedades que não são especificadas na solicitação são deixadas inalteradas. O valor de um segredo em si não pode ser alterado. Essa operação requer a permissão secrets/set.

Exemplo de uso:

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

Atualizações os atributos associados a um segredo especificado em um determinado cofre de chaves.

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

Parâmetros

secretName

string

O nome do segredo.

secretVersion

string

A versão do segredo.

options
UpdateSecretPropertiesOptions

Os parâmetros opcionais.

Retornos

Promise<SecretProperties>