Update Key - Update Key

Odwołanie

Service:: Key Vault

API Version:: 7.4

Operacja klucza aktualizacji zmienia określone atrybuty przechowywanego klucza i może być stosowana do dowolnego typu klucza i wersji klucza przechowywanej w usłudze Azure Key Vault.
Aby wykonać tę operację, klucz musi już istnieć w Key Vault. Uwaga: nie można zmienić materiału kryptograficznego samego klucza. Ta operacja wymaga uprawnień kluczy/aktualizacji.

PATCH {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
key-name	path	True	string	Nazwa klucza do zaktualizowania.
key-version	path	True	string	Wersja klucza do zaktualizowania.
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	KeyAttributes	Atrybuty klucza zarządzanego przez usługę magazynu kluczy.
key_ops	JsonWebKeyOperation[]	Operacje klucza internetowego w formacie Json. Aby uzyskać więcej informacji na temat możliwych operacji klucza, zobacz JsonWebKeyOperation.
release_policy	KeyReleasePolicy	Reguły zasad, w ramach których można wyeksportować klucz.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KeyBundle	Zaktualizowany klucz.
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

Update key

Sample Request

HTTP

PATCH https://myvault.vault.azure.net//keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088?api-version=7.4

{
  "key_ops": [
    "decrypt",
    "encrypt"
  ],
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800
  }
}

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/UpdateKeyAttributesTest/3d31e6e5c4c14eaf9be8d42c00225088",
    "kty": "RSA",
    "key_ops": [
      "decrypt",
      "encrypt"
    ],
    "n": "tHCSyq1FqGHXIFHs1m4riKYgPFNSTlJGPzxwfUyZJUxxZsFWMxmZRzbM3kcXC5N40AJfeqDOMs0gY0LZEfhw8kJHBf2GEH2Sz923E4OQjLk_ECdAiKPW_8t22cqD_pGIuB7uibjLZgFFRv7oe0t8cTXKn7IwAH5gQBLs8NNV7hx1Ozy82ekCgOovFldmD3c3P1oZQ_v_-jOP6O202aEfDcZut42J6zI8eYwvGiDKmo2fCPPeth1LYBOeUMnrEZGT_f_w3yAgqvuSkHCL0x4MjZzc2EoNI_3ooAHZohDaPHLRfz8neDPADZzbHA6SDn3GgvC1K_Je5GBmqjTH3aIMlw",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": false,
    "nbf": 631180800,
    "exp": 662716800,
    "created": 1493860275,
    "updated": 1493860277,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

Definicje

Nazwa	Opis
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla kluczy w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", klucz może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić klucz na końcu interwału przechowywania.
Error	Błąd serwera magazynu kluczy.
JsonWebKey	Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.
JsonWebKeyOperation
JsonWebKeyType	Typ klucza JsonWebKey (kty), zgodnie z definicją w pliku https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	Atrybuty klucza zarządzanego przez usługę magazynu kluczy.
KeyBundle	KluczBundle składający się z elementu WebKey i jego atrybutów.
KeyReleasePolicy	Reguły zasad, w ramach których można wyeksportować klucz.
KeyUpdateParameters	Parametry aktualizacji klucza.
KeyVaultError	Wyjątek błędu magazynu kluczy.

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla kluczy w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", klucz może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić klucz 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	Określa 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 nieodwracalną operacją bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuń 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 spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane
Recoverable+ProtectedSubscription	string	Określa magazyn i stan subskrypcji, w którym usunięcie można odzyskać w interwale przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane
Recoverable+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). 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 spowoduje trwałe usunięcie go po upływie 90 dni, jeśli nie zostanie odzyskane

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.

JsonWebKey

Od http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Nazwa	Typ	Opis
crv	JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.
d	string	Prywatny wykładnik RSA lub składnik D klucza prywatnego EC.
dp	string	Parametr klucza prywatnego RSA.
dq	string	Parametr klucza prywatnego RSA.
e	string	Publiczny wykładnik RSA.
k	string	Klucz symetryczny.
key_hsm	string	Klucz chroniony używany z kluczem "Bring Your Own Key".
key_ops	string[]	Obsługiwane operacje klucza.
kid	string	Identyfikator klucza.
kty	JsonWebKeyType	Typ klucza JsonWebKey (kty), zgodnie z definicją w pliku https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	Modulus RSA.
p	string	RSA secret prime.
q	string	RSA secret prime, z p < q.
qi	string	Parametr klucza prywatnego RSA.
x	string	Składnik X klucza publicznego WE.
y	string	Składnik Y klucza publicznego WE.

JsonWebKeyCurveName

Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz JsonWebKeyCurveName.

Nazwa	Typ	Opis
P-256	string	Krzywa eliptyczna NIST P-256, krzywa AKA SECG SECP256R1.
P-256K	string	Krzywa eliptyczna SECG SECP256K1.
P-384	string	Krzywa eliptyczna NIST P-384, krzywa AKA SECG SECP384R1.
P-521	string	Krzywa eliptyczna NIST P-521, krzywa AKA SECG SECP521R1.

JsonWebKeyOperation

Nazwa	Typ	Opis
decrypt	string
encrypt	string
export	string
import	string
sign	string
unwrapKey	string
verify	string
wrapKey	string

JsonWebKeyType

Typ klucza JsonWebKey (kty), zgodnie z definicją w pliku https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Nazwa	Typ	Opis
EC	string	Krzywa eliptyczna.
EC-HSM	string	Krzywa eliptyczna z kluczem prywatnym przechowywanym w module HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RsA z kluczem prywatnym przechowywanym w module HSM.
oct	string	Sekwencja oktetu (używana do reprezentowania kluczy symetrycznych)
oct-HSM	string	Sekwencja octet (używana do reprezentowania kluczy symetrycznych), która jest przechowywana w module HSM.

KeyAttributes

Atrybuty klucza zarządzanego przez usługę magazynu kluczy.

Nazwa	Typ	Opis
created	integer	Czas tworzenia w formacie UTC.
enabled	boolean	Określa, czy obiekt jest włączony.
exp	integer	Data wygaśnięcia w formacie UTC.
exportable	boolean	Wskazuje, czy klucz prywatny można wyeksportować. Zasady wydania należy podać podczas tworzenia pierwszej wersji klucza możliwego do wyeksportowania.
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 wartość 0.
recoveryLevel	DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla kluczy w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", klucz może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić klucz na końcu interwału przechowywania.
updated	integer	Czas ostatniej aktualizacji w formacie UTC.

KeyBundle

KluczBundle składający się z elementu WebKey i jego atrybutów.

Nazwa	Typ	Opis
attributes	KeyAttributes	Atrybuty zarządzania kluczami.
key	JsonWebKey	Klucz internetowy Json.
managed	boolean	Prawda, jeśli okres istnienia klucza jest zarządzany przez magazyn kluczy. Jeśli jest to klucz kopii zapasowej certyfikatu, zarządzanie będzie prawdziwe.
release_policy	KeyReleasePolicy	Reguły zasad, w ramach których można wyeksportować klucz.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

KeyReleasePolicy

Reguły zasad, w ramach których można wyeksportować klucz.

Nazwa	Typ	Wartość domyślna	Opis
contentType	string	application/json; charset=utf-8	Typ zawartości i wersja zasad wydania klucza
data	string		Kodowanie obiektów blob reguł zasad, w ramach których można zwolnić klucz. Obiekt blob musi być zakodowany w formacie base64 URL.
immutable	boolean		Definiuje stan niezmienności zasad. Po oznaczeniu niezmiennym nie można zresetować tej flagi, a zasady nie mogą zostać zmienione w żadnym wypadku.

KeyUpdateParameters

Parametry aktualizacji klucza.

Nazwa	Typ	Opis
attributes	KeyAttributes	Atrybuty klucza zarządzanego przez usługę magazynu kluczy.
key_ops	JsonWebKeyOperation[]	Operacje klucza internetowego w formacie Json. Aby uzyskać więcej informacji na temat możliwych operacji klucza, zobacz JsonWebKeyOperation.
release_policy	KeyReleasePolicy	Reguły zasad, w ramach których można wyeksportować klucz.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

KeyVaultError

Wyjątek błędu magazynu kluczy.

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