Update Secret - Update Secret

Odwołanie

Service:: Key Vault

API Version:: 7.4

Aktualizacje atrybuty skojarzone z określonym wpisem tajnym w danym magazynie kluczy.
Operacja UPDATE zmienia określone atrybuty istniejącego przechowywanego wpisu tajnego. Atrybuty, które nie są określone w żądaniu, pozostają niezmienione. Nie można zmienić wartości samego wpisu tajnego. Ta operacja wymaga uprawnień wpisów tajnych/zestawu.

PATCH {vaultBaseUrl}/secrets/{secret-name}/{secret-version}?api-version=7.4

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
secret-name	path	True	string	Nazwa wpisu tajnego.
secret-version	path	True	string	Wersja wpisu tajnego.
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Typ	Opis
attributes	SecretAttributes	Atrybuty zarządzania wpisami tajnymi.
contentType	string	Typ wartości wpisu tajnego, na przykład hasło.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SecretBundle	Zaktualizowany wpis tajny.
Other Status Codes	KeyVaultError	Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

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"
  }
}

Definicje

Nazwa	Opis
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
Error	Błąd serwera magazynu kluczy.
KeyVaultError	Wyjątek błędu magazynu kluczy.
SecretAttributes	Atrybuty zarządzania wpisami tajnymi.
SecretBundle	Wpis tajny składający się z wartości, identyfikatora i jego atrybutów.
SecretUpdateParameters	Parametry aktualizacji wpisu tajnego.

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.

Nazwa	Typ	Opis
CustomizedRecoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7< = SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.
CustomizedRecoverable+ProtectedSubscription	string	Oznacza, że magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7< = SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.
CustomizedRecoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7< = SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana.
Purgeable	string	Określa stan magazynu, w którym usunięcie jest operacją nieodwracalną, bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuwania na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
Recoverable	string	Określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
Recoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w okresie przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
Recoverable+Purgeable	string	Określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany

Error

Błąd serwera magazynu kluczy.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	Error	Błąd serwera magazynu kluczy.
message	string	Komunikat o błędzie.

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa	Typ	Opis
error	Error	Błąd serwera magazynu kluczy.

SecretAttributes

Atrybuty zarządzania wpisami tajnymi.

Nazwa	Typ	Opis
created	integer	Czas utworzenia w formacie UTC.
enabled	boolean	Określa, czy obiekt jest włączony.
exp	integer	Data wygaśnięcia w formacie UTC.
nbf	integer	Nie wcześniej niż data w formacie UTC.
recoverableDays	integer	softDelete data retention days (dni przechowywania danych softDelete). Wartość powinna mieć >wartość =7 i <=90, gdy funkcja softDelete jest włączona, w przeciwnym razie 0.
recoveryLevel	DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
updated	integer	Czas ostatniej aktualizacji w formacie UTC.

SecretBundle

Wpis tajny składający się z wartości, identyfikatora i jego atrybutów.

Nazwa	Typ	Opis
attributes	SecretAttributes	Atrybuty zarządzania wpisami tajnymi.
contentType	string	Typ zawartości wpisu tajnego.
id	string	Identyfikator wpisu tajnego.
kid	string	Jeśli jest to wpis tajny kopii zapasowej certyfikatu KV, to pole określa odpowiedni klucz kopii zapasowej certyfikatu KV.
managed	boolean	Wartość true, jeśli okres istnienia wpisu tajnego jest zarządzany przez magazyn kluczy. Jeśli jest to wpis tajny kopii zapasowej certyfikatu, zarządzane będzie mieć wartość true.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.
value	string	Wartość wpisu tajnego.

SecretUpdateParameters

Parametry aktualizacji wpisu tajnego.

Nazwa	Typ	Opis
attributes	SecretAttributes	Atrybuty zarządzania wpisami tajnymi.
contentType	string	Typ wartości wpisu tajnego, na przykład hasło.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.