Get Deleted Certificate - Get Deleted Certificate
Recupera informações sobre o certificado excluído especificado.
A operação GetDeletedCertificate recupera as informações de certificado excluídas mais seus atributos, como intervalo de retenção, exclusão permanente agendada e o nível de recuperação de exclusão atual. Essa operação requer a permissão de obtenção/certificados.
GET {vaultBaseUrl}/deletedcertificates/{certificate-name}?api-version=7.4
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
certificate-name
|
path | True |
string |
O nome do certificado |
vault
|
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. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Um pacote de certificados do certificado e seus atributos |
|
Other Status Codes |
Key Vault resposta de erro que descreve por que a operação falhou. |
Exemplos
GetDeletedCertificate
Sample Request
GET https://myvault.vault.azure.net//deletedcertificates/getDeletedCert?api-version=7.4
Sample Response
{
"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
Nome | Description |
---|---|
Action |
A ação que será executada. |
Certificate |
Os atributos de gerenciamento de certificado. |
Certificate |
Política de gerenciamento para um certificado. |
Certificate |
O tipo da ação. |
Deleted |
Um Certificado Excluído que consiste em sua ID anterior, atributos e suas marcas, bem como informações sobre quando ele será limpo. |
Deletion |
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. |
Issuer |
Parâmetros para o emissor do componente X509 de um certificado. |
Json |
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. |
Json |
O tipo de par de chaves a ser usado para o certificado. |
Key |
Propriedades do par de chaves que dão suporte a um certificado. |
Key |
Define como a chave do certificado pode ser usada. |
Key |
A exceção de erro do cofre de chaves. |
Lifetime |
A ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de um certificado. |
Secret |
Propriedades da chave que dá suporte a um certificado. |
Subject |
Os nomes alternativos de assunto de um objeto X509. |
Trigger |
Uma condição a ser atendida para que uma ação seja executada. |
X509Certificate |
Propriedades do componente X509 de um certificado. |
Action
A ação que será executada.
Nome | Tipo | Description |
---|---|---|
action_type |
O tipo da ação. |
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 |
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. |
CertificatePolicy
Política de gerenciamento para um certificado.
Nome | Tipo | Description |
---|---|---|
attributes |
Os atributos de certificado. |
|
id |
string |
A ID do certificado. |
issuer |
Parâmetros para o emissor do componente X509 de um certificado. |
|
key_props |
Propriedades da chave que dá suporte a um certificado. |
|
lifetime_actions |
Ações que serão executadas por Key Vault ao longo do tempo de vida de um certificado. |
|
secret_props |
Propriedades do segredo que dá suporte a um certificado. |
|
x509_props |
Propriedades do componente X509 de um certificado. |
CertificatePolicyAction
O tipo da ação.
Nome | Tipo | Description |
---|---|---|
AutoRenew |
string |
|
EmailContacts |
string |
DeletedCertificateBundle
Um Certificado Excluído que consiste em sua ID anterior, atributos e suas marcas, bem como informações sobre quando ele será limpo.
Nome | Tipo | Description |
---|---|---|
attributes |
Os atributos de certificado. |
|
cer |
string |
Conteúdo CER do certificado x509. |
contentType |
string |
O tipo de conteúdo do segredo. ex. 'application/x-pem-file' ou 'application/x-pkcs12', |
deletedDate |
integer |
A hora em que o certificado foi excluído, em UTC |
id |
string |
A ID do certificado. |
kid |
string |
A ID da chave. |
policy |
A política de gerenciamento. |
|
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 |
sid |
string |
A ID secreta. |
tags |
object |
Metadados específicos do aplicativo na forma de pares chave-valor |
x5t |
string |
Impressão digital do certificado. |
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 |
O erro do servidor do cofre de chaves. |
|
message |
string |
A mensagem de erro. |
IssuerParameters
Parâmetros para o emissor do componente X509 de um certificado.
Nome | Tipo | Description |
---|---|---|
cert_transparency |
boolean |
Indica se os certificados gerados nessa política devem ser publicados nos logs de transparência do certificado. |
cty |
string |
Tipo de certificado com suporte do provedor (opcional); por exemplo, 'OV-SSL', 'EV-SSL' |
name |
string |
Nome do objeto emissor referenciado ou nomes reservados; por exemplo, 'Self' ou 'Unknown'. |
JsonWebKeyCurveName
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.
Nome | Tipo | Description |
---|---|---|
P-256 |
string |
|
P-256K |
string |
|
P-384 |
string |
|
P-521 |
string |
JsonWebKeyType
O tipo de par de chaves a ser usado para o certificado.
Nome | Tipo | Description |
---|---|---|
EC |
string |
|
EC-HSM |
string |
|
RSA |
string |
|
RSA-HSM |
string |
|
oct |
string |
|
oct-HSM |
string |
KeyProperties
Propriedades do par de chaves que dão suporte a um certificado.
Nome | Tipo | Description |
---|---|---|
crv |
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. |
|
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. |
key_size |
integer |
O tamanho da chave em bits. Por exemplo: 2048, 3072 ou 4096 para RSA. |
kty |
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
Define como a chave do certificado pode ser usada.
Nome | Tipo | Description |
---|---|---|
cRLSign |
string |
|
dataEncipherment |
string |
|
decipherOnly |
string |
|
digitalSignature |
string |
|
encipherOnly |
string |
|
keyAgreement |
string |
|
keyCertSign |
string |
|
keyEncipherment |
string |
|
nonRepudiation |
string |
KeyVaultError
A exceção de erro do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
error |
O erro do servidor do cofre de chaves. |
LifetimeAction
A ação e seu gatilho que serão executados por Key Vault ao longo do tempo de vida de um certificado.
Nome | Tipo | Description |
---|---|---|
action |
A ação que será executada. |
|
trigger |
A condição que executará a ação. |
SecretProperties
Propriedades da chave que dá suporte a um certificado.
Nome | Tipo | Description |
---|---|---|
contentType |
string |
O tipo de mídia (tipo MIME). |
SubjectAlternativeNames
Os nomes alternativos de assunto de um objeto X509.
Nome | Tipo | Description |
---|---|---|
dns_names |
string[] |
Nomes de domínio. |
emails |
string[] |
Endereços de email. |
upns |
string[] |
Nomes de entidade de segurança do usuário. |
Trigger
Uma condição a ser atendida para que uma ação seja executada.
Nome | Tipo | Description |
---|---|---|
days_before_expiry |
integer |
Dias antes da expiração para tentar a renovação. O valor deve estar entre 1 e validity_in_months multiplicado por 27. Se validity_in_months for 36, o valor deverá estar entre 1 e 972 (36 * 27). |
lifetime_percentage |
integer |
Percentual de tempo de vida no qual disparar. O valor deve estar entre 1 e 99. |
X509CertificateProperties
Propriedades do componente X509 de um certificado.
Nome | Tipo | Description |
---|---|---|
ekus |
string[] |
O uso aprimorado da chave. |
key_usage |
Define como a chave do certificado pode ser usada. |
|
sans |
Os nomes alternativos do assunto. |
|
subject |
string |
O nome da entidade. Deve ser um Nome diferenciado X509 válido. |
validity_months |
integer |
A duração em que o certificado é válido em meses. |