Get Deleted Secret - Get Deleted Secret

Referência

Serviço:: Key Vault

Versão da API:: 7.4

Obtém o segredo eliminado especificado.
A operação Obter Segredo Eliminado devolve o segredo eliminado especificado juntamente com os respetivos atributos. Esta operação requer os segredos/obter permissão.

GET {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=7.4

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
secret-name	path	True	string	O nome do segredo.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	DeletedSecretBundle	Um pacote secreto do segredo e dos seus atributos.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

GetDeletedSecret

Pedido de amostra

HTTP

GET https://myvault.vault.azure.net//deletedsecrets/GetDeletedSecretTest?api-version=7.4

Resposta da amostra

Código de estado:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
  "deletedDate": 1493938433,
  "scheduledPurgeDate": 1501714433,
  "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
  "attributes": {
    "enabled": true,
    "created": 1493938433,
    "updated": 1493938433,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definições

Name	Description
DeletedSecretBundle	Um Segredo Eliminado que consiste no ID anterior, atributos e respetivas etiquetas, bem como informações sobre quando será removido.
DeletionRecoveryLevel	Reflete o nível de recuperação de eliminação atualmente em vigor para segredos no cofre atual. Se contiver "Purpurável", o segredo pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o segredo, no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
SecretAttributes	Os atributos de gestão de segredos.

DeletedSecretBundle

Um Segredo Eliminado que consiste no ID anterior, atributos e respetivas etiquetas, bem como informações sobre quando será removido.

Name	Tipo	Description
attributes	SecretAttributes	Os atributos de gestão de segredos.
contentType	string	O tipo de conteúdo do segredo.
deletedDate	integer	A hora em que o segredo foi eliminado, em UTC
id	string	O ID secreto.
kid	string	Se for um segredo que suporta um certificado KV, este campo especifica a chave correspondente que suporta o certificado KV.
managed	boolean	Verdadeiro se a duração do segredo for gerida pelo cofre de chaves. Se for um segredo que suporta um certificado, será verdade que será gerido.
recoveryId	string	O URL do objeto de recuperação, utilizado para identificar e recuperar o segredo eliminado.
scheduledPurgeDate	integer	A hora em que o segredo está agendado para ser removido, em UTC
tags	object	Metadados específicos da aplicação na forma de pares chave-valor.
value	string	O valor do segredo.

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para segredos no cofre atual. Se contiver "Purpurável", o segredo pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o segredo, no final do intervalo de retenção.

Name	Tipo	Description
CustomizedRecoverable	string	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	string	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 em que 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.
CustomizedRecoverable+Purgeable	string	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.
Purgeable	string	Indica um estado do cofre em que 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.)
Recoverable	string	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
Recoverable+ProtectedSubscription	string	Indica um estado do cofre e da subscrição em que 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
Recoverable+Purgeable	string	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

Error

O erro do servidor do cofre de chaves.

Name	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

KeyVaultError

A exceção de erro do cofre de chaves.

Name	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

SecretAttributes

Os atributos de gestão de segredos.

Name	Tipo	Description
created	integer	Tempo de criação em UTC.
enabled	boolean	Determina se o objeto está ativado.
exp	integer	Data de expiração em UTC.
nbf	integer	Não antes da data em UTC.
recoverableDays	integer	softDelete data retention days. O valor deve ser >=7 e <=90 quando softDelete ativado, caso contrário 0.
recoveryLevel	DeletionRecoveryLevel	Reflete o nível de recuperação de eliminação atualmente em vigor para segredos no cofre atual. Se contiver "Purpurável", o segredo pode ser eliminado permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover o segredo, no final do intervalo de retenção.
updated	integer	Hora da última atualização em UTC.

Partilhar via