Get Deleted Secret - Get Deleted Secret
Získá zadaný odstraněný tajný klíč.
Operace Získat odstraněný tajný kód vrátí zadaný odstraněný tajný klíč spolu s jeho atributy. Tato operace vyžaduje tajné kódy nebo oprávnění získat.
GET {vaultBaseUrl}/deletedsecrets/{secret-name}?api-version=7.4
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
secret-name
|
path | True |
string |
Název tajného kódu. |
vault
|
path | True |
string |
Název trezoru, například https://myvault.vault.azure.net. |
api-version
|
query | True |
string |
Verze klientského rozhraní API |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Tajný svazek tajného kódu a jeho atributů. |
|
Other Status Codes |
Key Vault chybovou odpověď popisující příčinu selhání operace. |
Příklady
GetDeletedSecret
Sample Request
GET https://myvault.vault.azure.net//deletedsecrets/GetDeletedSecretTest?api-version=7.4
Sample Response
{
"recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
"deletedDate": 1493938433,
"scheduledPurgeDate": 1501714433,
"id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
"attributes": {
"enabled": true,
"created": 1493938433,
"updated": 1493938433,
"recoveryLevel": "Recoverable+Purgeable"
}
}
Definice
Name | Description |
---|---|
Deleted |
Odstraněný tajný klíč, který se skládá z jeho předchozího ID, atributů a značek a také informací o tom, kdy se vyprázdní. |
Deletion |
Odráží úroveň obnovení odstranění, která aktuálně platí pro tajné kódy v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může být tajný kód trvale odstraněn uživatelem s oprávněním; V opačném případě může tajný kód na konci intervalu uchovávání vyprázdnit pouze systém. |
Error |
Chyba serveru trezoru klíčů. |
Key |
Výjimka chyby trezoru klíčů |
Secret |
Atributy správy tajných kódů. |
DeletedSecretBundle
Odstraněný tajný klíč, který se skládá z jeho předchozího ID, atributů a značek a také informací o tom, kdy se vyprázdní.
Name | Typ | Description |
---|---|---|
attributes |
Atributy správy tajných kódů. |
|
contentType |
string |
Typ obsahu tajného kódu. |
deletedDate |
integer |
Čas odstranění tajného kódu v UTC |
id |
string |
ID tajného kódu. |
kid |
string |
Pokud se jedná o tajný kód, který je součástí certifikátu KV, pak toto pole určuje odpovídající klíč, který slouží jako záložní certifikát KV. |
managed |
boolean |
Hodnota True, pokud životnost tajného klíče spravuje trezor klíčů. Pokud se jedná o tajný kód, který certifikát zazálohuje, bude mít spravovaná hodnota true. |
recoveryId |
string |
Adresa URL objektu obnovení, která slouží k identifikaci a obnovení odstraněného tajného kódu. |
scheduledPurgeDate |
integer |
Čas, kdy je naplánováno vymazání tajného kódu ve standardu UTC |
tags |
object |
Metadata specifická pro aplikaci ve formě párů klíč-hodnota. |
value |
string |
Hodnota tajného klíče. |
DeletionRecoveryLevel
Odráží úroveň obnovení odstranění, která aktuálně platí pro tajné kódy v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může být tajný kód trvale odstraněn uživatelem s oprávněním; V opačném případě může tajný kód 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. vymazá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, pokud je 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. vymazání při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není požadována operace vyprázdnění nebo pokud není zrušeno předplatné. |
Purgeable |
string |
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 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 v době, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud není obnovený. |
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. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho po 90 dnech trvale odstraní, pokud není obnovený. |
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. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud není požadována operace vyprázdnění nebo pokud není předplatné zrušeno. Systém ho po 90 dnech trvale odstraní, pokud není obnovený. |
Error
Chyba serveru trezoru klíčů.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby |
innererror |
Chyba serveru trezoru klíčů. |
|
message |
string |
Chybová zpráva |
KeyVaultError
Výjimka chyby trezoru klíčů
Name | Typ | Description |
---|---|---|
error |
Chyba serveru trezoru klíčů. |
SecretAttributes
Atributy správy tajných kódů.
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. |
nbf |
integer |
Není před datem v UTC. |
recoverableDays |
integer |
softDelete data retention days. Hodnota by měla být >=7 a <=90, pokud je povolená funkce softDelete, jinak 0. |
recoveryLevel |
Odráží úroveň obnovení odstranění, která aktuálně platí pro tajné kódy v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může být tajný kód trvale odstraněn uživatelem s oprávněním; V opačném případě může tajný kód na konci intervalu uchovávání vyprázdnit pouze systém. |
|
updated |
integer |
Čas poslední aktualizace v UTC. |