Get Key Versions - Get Key Versions

Reference

Service:: Key Vault

API Version:: 7.4

Načte seznam jednotlivých verzí klíčů se stejným názvem klíče.
V odpovědi jsou uvedeny úplné identifikátory klíče, atributy a značky. Tato operace vyžaduje oprávnění ke klíčům nebo seznamu.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
key-name	path	True	string	Název klíče.
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze rozhraní API klienta.
maxresults	query		integer int32	Maximální počet výsledků, které se mají na stránce vrátit Pokud ho nezadáte, vrátí služba až 25 výsledků.

Odpovědi

Name	Typ	Description
200 OK	KeyListResult	Zpráva odpovědi obsahující seznam klíčů spolu s odkazem na další stránku klíčů.
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující, proč operace selhala.

Příklady

GetKeyVersions

Sample Request

HTTP

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

Sample Response

Status code:: 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"
}

Definice

Name	Description
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Purgeable", může být klíč trvale odstraněn uživatelem s oprávněním; v opačném případě může klíč na konci intervalu uchovávání vyprázdnit pouze systém.
Error	Chyba serveru trezoru klíčů.
KeyAttributes	Atributy klíče spravovaného službou trezoru klíčů.
KeyItem	Položka klíče obsahující metadata klíčů.
KeyListResult	Výsledek seznamu klíčů
KeyVaultError	Výjimka chyby trezoru klíčů

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Purgeable", může být klíč trvale odstraněn uživatelem s oprávněním; v opačném případě může klíč na konci intervalu uchovávání vyprázdnit pouze systém.

Name	Typ	Description
CustomizedRecoverable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription	string	Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, když 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.
CustomizedRecoverable+Purgeable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není vyžadována operace vyprázdnění nebo se nezruší předplatné.
Purgeable	string	Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá žádné ochraně není k dispozici proti operaci Odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde k nenávratné ztrátě dat.
Recoverable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a po dobu, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Recoverable+ProtectedSubscription	string	Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vyprázdnění) není povoleno a ve kterém nelze trvale zrušit samotné předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví
Recoverable+Purgeable	string	Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud se nevyžádá operace vyprázdnění nebo se nezruší předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví

Error

Chyba serveru trezoru klíčů.

Name	Typ	Description
code	string	Kód chyby
innererror	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva

KeyAttributes

Atributy klíče spravovaného službou trezoru klíčů.

Name	Typ	Description
created	integer	Čas vytvoření ve standardu UTC
enabled	boolean	Určuje, zda je objekt povolen.
exp	integer	Datum vypršení platnosti v UTC.
exportable	boolean	Určuje, jestli je možné privátní klíč exportovat. Při vytváření první verze exportovatelného klíče je potřeba zadat zásady vydané verze.
nbf	integer	Není před datem ve standardu UTC.
recoverableDays	integer	softDelete data retention days. Pokud je povolená funkce softDelete, hodnota by měla být >=7 a <=90, jinak 0.
recoveryLevel	DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která aktuálně platí pro klíče v aktuálním trezoru. Pokud obsahuje "Purgeable", může být klíč trvale odstraněn uživatelem s oprávněním; v opačném případě může klíč na konci intervalu uchovávání vyprázdnit pouze systém.
updated	integer	Čas poslední aktualizace v UTC.

KeyItem

Položka klíče obsahující metadata klíčů.

Name	Typ	Description
attributes	KeyAttributes	Atributy správy klíčů.
kid	string	Identifikátor klíče.
managed	boolean	Hodnota True, pokud je životnost klíče spravovaná trezorem klíčů. Pokud se jedná o klíč, který zálohuje certifikát, bude spravovaná hodnota true.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

KeyListResult

Výsledek seznamu klíčů

Name	Typ	Description
nextLink	string	Adresa URL pro získání další sady klíčů
value	KeyItem[]	Zpráva odpovědi obsahující seznam klíčů v trezoru klíčů spolu s odkazem na další stránku klíčů.

KeyVaultError

Výjimka chyby trezoru klíčů

Name	Typ	Description
error	Error	Chyba serveru trezoru klíčů.

Sdílet prostřednictvím