Get Deleted Certificate - Get Deleted Certificate

Serviço:: Key Vault

Versão da API:: 2025-07-01

Recupera informações sobre o certificado excluído especificado.
A operação GetDeletedCertificate recupera as informações do certificado excluído mais seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual. Esta operação requer os certificados/obter permissão.

GET {vaultBaseUrl}/deletedcertificates/{certificate-name}?api-version=2025-07-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
certificate-name	path	True	string	O nome do certificado
vaultBaseUrl	path	True	string (uri)
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	DeletedCertificateBundle	O pedido foi bem-sucedido.
Other Status Codes	KeyVaultError	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
https://vault.azure.net/.default

Exemplos

GetDeletedCertificate

Pedido de amostra

HTTP

GET https://myvault.vault.azure.net//deletedcertificates/getDeletedCert?api-version=2025-07-01

Resposta da amostra

Código de estado:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/getDeletedCert",
  "deletedDate": 1493938292,
  "scheduledPurgeDate": 1501714292,
  "id": "https://myvault.vault.azure.net/certificates/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769",
  "kid": "https://myvault.vault.azure.net/keys/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769",
  "sid": "https://myvault.vault.azure.net/secrets/getDeletedCert/f60f2a4f8ae442cfb41ca2090bd4b769",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938289,
    "updated": 1493938291,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://myvault.vault.azure.net/certificates/getDeletedCert/policy",
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=KeyVaultTest",
      "ekus": [],
      "key_usage": [],
      "validity_months": 297
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938289,
      "updated": 1493938291
    }
  }
}

Definições

Name	Description
Action	A ação que será executada.
CertificateAttributes	Os atributos de gerenciamento de certificado.
CertificatePolicy	Política de gestão de um certificado.
CertificatePolicyAction	O tipo de ação.
DeletedCertificateBundle	Um Certificado Excluído que consiste em sua ID anterior, atributos e suas tags, bem como informações sobre quando ele será limpo.
DeletionRecoveryLevel	Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o segredo, no final do intervalo de retenção.
Error
IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
JsonWebKeyCurveName	Nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName.
JsonWebKeyType	O tipo de par de chaves a ser usado para o certificado.
KeyProperties	Propriedades do par de chaves que dá suporte a um certificado.
KeyUsageType	Usos suportados de uma chave de certificado.
KeyVaultError	A exceção de erro do cofre de chaves.
LifetimeAction	Ação e seu gatilho que será executado pelo Key Vault ao longo da vida útil de um certificado.
SecretProperties	Propriedades da chave que dá suporte a um certificado.
SubjectAlternativeNames	Os nomes alternativos do assunto de um objeto X509.
Trigger	Uma condição a ser satisfeita para que uma ação seja executada.
X509CertificateProperties	Propriedades do componente X509 de um certificado.

Action

Object

A ação que será executada.

Name	Tipo	Description
action_type	CertificatePolicyAction	O tipo de ação.

CertificateAttributes

Object

Os atributos de gerenciamento de certificado.

Name	Tipo	Description
created	integer (unixtime)	Hora de criação em UTC.
enabled	boolean	Determina se o objeto está habilitado.
exp	integer (unixtime)	Data de validade em UTC.
nbf	integer (unixtime)	Não antes da data em UTC.
recoverableDays	integer (int32)	softDelete dias de retenção de dados. O valor deve ser >=7 e <=90 quando softDelete ativado, 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 contiver 'Purgeable', o certificado pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o certificado, no final do intervalo de retenção.
updated	integer (unixtime)	Última atualização em UTC.

CertificatePolicy

Object

Política de gestão de um certificado.

Name	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado.
id	string	A ID do certificado.
issuer	IssuerParameters	Parâmetros para o emissor do componente X509 de um certificado.
key_props	KeyProperties	Propriedades da chave que dá suporte a um certificado.
lifetime_actions	LifetimeAction[]	Ações que serão executadas pelo Key Vault durante o tempo de vida de um certificado.
secret_props	SecretProperties	Propriedades do segredo que dá suporte a um certificado.
x509_props	X509CertificateProperties	Propriedades do componente X509 de um certificado.

CertificatePolicyAction

Enumeração

O tipo de ação.

Valor	Description
EmailContacts	Uma política de certificado que enviará contatos de certificado por e-mail.
AutoRenew	Uma política de certificado que renovará automaticamente um certificado.

DeletedCertificateBundle

Object

Um Certificado Excluído que consiste em sua ID anterior, atributos e suas tags, bem como informações sobre quando ele será limpo.

Name	Tipo	Description
attributes	CertificateAttributes	Os atributos do certificado.
cer	string (byte)	Conteúdo CER do certificado x509.
contentType	string	O tipo de conteúdo do segredo. eg. 'application/x-pem-file' ou 'application/x-pkcs12'.
deletedDate	integer (unixtime)	A hora em que o certificado foi excluído, em UTC
id	string	A ID do certificado.
kid	string	O id da chave.
policy	CertificatePolicy	A política de gestão.
preserveCertOrder	boolean	Especifica se a cadeia de certificados preserva sua ordem original. O valor padrão é false, que define o certificado folha no índice 0.
recoveryId	string	A url do objeto de recuperação, usado para identificar e recuperar o certificado excluído.
scheduledPurgeDate	integer (unixtime)	A hora em que o certificado está programado para ser limpo, em UTC
sid	string	O id secreto.
tags	object	Metadados específicos do aplicativo na forma de pares chave-valor.
x5t	string (base64url)	Impressão digital do certificado.

DeletionRecoveryLevel

Enumeração

Reflete o nível de recuperação de exclusão atualmente em vigor para segredos no cofre atual. Se contiver 'Purgeable', o segredo pode ser permanentemente eliminado por um utilizador privilegiado; caso contrário, apenas o sistema pode limpar o segredo, no final do intervalo de retenção.

Valor	Description
Purgeable	Indica um estado de cofre no qual a exclusão é uma operação irreversível, sem a possibilidade de recuperação. Este nível corresponde a nenhuma proteção disponível contra uma operação Delete; 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+Purgeable	Indica um estado vault 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable	Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga). 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 irá excluí-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription	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 irá excluí-lo permanentemente após 90 dias, se não for recuperado
CustomizedRecoverable+Purgeable	Indica um estado vault no qual a exclusão é recuperável e que também permite a exclusão imediata e permanente (ou seja, purgar 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 Purge seja solicitada ou a assinatura seja cancelada.
CustomizedRecoverable	Indica um estado vault no qual a exclusão é recuperável sem a possibilidade de exclusão imediata e permanente (ou seja, purga 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 estiver disponível.
CustomizedRecoverable+ProtectedSubscription	Indica um estado de cofre e 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 permanentemente cancelada 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 assinatura em si não pode ser cancelada.

Error

Object

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.

IssuerParameters

Object

Parâmetros para o emissor do componente X509 de um certificado.

Name	Tipo	Description
cert_transparency	boolean	Indica se os certificados gerados sob esta política devem ser publicados nos logs de transparência de certificados.
cty	string	Tipo de certificado conforme suportado pelo provedor (opcional); por exemplo, 'OV-SSL', 'EV-SSL'
name	string	Nome do objeto emissor referenciado ou nomes reservados; por exemplo, 'Eu' ou 'Desconhecido'.

JsonWebKeyCurveName

Enumeração

Nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName.

Valor	Description
P-256	A curva elíptica NIST P-256, AKA curva SECG SECP256R1.
P-384	A curva elíptica NIST P-384, AKA curva SECG SECP384R1.
P-521	A curva elíptica NIST P-521, AKA curva SECG SECP521R1.
P-256K	A SECG SECP256K1 curva elíptica.

JsonWebKeyType

Enumeração

O tipo de par de chaves a ser usado para o certificado.

Valor	Description
EC	Curva Elíptica.
EC-HSM	Curva elíptica com uma chave privada que não é exportável do HSM.
RSA	ASR (https://tools.ietf.org/html/rfc3447).
RSA-HSM	RSA com uma chave privada que não é exportável do HSM.
oct	Sequência de octeto (usada para representar chaves simétricas).
oct-HSM	Sequência Octet com uma chave privada que não é exportável do HSM.

KeyProperties

Object

Propriedades do par de chaves que dá suporte a um certificado.

Name	Tipo	Description
crv	JsonWebKeyCurveName	Nome da curva elíptica. Para valores válidos, consulte JsonWebKeyCurveName.
exportable	boolean	Indica se a chave privada pode ser exportada. A política de liberação deve ser fornecida ao criar a primeira versão de uma chave exportável.
key_size	integer (int32)	O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA.
kty	JsonWebKeyType	O tipo de par de chaves a ser usado para o certificado.
reuse_key	boolean	Indica se o mesmo par de chaves será usado na renovação do certificado.

KeyUsageType

Enumeração

Usos suportados de uma chave de certificado.

Valor	Description
digitalSignature	Indica que a chave do certificado pode ser usada como uma assinatura digital.
nonRepudiation	Indica que a chave de certificado pode ser usada para autenticação.
keyEncipherment	Indica que a chave de certificado pode ser usada para criptografia de chave.
dataEncipherment	Indica que a chave de certificado pode ser usada para criptografia de dados.
keyAgreement	Indica que a chave de certificado pode ser usada para determinar o acordo de chave, como uma chave criada usando o algoritmo de contrato de chave Diffie-Hellman.
keyCertSign	Indica que a chave de certificado pode ser usada para assinar certificados.
cRLSign	Indica que a chave de certificado pode ser usada para assinar uma lista de revogação de certificados.
encipherOnly	Indica que a chave de certificado pode ser usada apenas para criptografia.
decipherOnly	Indica que a chave de certificado pode ser usada apenas para desencriptação.

KeyVaultError

Object

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

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

LifetimeAction

Object

Ação e seu gatilho que será executado pelo Key Vault ao longo da vida útil de um certificado.

Name	Tipo	Description
action	Action	A ação que será executada.
trigger	Trigger	A condição que executará a ação.

SecretProperties

Object

Propriedades da chave que dá suporte a um certificado.

Name	Tipo	Description
contentType	string	O tipo de mídia (tipo MIME).

SubjectAlternativeNames

Object

Os nomes alternativos do assunto de um objeto X509.

Name	Tipo	Description
dns_names	string[]	Nomes de Domínio.
emails	string[]	Endereços de e-mail.
ipAddresses	string[]	Endereços IP; suporta IPv4 e IPv6.
upns	string[]	Nomes principais do usuário.
uris	string[]	Identificadores Uniformes de Recursos.

Trigger

Object

Uma condição a ser satisfeita para que uma ação seja executada.

Name	Tipo	Description
days_before_expiry	integer (int32)	Dias antes do vencimento para tentar a renovação. O valor deve estar entre 1 e validity_in_months multiplicado por 27. Se validity_in_months é 36, então o valor deve estar entre 1 e 972 (36 * 27).
lifetime_percentage	integer (int32) minimum: 1 maximum: 99	Percentagem do tempo de vida a que deve ser desencadeado. O valor deve estar entre 1 e 99.

X509CertificateProperties

Object

Propriedades do componente X509 de um certificado.

Name	Tipo	Description
ekus	string[]	O uso aprimorado da chave.
key_usage	KeyUsageType[]	Define como a chave do certificado pode ser usada.
sans	SubjectAlternativeNames	Os nomes alternativos do assunto.
subject	string	O nome do assunto. Deve ser um Nome distinto X509 válido.
validity_months	integer (int32) minimum: 0	A duração que o certificado é válido em meses.

Partilhar via

Get Deleted Certificate - Get Deleted Certificate

Parâmetros do URI

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

GetDeletedCertificate

Pedido de amostra

Resposta da amostra

Definições

Action

CertificateAttributes

CertificatePolicy

CertificatePolicyAction

DeletedCertificateBundle

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties