Recover Deleted Key - Recover Deleted Key
Recupera a chave excluída para sua versão mais recente.
A operação Recuperar Chave Excluída é aplicável a chaves excluídas em cofres habilitados para exclusão reversível. Ele recupera a chave excluída de volta para sua versão mais recente em /keys. Uma tentativa de recuperar uma chave não excluída retornará um erro. Considere isso o inverso da operação de exclusão em cofres habilitados para exclusão reversível. Essa operação requer a permissão de recuperação/chaves.
POST {vaultBaseUrl}/deletedkeys/{key-name}/recover?api-version=7.4
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
key-name
|
path | True |
string |
O nome da chave excluída. |
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 chave da chave original e seus atributos |
|
Other Status Codes |
Key Vault resposta de erro que descreve por que a operação falhou. |
Exemplos
RecoverDeletedKey
Sample Request
POST https://myvault.vault.azure.net//deletedkeys/CreateDeleteRecoverPurgeTest/recover?api-version=7.4
Sample Response
{
"key": {
"kid": "https://myvault.vault.azure.net/keys/CreateDeleteRecoverPurgeTest/6fc2be54c6be4a7ea7bbb8a2a99a1996",
"kty": "RSA",
"key_ops": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey"
],
"n": "v-SWMCmPNKoK_rB_pNXUl6Iwh9Kqd3XzQlh6SXi_slBishqP7pyKEFjNbUvMSlyvPt21rJupLbJr-yhsK2Rq2V6O0doGuCsoadgNGih1aVAuUJAJls1-b-G1IJjD18ArM4RitnCvJmQFqyK2RVHa3EpEfaQW4gcRrsRAhiJDjc1L1S3skdt-E_rZfL7DIh1ZtqFyQAqIWSAG0BXDdbgfEx1kJKqH-HRokDKeMCIaJtKZof6e-DJr3e9Iy8aAR7V-BsZ7vY7JMjyeEukMzEji4MEsIyOESL67DgFllDEi4OM_3WKyxr6uXxzHDzmppWsk2ykLsYA_ALLnR3ZNZCuL9Q",
"e": "AQAB"
},
"attributes": {
"enabled": true,
"created": 1493938342,
"updated": 1493938342,
"recoveryLevel": "Recoverable+Purgeable"
},
"tags": {
"purpose": "unit test",
"test name ": "CreateDeleteRecoverPurgeTest"
}
}
Definições
Nome | Description |
---|---|
Deletion |
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. |
Json |
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 |
Json |
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. |
Json |
Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
Key |
Os atributos de uma chave gerenciada pelo serviço do cofre de chaves. |
Key |
Um KeyBundle que consiste em uma WebKey mais seus atributos. |
Key |
As regras de política sob as quais a chave pode ser exportada. |
Key |
A exceção de erro do cofre de chaves. |
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 |
O erro do servidor do cofre de chaves. |
|
message |
string |
A mensagem de erro. |
JsonWebKey
A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
Nome | Tipo | Description |
---|---|---|
crv |
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName. |
|
d |
string |
Expoente privado RSA ou o componente D de uma chave privada de EC. |
dp |
string |
Parâmetro de chave privada RSA. |
dq |
string |
Parâmetro de chave privada RSA. |
e |
string |
Expoente público RSA. |
k |
string |
Chave simétrica. |
key_hsm |
string |
Chave protegida, usada com "Traga sua própria chave". |
key_ops |
string[] |
Operações de chave com suporte. |
kid |
string |
Identificador de chave. |
kty |
Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. |
|
n |
string |
Módulo RSA. |
p |
string |
Segredo RSA primo. |
q |
string |
RSA secret prime, with p < q. |
qi |
string |
Parâmetro de chave privada RSA. |
x |
string |
Componente X de uma chave pública EC. |
y |
string |
Componente Y de uma chave pública de EC. |
JsonWebKeyCurveName
Nome da curva elíptica. Para obter valores válidos, consulte JsonWebKeyCurveName.
Nome | Tipo | Description |
---|---|---|
P-256 |
string |
A curva elíptica NIST P-256, também conhecida como curva SECG SECP256R1. |
P-256K |
string |
O SECG SECP256K1 curva elíptica. |
P-384 |
string |
A curva elíptica NIST P-384, também conhecida como curva SECG SECP384R1. |
P-521 |
string |
A curva elíptica NIST P-521, também conhecida como curva SECG SECP521R1. |
JsonWebKeyType
Tipo de chave JsonWebKey (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
Nome | Tipo | Description |
---|---|---|
EC |
string |
Curva elíptica. |
EC-HSM |
string |
Curva elíptica com uma chave privada que é armazenada no HSM. |
RSA |
string |
|
RSA-HSM |
string |
RSA com uma chave privada que é armazenada no HSM. |
oct |
string |
Sequência de octeto (usada para representar chaves simétricas) |
oct-HSM |
string |
Sequência de octeto (usada para representar chaves simétricas) que é armazenada no HSM. |
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 |
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. |
KeyBundle
Um KeyBundle que consiste em uma WebKey mais seus atributos.
Nome | Tipo | Description |
---|---|---|
attributes |
Os atributos de gerenciamento de chaves. |
|
key |
A chave da Web Json. |
|
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. |
release_policy |
As regras de política sob as quais a chave pode ser exportada. |
|
tags |
object |
Metadados específicos do aplicativo na forma de pares chave-valor. |
KeyReleasePolicy
As regras de política sob as quais a chave pode ser exportada.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
contentType |
string |
application/json; charset=utf-8 |
Tipo de conteúdo e versão da política de lançamento de chave |
data |
string |
Codificação de blob das regras de política sob as quais a chave pode ser liberada. O blob deve ser codificado na URL base64. |
|
immutable |
boolean |
Define o estado de mutabilidade da política. Depois de marcado como imutável, esse sinalizador não pode ser redefinido e a política não pode ser alterada em nenhuma circunstância. |
KeyVaultError
A exceção de erro do cofre de chaves.
Nome | Tipo | Description |
---|---|---|
error |
O erro do servidor do cofre de chaves. |