Partilhar via

Delete Key - Delete Key

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

Elimina uma chave de qualquer tipo do armazenamento no Azure Key Vault.
Não é possível utilizar a operação eliminar chave para remover versões individuais de uma chave. Esta operação remove o material criptográfico associado à chave, o que significa que a chave não é utilizável para operações Assinar/Verificar, Moldar/Desembrulhar ou Encriptar/Desencriptar. Esta operação requer as chaves/permissão de eliminação.

DELETE {vaultBaseUrl}/keys/{key-name}?api-version=7.4

Parâmetros do URI

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

string

O nome da chave a eliminar.
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

DeletedKeyBundle

A parte pública da chave eliminada e as informações de eliminação sobre quando a chave será removida.
Other Status Codes

KeyVaultError

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

Exemplos

Delete key

Pedido de amostra

DELETE https://myvault.vault.azure.net//keys/CreateSoftKeyTest?api-version=7.4

Resposta da amostra

Código de estado:
200 
{
  "recoveryId": "https://myvault.vault.azure.net/deletedkeys/CreateSoftKeyTest",
  "deletedDate": 1493942452,
  "scheduledPurgeDate": 1501718452,
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Definições

Name Description
DeletedKeyBundle

Um DeletedKeyBundle composto por uma WebKey e as respetivas informações de Atributos e eliminação
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.
KeyReleasePolicy

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

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

DeletedKeyBundle

Um DeletedKeyBundle composto por uma WebKey e as respetivas informações de Atributos e eliminação

Name Tipo Description
attributes

KeyAttributes

Os atributos de gestão de chaves.
deletedDate

integer

A hora em que a chave foi eliminada, em UTC
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.
recoveryId

string

O URL do objeto de recuperação, utilizado para identificar e recuperar a chave eliminada.
release_policy

KeyReleasePolicy

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

integer

A hora em que a chave está agendada para ser removida, em UTC
tags

object

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

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.

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.