Get Deleted Keys - Get Deleted Keys

Referência

Serviço:: Key Vault

Versão da API:: 7.4

Listas as chaves excluídas no cofre especificado.
Recupera uma lista das chaves no Key Vault como estruturas de chave da Web JSON que contêm a parte pública de uma chave excluída. Essa operação inclui informações específicas de exclusão. A operação Obter Chaves Excluídas é aplicável a cofres habilitados para exclusão reversível. Embora a operação possa ser invocada em qualquer cofre, ela retornará um erro se invocada em um cofre não habilitado para exclusão reversível. Essa operação requer a permissão de chaves/lista.

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

Com parâmetros opcionais:

GET {vaultBaseUrl}/deletedkeys?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	DeletedKeyListResult	Uma mensagem de resposta que contém uma lista de chaves excluídas no cofre junto com um link para a próxima página de chaves excluídas.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

GetDeletedKeys

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedkeys/listdeletedkeytest0",
      "deletedDate": 1493938031,
      "scheduledPurgeDate": 1501714031,
      "kid": "https://myvault.vault.azure.net/keys/listdeletedkeytest0",
      "attributes": {
        "enabled": true,
        "created": 1493938031,
        "updated": 1493938031,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedkeys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Definições

Nome	Description
DeletedKeyItem	O item de chave excluído que contém os metadados de chave excluídos e as informações sobre exclusão.
DeletedKeyListResult	Uma lista de chaves que foram excluídas neste cofre.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar a chave, no final do intervalo de retenção.
Error	O erro do servidor do cofre de chaves.
KeyAttributes	Os atributos de uma chave gerenciada pelo serviço do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.

DeletedKeyItem

O item de chave excluído que contém os metadados de chave excluídos e as informações sobre exclusão.

Nome	Tipo	Description
attributes	KeyAttributes	Os atributos de gerenciamento de chaves.
deletedDate	integer	A hora em que a chave foi excluída, em UTC
kid	string	Identificador de chave.
managed	boolean	True se o tempo de vida da chave for gerenciado pelo cofre de chaves. Se essa for uma chave que dá suporte a um certificado, a opção gerenciada será verdadeira.
recoveryId	string	A URL do objeto de recuperação, usada para identificar e recuperar a chave excluída.
scheduledPurgeDate	integer	A hora em que a chave está agendada para ser limpa, em UTC
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.

DeletedKeyListResult

Uma lista de chaves que foram excluídas neste cofre.

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

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para chaves no cofre atual. Se contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar a chave, 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, limpar 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, 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 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 a exclusão imediata e permanente (ou seja, limpar 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 relação a uma operação De exclusão; 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	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 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 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.

KeyAttributes

Os atributos de uma chave gerenciada pelo serviço do cofre de chaves.

Nome	Tipo	Description
created	integer	Hora de criação em UTC.
enabled	boolean	Determina se o objeto está habilitado.
exp	integer	Data de expiração em UTC.
exportable	boolean	Indica se a chave privada pode ser exportada. A política de versão deve ser fornecida ao criar a primeira versão de uma chave exportável.
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 chaves no cofre atual. Se contiver "Purgável", a chave poderá ser excluída permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar a chave, no final do intervalo de retenção.
updated	integer	Hora da última atualização em UTC.

KeyVaultError

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

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

Compartilhar via