Get Deleted Certificates - Get Deleted Certificates

Referência

Service:: Key Vault

API Version:: 7.4

Listas os certificados excluídos no cofre especificado atualmente disponíveis para recuperação.
A operação GetDeletedCertificates recupera os certificados no cofre atual que estão em um estado excluído e prontos para recuperação ou limpeza. Essa operação inclui informações específicas de exclusão. Essa operação requer a permissão certificates/get/list. Essa operação só pode ser habilitada em cofres habilitados para exclusão reversível.

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

With optional parameters:

GET {vaultBaseUrl}/deletedcertificates?maxresults={maxresults}&includePending={includePending}&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.
includePending	query		boolean	Especifica se os certificados que não são completamente provisionados devem ser incluídos.
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	DeletedCertificateListResult	Uma mensagem de resposta que contém uma lista de certificados excluídos no cofre juntamente com um link para a próxima página de certificados excluídos
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

GetDeletedCertificates

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0",
      "deletedDate": 1493937659,
      "scheduledPurgeDate": 1501713659,
      "id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1493937658,
        "updated": 1493937658,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Definições

Nome	Description
CertificateAttributes	Os atributos de gerenciamento de certificado.
DeletedCertificateItem	O item de certificado excluído que contém metadados sobre o certificado excluído.
DeletedCertificateListResult	Uma lista de certificados que foram excluídos neste cofre.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar o certificado, 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.

CertificateAttributes

Os atributos de gerenciamento de certificado.

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.
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 certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar o certificado, no final do intervalo de retenção.
updated	integer	Hora da última atualização em UTC.

DeletedCertificateItem

O item de certificado excluído que contém metadados sobre o certificado excluído.

Nome	Tipo	Description
attributes	CertificateAttributes	Os atributos de gerenciamento de certificado.
deletedDate	integer	A hora em que o certificado foi excluído, em UTC
id	string	Identificador de certificado.
recoveryId	string	A URL do objeto de recuperação, usada para identificar e recuperar o certificado excluído.
scheduledPurgeDate	integer	A hora em que o certificado está agendado para ser limpo, em UTC
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.
x5t	string	Impressão digital do certificado.

DeletedCertificateListResult

Uma lista de certificados que foram excluídos neste cofre.

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

DeletionRecoveryLevel

Reflete o nível de recuperação de exclusão atualmente em vigor para certificados no cofre atual. Se ele contiver "Purgável", o certificado poderá ser excluído permanentemente por um usuário privilegiado; caso contrário, somente o sistema pode limpar o certificado, 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.

KeyVaultError

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

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