@azure/keyvault-secrets package

Classes

SecretClient

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 deleteSecret para uma eliminação recuperável ativada do Azure Key Vault.

Interfaces

BackupSecretOptions	Opções para <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Uma interface que representa os parâmetros opcionais que podem ser transmitidos para beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Uma interface que representa os parâmetros opcionais que podem ser transmitidos para beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Uma interface que representa um Segredo keyVault eliminado.
GetDeletedSecretOptions	Opções para getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Opções para getSecret(string, GetSecretOptions).
KeyVaultSecret	Uma interface que representa um Segredo keyVault, com o respetivo nome, valor e SecretProperties.
KeyVaultSecretIdentifier	Representa os segmentos que compõem um Key Vault ID secreto.
ListDeletedSecretsOptions	Opções para listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	Opções para listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	Opções para listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	Uma interface que controla as definições da iteração paginada
PagedAsyncIterableIterator	Uma interface que permite a iteração iterável assíncrona para a conclusão e por página.
PollOperationState	PollOperationState contém uma lista opinada 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 controlo local para começar a acionar, aguardar e potencialmente cancelar uma operação de execução prolongada, o PollOperationState documenta o estado da operação de execução prolongada remota. Deve ser atualizado pelo menos quando a operação for iniciada, quando terminar 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 que o utilizador precisa de trabalhar.
PurgeDeletedSecretOptions	Opções para purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Opções para restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Os parâmetros opcionais aceites pelo KeyClient do KeyVault
SecretPollerOptions	Uma interface que representa os parâmetros opcionais que podem ser transmitidos 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 utilizado alternadamente com DeletionRecoveryLevel, esta enum contém os valores conhecidos suportados pelo serviço. Valores conhecidos suportados pelo serviço Removível: indica um estado do cofre no qual a eliminação é uma operação irreversível, sem a possibilidade de recuperação. Este nível não corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são irremediavelmente perdidos ao aceitar uma operação Delete ao nível da entidade ou superior (cofre, grupo de recursos, subscrição, etc.) Recuperável+Removível: indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias), a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado Recuperável: indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias) e enquanto a subscrição ainda está disponível. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado Recuperável+ProtectedSubscription: indica um cofre e estado de subscrição no qual a eliminação é recuperável dentro do intervalo de retenção (90 dias), a eliminação imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado CustomizedRecoverable+Purgeable: indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção, a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. CustomizedRecoverable: indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e enquanto a subscrição ainda está disponível. CustomizedRecoverable+ProtectedSubscription: indica um cofre e estado de subscrição no qual a eliminação é recuperável, imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e também reflete o facto de a própria subscrição não poder ser cancelada.

Enumerações

KnownDeletionRecoveryLevel

Valores conhecidos de DeletionRecoveryLevel que o serviço aceita.

Funções

parseKeyVaultSecretIdentifier(string)

Analisa o ID do Segredo do Key Vault especificado. Um exemplo é: https://.vault.azure.net/secrets// Ao analisar o ID acima, esta função devolve: { 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 do Segredo do Key Vault especificado. Um exemplo é:

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

Ao analisar o ID acima, esta função devolve:

  {
     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 Key Vault.

Devoluções

KeyVaultSecretIdentifier