Get Deleted Keys - Get Deleted Keys

Referência

Serviço:: Key Vault

Versão da API:: 7.4

Listas as chaves eliminadas no cofre especificado.
Obtém uma lista das chaves no Key Vault como estruturas de Chave Web JSON que contêm a parte pública de uma chave eliminada. Esta operação inclui informações específicas de eliminação. A operação Obter Chaves Eliminadas é aplicável aos cofres ativados para eliminação recuperável. Embora a operação possa ser invocada em qualquer cofre, devolverá um erro se for invocada num cofre não ativado para eliminação recuperável. Esta operação requer a permissão de chaves/lista.

GET {vaultBaseUrl}/deletedkeys?api-version=7.4

Com parâmetros opcionais:

GET {vaultBaseUrl}/deletedkeys?maxresults={maxresults}&api-version=7.4

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
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.
maxresults	query		integer int32	Número máximo de resultados a devolver numa página. Se não for especificado, o serviço devolverá até 25 resultados.

Respostas

Name	Tipo	Description
200 OK	DeletedKeyListResult	Uma mensagem de resposta que contém uma lista de chaves eliminadas no cofre juntamente com uma ligação para a página seguinte das chaves eliminadas.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

GetDeletedKeys

Pedido de amostra

HTTP

GET https://myvault.vault.azure.net//deletedkeys?maxresults=1&api-version=7.4

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedkeys/listdeletedkeytest0",
      "deletedDate": 1493938031,
      "scheduledPurgeDate": 1501714031,
      "kid": "https://myvault.vault.azure.net/keys/listdeletedkeytest0",
      "attributes": {
        "enabled": true,
        "created": 1493938031,
        "updated": 1493938031,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedkeys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Definições

Name	Description
DeletedKeyItem	O item de chave eliminado que contém os metadados de chave eliminados e informações sobre a eliminação.
DeletedKeyListResult	Uma lista de chaves que foram eliminadas neste cofre.
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.
KeyAttributes	Os atributos de uma chave gerida pelo serviço key vault.
KeyVaultError	A exceção de erro do cofre de chaves.

DeletedKeyItem

O item de chave eliminado que contém os metadados de chave eliminados e informações sobre a 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
kid	string	Identificador de chave.
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.
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.

DeletedKeyListResult

Uma lista de chaves que foram eliminadas neste cofre.

Name	Tipo	Description
nextLink	string	O URL para obter o próximo conjunto de chaves eliminadas.
value	DeletedKeyItem[]	Uma mensagem de resposta que contém uma lista de chaves eliminadas no cofre juntamente com uma ligação para a página seguinte de chaves eliminadas

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.

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.

KeyVaultError

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

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

Partilhar via