Get Secret - Get Secret

Reference

Service:: Key Vault

API Version:: 7.4

Získejte zadaný tajný kód z daného trezoru klíčů.
Operace GET se vztahuje na všechny tajné kódy uložené v Azure Key Vault. Tato operace vyžaduje tajné kódy nebo oprávnění získat.

GET {vaultBaseUrl}/secrets/{secret-name}/{secret-version}?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.
secret-version	path	True	string	Verze tajného kódu. Tento fragment identifikátoru URI je nepovinný. Pokud není zadaný, vrátí se nejnovější verze tajného kódu.
vaultBaseUrl	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	SecretBundle	Načtený tajný kód.
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující příčinu selhání operace.

Příklady

GetSecret

Sample Request

HTTP

GET https://myvault.vault.azure.net//secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79?api-version=7.4

Sample Response

Status code:: 200

{
  "value": "mysecretvalue",
  "id": "https://myvault.vault.azure.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79",
  "attributes": {
    "enabled": true,
    "created": 1493938410,
    "updated": 1493938410,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definice

Name	Description
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.
Error	Chyba serveru trezoru klíčů.
KeyVaultError	Výjimka chyby trezoru klíčů
SecretAttributes	Atributy správy tajných kódů.
SecretBundle	Tajný kód sestávající z hodnoty, ID a jejích atributů.

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	Error	Chyba serveru trezoru klíčů.
message	string	Chybová zpráva

KeyVaultError

Výjimka chyby trezoru klíčů

Name	Typ	Description
error	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	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.
updated	integer	Čas poslední aktualizace v UTC.

SecretBundle

Tajný kód sestávající z hodnoty, ID a jejích atributů.

Name	Typ	Description
attributes	SecretAttributes	Atributy správy tajných kódů.
contentType	string	Typ obsahu tajného kódu.
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.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.
value	string	Hodnota tajného klíče.

Share via