@azure/keyvault-secrets package

O SecretClient fornece métodos para gerenciar KeyVaultSecret no Azure Key Vault. 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 DeletedSecret para um Azure Key Vault habilitado para exclusão reversível.

Opções para <xref:backupSecretOptions>.

Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteSecret(string, BeginDeleteSecretOptions)

Uma interface que representa os parâmetros opcionais que podem ser passados para beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Uma interface que representa um Segredo KeyVault excluído.

Opções para getDeletedSecret(string, GetDeletedSecretOptions).

Opções para getSecret(string, GetSecretOptions).

Uma interface que representa um Segredo KeyVault, com seu nome, valor e SecretProperties.

Representa os segmentos que compõem uma ID de Segredo do Key Vault.

Opções para listDeletedSecrets(ListDeletedSecretsOptions).

Opções para listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Opções para listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

Uma interface que rastreia as configurações da iteração paginada

Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página.

PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessário para definir qualquer poller de operação de execução prolongada.

Enquanto a classe Poller funciona como o mecanismo de controle local para começar a disparar, aguardar e potencialmente cancelar uma operação de execução longa, o PollOperationState documenta o status da operação remota de longa execução.

Ela deve ser atualizada pelo menos quando a operação for iniciada, quando for concluída e quando for cancelada. No entanto, as implementações podem ter qualquer outro número de propriedades que podem ser atualizadas por outros motivos.

Representação abstrata de um sondador, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.

Opções para purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Opções para restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Os parâmetros opcionais aceitos pelo KeyClient do KeyVault

Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteSecret(string, BeginDeleteSecretOptions) e <xref:beginRecoverDeletedKey>.

Uma interface que representa as propriedades de um KeyVaultSecret.

Opções para setSecret(string, string, SetSecretOptions).

Opções para updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver "Purgável", o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o segredo no final do intervalo de retenção.
KnownDeletionRecoveryLevel pode ser usado de forma intercambiável com DeletionRecoveryLevel, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

purgável: denota um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Esse nível corresponde a nenhuma proteção disponível em uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação Delete no nível de entidade ou superior (cofre, grupo de recursos, assinatura etc.)
Recuperável+Purgável: denota um estado do cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias), a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
recuperável: denota um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção (90 dias) e enquanto a assinatura ainda estiver disponível. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription: denota um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente. O sistema o excluirá permanentemente após 90 dias, se não for recuperado
CustomedRecoverable+Purgeable: denota um estado de cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, limpeza quando 7 <= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção, a menos que uma operação de limpeza seja solicitada ou a assinatura seja cancelada.
CustomizedRecoverable: denota um estado de cofre no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, limpeza quando 7 <= SoftDeleteRetentionInDays < 90). Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e enquanto a assinatura ainda estiver disponível.
CustomedRecoverable+ProtectedSubscription: denota um cofre e um estado de assinatura no qual a exclusão é recuperável, a exclusão imediata e permanente (ou seja, limpeza) não é permitida e na qual a assinatura em si não pode ser cancelada permanentemente quando 7 <= SoftDeleteRetentionInDays < 90. Esse nível garante a capacidade de recuperação da entidade excluída durante o intervalo de retenção e também reflete o fato de que a própria assinatura não pode ser cancelada.

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver "Purgável", o segredo poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema poderá limpar o segredo no final do intervalo de retenção.

Analisa a ID do Segredo do Key Vault fornecida. Um exemplo é:

https://< nome-do-cofre-chave.vault.azure.net/secrets/>< nome-secreto>/<id-da-versão-exclusiva>

Ao analisar a ID acima, essa função retorna:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }