Get Key Versions - Get Key Versions

Referência

Serviço:: Key Vault

Versão da API:: 7.4

Obtém uma lista de versões de chaves individuais com o mesmo nome de chave.
O identificador de chave completo, atributos e etiquetas são fornecidos na resposta. Esta operação requer a permissão de chaves/lista.

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

Com parâmetros opcionais:

GET {vaultBaseUrl}/keys/{key-name}/versions?maxresults={maxresults}&api-version=7.4

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
key-name	path	True	string	O nome da chave.
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	KeyListResult	Uma mensagem de resposta que contém uma lista de chaves juntamente com uma ligação para a página seguinte de chaves.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

GetKeyVersions

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/listkeyversionstest/7c9dc6775d0e4177827c4f98f482fc12",
      "attributes": {
        "enabled": true,
        "created": 1493937851,
        "updated": 1493937851,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys/listkeyversionstest/versions?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVTMFZaVmtWU1UwbFBUbE5VUlZOVUwwRXdPRUZDUVVVNE1UZ3pNalF5TVRsQ05EUXpPREZFTWpoRVJURkdSVEJESVRBd01EQXlPQ0U1T1RrNUxURXlMVE14VkRJek9qVTVPalU1TGprNU9UazVPVGxhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

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.
KeyAttributes	Os atributos de uma chave gerida pelo serviço key vault.
KeyItem	O item-chave que contém metadados chave.
KeyListResult	O resultado da lista de chaves.
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.

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.

KeyItem

O item-chave que contém metadados chave.

Name	Tipo	Description
attributes	KeyAttributes	Os atributos de gestão de chaves.
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.
tags	object	Metadados específicos da aplicação na forma de pares chave-valor.

KeyListResult

O resultado da lista de chaves.

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

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