Sdílet prostřednictvím

Get Deleted Keys - Get Deleted Keys

  • Reference
Služba:
Key Vault
Verze rozhraní API:
7.4

Zobrazí seznam odstraněných klíčů v zadaném trezoru.
Načte seznam klíčů ve službě Key Vault jako struktury webového klíče JSON, které obsahují veřejnou část odstraněného klíče. Tato operace zahrnuje informace specifické pro odstranění. Operace Získat odstraněné klíče je použitelná pro trezory s povoleným obnovitelném odstraněním. I když je možné operaci vyvolat v jakémkoli trezoru, vrátí chybu, pokud je vyvolána v trezoru s povoleným nepovoleným odstraněním. Tato operace vyžaduje oprávnění klíče nebo seznamu.

GET {vaultBaseUrl}/deletedkeys?api-version=7.4
S volitelnými parametry: 
GET {vaultBaseUrl}/deletedkeys?maxresults={maxresults}&api-version=7.4

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
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)

minimum: 1
maximum: 25

Maximální počet výsledků, které se mají vrátit na stránce Pokud není zadáno, služba vrátí až 25 výsledků.

Odpovědi

Name Typ Description
200 OK

DeletedKeyListResult

Zpráva odpovědi obsahující seznam odstraněných klíčů v trezoru spolu s odkazem na další stránku odstraněných klíčů.
Other Status Codes

KeyVaultError

Odpověď na chybu služby Key Vault popisující, proč operace selhala.

Příklady

GetDeletedKeys

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}

Definice

Name Description
DeletedKeyItem

Odstraněná položka klíče obsahující metadata odstraněného klíče a informace o odstranění.
DeletedKeyListResult

Seznam klíčů, které byly odstraněny v tomto trezoru.
DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která je aktuálně platná pro klíče v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může klíč trvale odstranit privilegovaný uživatel; v opačném případě může klíč vyprázdnit pouze systém na konci intervalu uchovávání informací.
Error

Chyba serveru trezoru klíčů.
KeyAttributes

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

Výjimka chyby trezoru klíčů.

DeletedKeyItem

Objekt

Odstraněná položka klíče obsahující metadata odstraněného klíče a informace o odstranění.

Name Typ Description
attributes

KeyAttributes

Atributy správy klíčů.
deletedDate

integer (unixtime)

Čas odstranění klíče v UTC
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.
recoveryId

string

Adresa URL objektu obnovení, která slouží k identifikaci a obnovení odstraněného klíče.
scheduledPurgeDate

integer (unixtime)

Čas, kdy je naplánováno vymazání klíče v UTC
tags

object

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

DeletedKeyListResult

Objekt

Seznam klíčů, které byly odstraněny v tomto trezoru.

Name Typ Description
nextLink

string

Adresa URL pro získání další sady odstraněných klíčů.
value

DeletedKeyItem[]

Zpráva odpovědi obsahující seznam odstraněných klíčů v trezoru spolu s odkazem na další stránku odstraněných klíčů

DeletionRecoveryLevel

Výčet

Odráží úroveň obnovení odstranění, která je aktuálně platná pro klíče v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může klíč trvale odstranit privilegovaný uživatel; v opačném případě může klíč vyprázdnit pouze systém na konci intervalu uchovávání informací.

Hodnota Description
CustomizedRecoverable

Označuje stav trezoru, ve kterém je odstranění možné obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání, když 7<= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a v době, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription

Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vyprázdnění) 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 také odráží skutečnost, že samotné předplatné nelze zrušit.
CustomizedRecoverable+Purgeable

Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vymazání, když 7<= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší.
Purgeable

Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde ke ztrátě dat.
Recoverable

Označuje stav trezoru, ve kterém se odstranění dá obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví.
Recoverable+ProtectedSubscription

Označuje stav trezoru a předplatného, ve kterém je odstranění možné obnovit v intervalu uchovávání (90 dnů), okamžitém a trvalém odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví.
Recoverable+Purgeable

Označuje stav trezoru, ve kterém je odstranění obnovitelné, a umožňuje také okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů), pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví.

Error

Objekt

Chyba serveru trezoru klíčů.

Name Typ Description
code

string

Kód chyby.
innererror

Error

Chyba serveru trezoru klíčů.
message

string

Chybová zpráva.

KeyAttributes

Objekt

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

Name Typ Description
created

integer (unixtime)

Čas vytvoření ve standardu UTC
enabled

boolean

Určuje, zda je objekt povolen.
exp

integer (unixtime)

Datum vypršení platnosti v UTC.
exportable

boolean

Označuje, jestli je možné privátní klíč exportovat. Při vytváření první verze exportovatelného klíče je nutné zadat zásady vydané verze.
nbf

integer (unixtime)

Ne před datem v UTC.
recoverableDays

integer (int32)

softDelete data retention days. Hodnota by měla být >=7 a <=90, pokud je povolený softDelete, jinak 0.
recoveryLevel

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která je aktuálně platná pro klíče v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může klíč trvale odstranit privilegovaný uživatel; v opačném případě může klíč vyprázdnit pouze systém na konci intervalu uchovávání informací.
updated

integer (unixtime)

Čas poslední aktualizace ve standardu UTC

KeyVaultError

Objekt

Výjimka chyby trezoru klíčů.

Name Typ Description
error

Error

Chyba serveru trezoru klíčů.