Get Deleted Secrets - Get Deleted Secrets

Referência

Service:: Key Vault

API Version:: 7.4

Listas segredos excluídos para o cofre especificado.
A operação Obter Segredos Excluídos retorna os segredos que foram excluídos para um cofre habilitado para exclusão reversível. Essa operação requer a permissão de segredos/lista.

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

With optional parameters:

GET {vaultBaseUrl}/deletedsecrets?maxresults={maxresults}&api-version=7.4

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versão de API do cliente.
maxresults	query		integer int32	Número máximo de resultados a serem retornados em uma página. Se não for especificado, o serviço retornará até 25 resultados.

Respostas

Nome	Tipo	Description
200 OK	DeletedSecretListResult	Uma mensagem de resposta que contém uma lista de segredos excluídos no cofre, juntamente com um link para a próxima página de segredos excluídos.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

GetDeletedSecrets

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/listdeletedsecrettest0",
      "deletedDate": 1493937855,
      "scheduledPurgeDate": 1501713855,
      "contentType": "plainText",
      "id": "https://myvault.vault.azure.net/secrets/listdeletedsecrettest0",
      "attributes": {
        "enabled": true,
        "created": 1493937855,
        "updated": 1493937855,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedsecrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExNDQhTURBd01EWXlJWE5sWTNKbGRDOU1TVk5VUkVWTVJWUkZSRk5GUTFKRlZGUkZVMVF3THpZMU16ZERSRVJGTlRJNU5qUkRSa1pDTVRkQ1JVWXhORGszUXpSQ1JEZEVJVEF3TURBeU9DRXlNREUzTFRBMUxUQTBWREl5T2pRME9qUXdMamsxTnpZeE1UbGFJUS0tIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

Definições

Nome	Description
DeletedSecretItem	O item secreto excluído que contém metadados sobre o segredo excluído.
DeletedSecretListResult	O resultado da lista de segredos excluído
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver 'Purgeable', 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.
Error	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
SecretAttributes	Os atributos de gerenciamento de segredos.

DeletedSecretItem

O item secreto excluído que contém metadados sobre o segredo excluído.

Nome	Tipo	Description
attributes	SecretAttributes	Os atributos de gerenciamento de segredos.
contentType	string	Tipo do valor do segredo, como uma senha.
deletedDate	integer	A hora em que o segredo foi excluído, em UTC
id	string	Identificador de segredo.
managed	boolean	True se o tempo de vida do segredo for gerenciado pelo cofre de chaves. Se essa for uma chave que faz backup de um certificado, a gerenciada será verdadeira.
recoveryId	string	A URL do objeto de recuperação, usada para identificar e recuperar o segredo excluído.
scheduledPurgeDate	integer	A hora em que o segredo está agendado para ser limpo, em UTC
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.

DeletedSecretListResult

O resultado da lista de segredos excluído

Nome	Tipo	Description
nextLink	string	A URL para obter o próximo conjunto de segredos excluídos.
value	DeletedSecretItem[]	Uma mensagem de resposta que contém uma lista dos segredos excluídos no cofre juntamente com um link para a próxima página de segredos excluídos

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver 'Purgeable', 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.

Nome	Tipo	Description
CustomizedRecoverable	string	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	string	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.
CustomizedRecoverable+Purgeable	string	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.
Purgeable	string	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.)
Recoverable	string	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	string	Indica 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, a 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
Recoverable+Purgeable	string	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

Error

O erro do servidor do cofre de chaves.

Nome	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.

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

SecretAttributes

Os atributos de gerenciamento de segredos.

Nome	Tipo	Description
created	integer	Tempo de criação em UTC.
enabled	boolean	Determina se o objeto está habilitado.
exp	integer	Data de expiração em UTC.
nbf	integer	Não antes da data em UTC.
recoverableDays	integer	softDelete dias de retenção de dados. O valor deve ser >=7 e <=90 quando softDelete habilitado, caso contrário, 0.
recoveryLevel	DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se ele contiver 'Purgeable', 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.
updated	integer	Hora da última atualização em UTC.