Partilhar via

Recover Deleted Key - Recover Deleted Key

  • Referência
Serviço:
Key Vault
Versão da API:
7.4

Recupera a chave eliminada para a versão mais recente.
A operação Recuperar Chave Eliminada é aplicável a chaves eliminadas em cofres com eliminação recuperável ativada. Recupera a chave eliminada novamente para a versão mais recente em /keys. Uma tentativa de recuperar uma chave não eliminada irá devolver um erro. Considere isto o inverso da operação de eliminação em cofres com eliminação recuperável ativada. Esta operação requer as chaves/permissão de recuperação.

POST {vaultBaseUrl}/deletedkeys/{key-name}/recover?api-version=7.4

Parâmetros do URI

Name Em Necessário Tipo Description
key-name
 path True

string

O nome da chave eliminada.
vaultBaseUrl
 path True

string

O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version
 query True

string

Versão da API de Cliente.

Respostas

Name Tipo Description
200 OK

KeyBundle

Um pacote chave da chave original e os respetivos atributos
Other Status Codes

KeyVaultError

Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

RecoverDeletedKey

Pedido de amostra

POST https://myvault.vault.azure.net//deletedkeys/CreateDeleteRecoverPurgeTest/recover?api-version=7.4

Resposta da amostra

Código de estado:
200 
{
  "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

Name Description
DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para chaves no cofre atual. Se contiver "Removível", a chave pode ser eliminada permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover a chave, no final do intervalo de retenção.
Error

O erro do servidor do cofre de chaves.
JsonWebKey

A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName

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

JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes

Os atributos de uma chave gerida pelo serviço key vault.
KeyBundle

Um KeyBundle que consiste numa WebKey mais os respetivos atributos.
KeyReleasePolicy

As regras de política sob as quais a chave pode ser exportada.
KeyVaultError

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

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para chaves no cofre atual. Se contiver "Removível", a chave pode ser eliminada permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover a chave, no final do intervalo de retenção.

Name Tipo Description
CustomizedRecoverable

string

Indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e enquanto a subscrição ainda está disponível.
CustomizedRecoverable+ProtectedSubscription

string

Indica um cofre e estado de subscrição no qual a eliminação é recuperável, imediata e permanente (ou seja, remoção) não é permitida e em que a subscrição em si não pode ser cancelada permanentemente quando 7<= SoftDeleteRetentionInDays < 90. Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção e também reflete o facto de a própria subscrição não poder ser cancelada.
CustomizedRecoverable+Purgeable

string

Indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remover quando 7<= SoftDeleteRetentionInDays < 90). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção, a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada.
Purgeable

string

Indica um estado do cofre em que a eliminação é uma operação irreversível, sem a possibilidade de recuperação. Este nível não corresponde a nenhuma proteção disponível numa operação Eliminar; os dados são irremediavelmente perdidos ao aceitar uma operação Delete ao nível da entidade ou superior (cofre, grupo de recursos, subscrição, etc.)
Recoverable

string

Indica um estado do cofre no qual a eliminação é recuperável sem a possibilidade de eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias) e enquanto a subscrição ainda está disponível. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recoverable+ProtectedSubscription

string

Indica um estado do cofre e da subscrição em que a eliminação é recuperável dentro do intervalo de retenção (90 dias), a eliminação imediata e permanente (ou seja, remoção) não é permitida e na qual a subscrição em si não pode ser cancelada permanentemente. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado
Recoverable+Purgeable

string

Indica um estado do cofre no qual a eliminação é recuperável e que também permite a eliminação imediata e permanente (ou seja, remoção). Este nível garante a capacidade de recuperação da entidade eliminada durante o intervalo de retenção (90 dias), a menos que seja pedida uma operação de Remoção ou a subscrição seja cancelada. O sistema irá eliminá-lo permanentemente após 90 dias, se não for recuperado

Error

O erro do servidor do cofre de chaves.

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.

JsonWebKey

A partir de http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name Tipo Description
crv

JsonWebKeyCurveName

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

string

Expoente privado RSA ou o componente D de uma chave privada 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, utilizada com "Bring Your Own Key".
key_ops

string[]

Operações principais suportadas.
kid

string

Identificador de chave.
kty

JsonWebKeyType

JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n

string

Módulo RSA.
p

string

RSA secret prime.
q

string

RSA secret prime, com 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 EC.

JsonWebKeyCurveName

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

Name 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

JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name Tipo Description
EC

string

Curva elíptica.
EC-HSM

string

Curva Elíptica com uma chave privada armazenada no HSM.
RSA

string

RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM

string

RSA com uma chave privada armazenada no HSM.
oct

string

Sequência de octetos (utilizada para representar chaves simétricas)
oct-HSM

string

Sequência de octetos (utilizada para representar chaves simétricas) que é armazenada no HSM.

KeyAttributes

Os atributos de uma chave gerida pelo serviço key vault.

Name Tipo Description
created

integer

Tempo de criação em UTC.
enabled

boolean

Determina se o objeto está ativado.
exp

integer

Data de expiração em UTC.
exportable

boolean

Indica se a chave privada pode ser exportada. A política de versão tem de 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 data retention days. O valor deve ser >=7 e <=90 quando softDelete ativado, caso contrário 0.
recoveryLevel

DeletionRecoveryLevel

Reflete o nível de recuperação de eliminação atualmente em vigor para chaves no cofre atual. Se contiver "Removível", a chave pode ser eliminada permanentemente por um utilizador com privilégios; caso contrário, apenas o sistema pode remover a chave, no final do intervalo de retenção.
updated

integer

Hora da última atualização em UTC.

KeyBundle

Um KeyBundle que consiste numa WebKey mais os respetivos atributos.

Name Tipo Description
attributes

KeyAttributes

Os atributos de gestão de chaves.
key

JsonWebKey

A chave Web Json.
managed

boolean

Verdadeiro se a duração da chave for gerida pelo cofre de chaves. Se esta for uma chave que suporta um certificado, a gestão será verdadeira.
release_policy

KeyReleasePolicy

As regras de política sob as quais a chave pode ser exportada.
tags

object

Metadados específicos da aplicação na forma de pares chave-valor.

KeyReleasePolicy

As regras de política sob as quais a chave pode ser exportada.

Name Tipo Default value Description
contentType

string

application/json; charset=utf-8

Tipo de conteúdo e versão da política de lançamento de chaves
data

string

Codificar blobs com as regras de política nas quais a chave pode ser lançada. O blob tem de ter codificação de URL base64.
immutable

boolean

Define o estado de mutabilidade da política. Depois de marcado como imutável, este sinalizador não pode ser reposto e a política não pode ser alterada em nenhuma circunstância.

KeyVaultError

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

Name Tipo Description
error

Error

O erro do servidor do cofre de chaves.