Partilhar via

SecretClient class

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

O SecretClient fornece métodos para gerenciar KeyVaultSecret no Cofre da Chave do Azure. O cliente suporta a criação, recuperação, atualização, exclusão, limpeza, backup, restauração e listagem KeyVaultSecrets. O cliente também dá suporte à listagem DeletedSecret para um Cofre de Chaves do Azure habilitado para exclusão suave.

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

O 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. Esta operação requer a permissão secrets/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 Cofre de Chaves do Azure. Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o segredo seja excluído.

Esta operação requer a permissão secrets/delete.

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. Esta função devolve um poller de Operação de Longa Duração que lhe permite esperar indefinidamente até que o segredo seja recuperado.

Esta operação requer a permissão secrets/recover.

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. Esta operação requer os segredos/obter permissão.

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 Cofre de Chaves do Azure. Esta operação requer os segredos/obter permissão.

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 e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer 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);
}

Liste todos os segredos no cofre.
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itera a versão mais recente de todos os segredos no cofre. O identificador e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer 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);
}

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

Itera todas as versões do segredo fornecido no cofre. O identificador e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer 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 purga eliminada remove o segredo permanentemente, sem a possibilidade de recuperação. Esta operação só pode ser ativada em um cofre habilitado para exclusão suave. Esta operação requer a permissão secrets/purge.

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 em um cofre. Esta operação requer a permissão secrets/restaurar.

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 Cofre da Chave do Azure. Se o segredo nomeado já existir, o Azure Key Vault criará uma nova versão desse segredo. Esta 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 atributos especificados de um segredo armazenado existente. As propriedades que não são especificadas na solicitação são mantidas inalteradas. O valor de um segredo em si não pode ser alterado. Esta 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 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

O URL base para o cofre. Você deve validar se essa URL faz referência a um recurso válido do Cofre da Chave. Consulte https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential
TokenCredential

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

pipelineOptions
SecretClientOptions

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

Detalhes de Propriedade

vaultUrl

O URL base para o cofre

vaultUrl: string

Valor de Propriedade

string

Detalhes de 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. Esta operação requer a permissão secrets/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.

Devoluções

Promise<undefined | Uint8Array>

beginDeleteSecret(string, BeginDeleteSecretOptions)

Exclui um segredo armazenado no Cofre de Chaves do Azure. Esta função retorna um poller de Operação de Longa Execução que permite que você aguarde indefinidamente até que o segredo seja excluído.

Esta operação requer a permissão secrets/delete.

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.

Devoluções

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

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Recupera o segredo excluído no cofre especificado. Esta função devolve um poller de Operação de Longa Duração que lhe permite esperar indefinidamente até que o segredo seja recuperado.

Esta operação requer a permissão secrets/recover.

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.

Devoluções

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

getDeletedSecret(string, GetDeletedSecretOptions)

O método getDeletedSecret retorna o segredo excluído especificado junto com seus atributos. Esta operação requer os segredos/obter permissão.

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.

Devoluções

Promise<DeletedSecret>

getSecret(string, GetSecretOptions)

O método getSecret é aplicável a qualquer segredo armazenado no Cofre de Chaves do Azure. Esta operação requer os segredos/obter permissão.

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.

Devoluções

Promise<KeyVaultSecret>

listDeletedSecrets(ListDeletedSecretsOptions)

Itera os segredos excluídos no cofre. O identificador e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer 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);
}

Liste todos os segredos no cofre.

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

Parâmetros

options
ListDeletedSecretsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)

Itera a versão mais recente de todos os segredos no cofre. O identificador e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer 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);
}

Liste todos os segredos no cofre.

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

Parâmetros

options
ListPropertiesOfSecretsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)

Itera todas as versões do segredo fornecido no cofre. O identificador e os atributos secretos completos são fornecidos na resposta. Nenhum valor é retornado para os segredos. Esta operação requer 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 buscar versões.

options
ListPropertiesOfSecretVersionsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

A operação secreta de purga eliminada remove o segredo permanentemente, sem a possibilidade de recuperação. Esta operação só pode ser ativada em um cofre habilitado para exclusão suave. Esta operação requer a permissão secrets/purge.

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.

Devoluções

Promise<void>

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)

Restaura um segredo de backup e todas as suas versões em um cofre. Esta operação requer a permissão secrets/restaurar.

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.

Devoluções

Promise<SecretProperties>

setSecret(string, string, SetSecretOptions)

O método setSecret adiciona uma versão secreta ou secreta ao Cofre da Chave do Azure. Se o segredo nomeado já existir, o Azure Key Vault criará uma nova versão desse segredo. Esta 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.

Devoluções

Promise<KeyVaultSecret>

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)

O método updateSecret altera atributos especificados de um segredo armazenado existente. As propriedades que não são especificadas na solicitação são mantidas inalteradas. O valor de um segredo em si não pode ser alterado. Esta 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 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.

Devoluções

Promise<SecretProperties>