Update Secret - Update Secret

Reference

Service:: Key Vault

API Version:: 7.4

Aktualizace atributy přidružené k zadanému tajnému klíči v daném trezoru klíčů.
Operace UPDATE změní zadané atributy existujícího uloženého tajného klíče. Atributy, které nejsou v požadavku zadány, zůstanou beze změny. Hodnotu samotného tajného kódu nelze změnit. Tato operace vyžaduje oprávnění k tajným kódům nebo nastavení.

PATCH {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.
vaultBaseUrl	path	True	string	Název trezoru, například https://myvault.vault.azure.net.
api-version	query	True	string	Verze rozhraní API klienta.

Text požadavku

Name	Typ	Description
attributes	SecretAttributes	Atributy správy tajných kódů.
contentType	string	Typ hodnoty tajného kódu, například heslo.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

Odpovědi

Name	Typ	Description
200 OK	SecretBundle	Aktualizovaný tajný kód.
Other Status Codes	KeyVaultError	Key Vault chybovou odpověď popisující, proč operace selhala.

Příklady

UpdateSecret

Sample Request

HTTP

PATCH https://myvault.vault.azure.net//secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441?api-version=7.4

{
  "tags": {
    "mytag": "myvalue"
  },
  "contentType": "myContentType",
  "attributes": {
    "enabled": true
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/secrets/crpsecret/03bcccc7c8cf4546a0e3e21e52560441",
  "contentType": "myContentType",
  "attributes": {
    "enabled": true,
    "created": 1493938459,
    "updated": 1493938459,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "mytag": "myvalue"
  }
}

Definice

Name	Description
DeletionRecoveryLevel	Odráží úroveň obnovení odstranění, která se aktuálně používá pro tajné kódy v aktuálním trezoru. Pokud obsahuje "Purgeable", tajný kód může být trvale odstraněn privilegovaným uživatelem; 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 skládající se z hodnoty, id a jejích atributů.
SecretUpdateParameters	Parametry aktualizace tajného kódu.

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která se aktuálně používá pro tajné kódy v aktuálním trezoru. Pokud obsahuje "Purgeable", tajný kód může být trvale odstraněn privilegovaným uživatelem; 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. 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

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 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á se aktuálně používá pro tajné kódy v aktuálním trezoru. Pokud obsahuje "Purgeable", tajný kód může být trvale odstraněn privilegovaným uživatelem; 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 skládající se 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ý zálohuje certifikát KV, určuje toto pole odpovídající klíč, který certifikát KV zálohuje.
managed	boolean	Hodnota True, pokud životnost tajného klíče spravuje trezor klíčů. Pokud se jedná o tajný kód, který certifikát zálohuje, bude spravovaná hodnota true.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.
value	string	Hodnota tajného kódu.

SecretUpdateParameters

Parametry aktualizace tajného kódu.

Name	Typ	Description
attributes	SecretAttributes	Atributy správy tajných kódů.
contentType	string	Typ hodnoty tajného kódu, například heslo.
tags	object	Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

Share via