@azure/keyvault-secrets package

Classes

SecretClient

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.

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 do 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 do Segredo Key Vault.
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 de iteração paginada
PagedAsyncIterableIterator	Uma interface que permite iteração iterável assíncrona para conclusão e por página.
PollOperationState	PollOperationState contém uma lista opinativa do menor conjunto de propriedades necessário para definir qualquer sondador 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 de execução longa remota. 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 possam ser atualizadas por outros motivos.
PollerLike	Representação abstrata de um sondador, 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

Define valores para DeletionRecoveryLevel. KnownDeletionRecoveryLevel pode ser usado 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: indica 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 da entidade ou superior (cofre, grupo de recursos, assinatura etc.) Recuperável+Purgável: indica 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). 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: indica 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: indica um cofre e um estado de assinatura no qual a exclusão é recuperável dentro do intervalo de retenção (90 dias), 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 CustomizedRecoverable+Purgeable: indica um estado de cofre no qual a exclusão é recuperável e que também permite 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: 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 está disponível. CustomizedRecoverable+ProtectedSubscription: indica um cofre e um estado de assinatura no qual a exclusão é recuperável, 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.

Enumerações

KnownDeletionRecoveryLevel

Valores conhecidos de DeletionRecoveryLevel que o serviço aceita.

Funções

parseKeyVaultSecretIdentifier(string)

Analisa a ID secreta Key Vault fornecida. Um exemplo é: https://.vault.azure.net/secrets// 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>" }

Detalhes da função

parseKeyVaultSecretIdentifier(string)

Analisa a ID secreta Key Vault fornecida. Um exemplo é:

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

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>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Parâmetros

id

string

A ID do segredo do Key Vault.

Retornos

KeyVaultSecretIdentifier