Partilhar via

SecretClient class

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

O SecretClient fornece métodos para gerir KeyVaultSecret no Key Vault do Azure. O cliente suporta a criação, obtenção, atualização, eliminação, remoção, cópia de segurança, restauro e listagem de KeyVaultSecrets. O cliente também suporta a listagem deletedSecret para um Key Vault do Azure com eliminação recuperável ativada.

Construtores

SecretClient(string, TokenCredential, SecretClientOptions)

Cria uma instância do SecretClient.

Utilização de exemplo: 

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)

Pede que seja transferida uma cópia de segurança do segredo especificado para o cliente. Todas as versões do segredo serão transferidas. Esta operação requer a permissão de segredos/cópia de segurança.

Utilização de exemplo: 

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

Cria uma cópia de segurança do segredo especificado.
beginDeleteSecret(string, BeginDeleteSecretOptions)

Elimina um segredo armazenado no Azure Key Vault. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o segredo seja eliminado.

Esta operação requer a permissão de segredos/eliminação.

Utilização de exemplo: 

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 um segredo de um cofre de chaves especificado.
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Recupera o segredo eliminado no cofre especificado. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o segredo seja recuperado.

Esta operação requer a permissão segredos/recuperação.

Utilização de exemplo: 

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

O método getDeletedSecret devolve o segredo eliminado especificado juntamente com os respetivos atributos. Esta operação requer os segredos/obter permissão.

Utilização de exemplo: 

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

Obtém o segredo eliminado especificado.
getSecret(string, GetSecretOptions)

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

Utilização de exemplo: 

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

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

Itera os segredos eliminados no cofre. Os atributos e o identificador de segredo completos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

Utilização de exemplo: 

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. Os atributos e o identificador de segredo completos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

Utilização de exemplo: 

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 especificado no cofre. Os atributos e o identificador de segredo completos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

Utilização de exemplo: 

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 de remoção de segredos eliminados remove permanentemente o segredo, sem a possibilidade de recuperação. Esta operação só pode ser ativada num cofre ativado para eliminação recuperável. Esta operação requer a permissão segredos/remoção.

Utilização de exemplo: 

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

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

Restaura um segredo de cópia de segurança e todas as respetivas versões para um cofre. Esta operação requer a permissão de segredos/restauro.

Utilização de exemplo: 

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

Restaura um segredo de cópia de segurança para 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 nomeado já existir, o Azure Key Vault cria uma nova versão desse segredo. Esta operação requer a permissão segredos/definir.

Utilização de exemplo: 

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

Adiciona um segredo num 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 no pedido permanecem inalteradas. O valor de um segredo em si não pode ser alterado. Esta operação requer a permissão segredos/definir.

Utilização de exemplo: 

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 num determinado cofre de chaves.

Detalhes do Construtor

SecretClient(string, TokenCredential, SecretClientOptions)

Cria uma instância do SecretClient.

Utilização de exemplo: 

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. Deve validar que este URL faz referência a um recurso Key Vault válido. Veja https://aka.ms/azsdk/blog/vault-uri para obter detalhes.

credential
TokenCredential

Um objeto que implementa a TokenCredential interface utilizada para autenticar pedidos no serviço. Utilize o @azure/identity pacote para criar uma credencial que se adeque às suas necessidades.

pipelineOptions
SecretClientOptions

Opções de pipeline utilizadas para configurar pedidos de API Key Vault. Omita este parâmetro para utilizar a configuração de pipeline predefinida.

Detalhes de Propriedade

vaultUrl

O URL base para o cofre

vaultUrl: string

Valor de Propriedade

string

Detalhes de Método

backupSecret(string, BackupSecretOptions)

Pede que seja transferida uma cópia de segurança do segredo especificado para o cliente. Todas as versões do segredo serão transferidas. Esta operação requer a permissão de segredos/cópia de segurança.

Utilização de exemplo: 

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

Cria uma cópia de segurança 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)

Elimina um segredo armazenado no Azure Key Vault. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o segredo seja eliminado.

Esta operação requer a permissão de segredos/eliminação.

Utilização de exemplo: 

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 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 eliminado no cofre especificado. Esta função devolve um poller de Operação de Execução Prolongada que lhe permite aguardar indefinidamente até que o segredo seja recuperado.

Esta operação requer a permissão segredos/recuperação.

Utilização de exemplo: 

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 eliminado 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 devolve o segredo eliminado especificado juntamente com os respetivos atributos. Esta operação requer os segredos/obter permissão.

Utilização de exemplo: 

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

Obtém o segredo eliminado 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 Azure Key Vault. Esta operação requer os segredos/obter permissão.

Utilização de exemplo: 

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

Obtenha um segredo especificado a partir 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 eliminados no cofre. Os atributos e o identificador de segredo completos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

Utilização de exemplo: 

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. Os atributos e o identificador de segredo completos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

Utilização de exemplo: 

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 especificado no cofre. Os atributos e o identificador de segredo completos são fornecidos na resposta. Não são devolvidos valores para os segredos. Estas operações requerem a permissão segredos/lista.

Utilização de exemplo: 

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 que pretende obter versões.

options
ListPropertiesOfSecretVersionsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>

purgeDeletedSecret(string, PurgeDeletedSecretOptions)

A operação de remoção de segredos eliminados remove permanentemente o segredo, sem a possibilidade de recuperação. Esta operação só pode ser ativada num cofre ativado para eliminação recuperável. Esta operação requer a permissão segredos/remoção.

Utilização de exemplo: 

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

Elimina 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 cópia de segurança e todas as respetivas versões para um cofre. Esta operação requer a permissão de segredos/restauro.

Utilização de exemplo: 

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

Restaura um segredo de cópia de segurança para um cofre.

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

Parâmetros

secretBundleBackup

Uint8Array

O blob de cópia de segurança 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 Key Vault do Azure. Se o segredo nomeado já existir, o Azure Key Vault cria uma nova versão desse segredo. Esta operação requer a permissão segredos/definir.

Utilização de exemplo: 

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

Adiciona um segredo num 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 os atributos especificados de um segredo armazenado existente. As propriedades que não são especificadas no pedido permanecem inalteradas. O valor de um segredo em si não pode ser alterado. Esta operação requer a permissão segredos/definir.

Utilização de exemplo: 

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 num 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>