@azure/keyvault-secrets package

Classes

SecretClient

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.

Interfaces

BackupSecretOptions	Opções para <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Uma interface que representa os parâmetros opcionais que podem ser passados para beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Uma interface que representa um segredo KeyVault excluído.
GetDeletedSecretOptions	Opções para getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Opções para getSecret(string, GetSecretOptions).
KeyVaultSecret	Uma interface que representa um segredo KeyVault, com seu nome, valor e SecretProperties.
KeyVaultSecretIdentifier	Representa os segmentos que compõem uma ID Secreta do Cofre de Chaves.
ListDeletedSecretsOptions	Opções para listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	Opções para listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	Opções para listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	Uma interface que rastreia as configurações para iteração paginada
PagedAsyncIterableIterator	Uma interface que permite iteração assíncrona iterável até a conclusão e por página.
PollOperationState	PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessárias para definir qualquer poller de operação de longa duração. Enquanto a classe Poller funciona como o mecanismo de controle local para iniciar o acionamento, aguardar e potencialmente cancelar uma operação de longa duração, o PollOperationState documenta o status da operação remota de longa duração. Ele deve ser atualizado 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.
PollerLike	Representação abstrata de um poller, destinada a expor apenas a API mínima com a qual o usuário precisa trabalhar.
PurgeDeletedSecretOptions	Opções para purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Opções para restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Os parâmetros opcionais aceitos pelo KeyClient do KeyVault
SecretPollerOptions	Uma interface que representa os parâmetros opcionais que podem ser passados para beginDeleteSecret(string, BeginDeleteSecretOptions) e <xref:beginRecoverDeletedKey>.
SecretProperties	Uma interface que representa as propriedades de um KeyVaultSecret.
SetSecretOptions	Opções para setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Opções para updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Aliases de Tipo

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o segredo, no final do intervalo de retenção. KnownDeletionRecoveryLevel pode ser usado de forma intercambiável com DeletionRecoveryLevel, esse enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Purgeable: Indica um estado vault no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível contra uma operação Delete; os dados são irremediavelmente perdidos ao aceitar uma operação de Exclusão no nível da entidade ou superior (cofre, grupo de recursos, assinatura, etc.) Recoverable+Purgeable: Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga). 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado recuperável : Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga). 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado Recoverable+ProtectedSubscription: indica um estado de cofre e 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado CustomizedRecoverable+Purgeable: Indica um estado do cofre no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purga 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 Purge seja solicitada ou a assinatura seja cancelada. CustomizedRecoverable: Indica 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. CustomizedRecoverable+ProtectedSubscription: Indica um estado de cofre e 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 assinatura em si não pode ser cancelada.

Enumerações

KnownDeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o segredo, no final do intervalo de retenção.

Funções

parseKeyVaultSecretIdentifier(string)

Analisa o ID Secreto do Cofre da Chave fornecido. Um exemplo é: https://.vault.azure.net/secrets// Ao analisar o 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>" }

Detalhes de Função

parseKeyVaultSecretIdentifier(string)

Analisa o ID Secreto do Cofre da Chave fornecido. Um exemplo é:

https://.vault.azure.net/secrets//

Ao analisar o 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>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Parâmetros

id

string

O id do segredo do cofre da chave.

Devoluções

KeyVaultSecretIdentifier