Get Key - Get Key

Odwołanie

Service:: Key Vault

API Version:: 7.4

Pobiera publiczną część przechowywanego klucza.
Operacja pobierania klucza ma zastosowanie do wszystkich typów kluczy. Jeśli żądany klucz jest symetryczny, w odpowiedzi nie zostanie wydany żaden materiał klucza. Ta operacja wymaga uprawnień kluczy/pobierania.

GET {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 pobrania.
key-version	path	True	string	Dodanie parametru wersji pobiera określoną wersję klucza. Ten fragment identyfikatora URI jest opcjonalny. Jeśli nie zostanie określony, zostanie zwrócona najnowsza wersja klucza.
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KeyBundle	Pakiet kluczy zawierający klucz i jego atrybuty.
Other Status Codes	KeyVaultError	Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

Get key

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?api-version=7.4

Sample Response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

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 dnia http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie JsonWebKeyCurveName.
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	Element KeyBundle składający się z elementu WebKey oraz jego atrybutów.
KeyReleasePolicy	Reguły zasad, w ramach których można wyeksportować klucz.
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	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.

JsonWebKey

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

Nazwa	Typ	Opis
crv	JsonWebKeyCurveName	Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie 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	Wykładnik publiczny RSA.
k	string	Klucz symetryczny.
key_hsm	string	Klucz chroniony używany z ciągiem "Bring Your Own Key".
key_ops	string[]	Obsługiwane operacje kluczy.
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	Modulo 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 EC.
y	string	Składnik Y klucza publicznego WE.

JsonWebKeyCurveName

Nazwa krzywej eliptycznej. Prawidłowe wartości można znaleźć w temacie 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.

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 oktetów (używana do reprezentowania kluczy symetrycznych)
oct-HSM	string	Sekwencja oktetów (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 utworzenia 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 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

Element KeyBundle składający się z elementu WebKey oraz jego atrybutów.

Nazwa	Typ	Opis
attributes	KeyAttributes	Atrybuty zarządzania kluczami.
key	JsonWebKey	Klucz internetowy Json.
managed	boolean	Wartość True, jeśli okres istnienia klucza jest zarządzany przez magazyn kluczy. Jeśli jest to klucz kopii zapasowej certyfikatu, zarządzany będzie mieć wartość true.
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 których można zwolnić klucz. Obiekt blob musi być zakodowany w formacie base64 URL.
immutable	boolean		Definiuje stan niezmienności zasad. Po oznaczeniu niezmienialnej flagi nie można zresetować i nie można zmienić zasad w żadnych okolicznościach.

KeyVaultError

Wyjątek błędu magazynu kluczy.

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

Udostępnij za pośrednictwem