Get Keys - Get Keys

Odwołanie

Service:: Key Vault

API Version:: 7.4

Wyświetl listę kluczy w określonym magazynie.
Pobiera listę kluczy w Key Vault jako struktury kluczy sieci Web JSON, które zawierają publiczną część klucza przechowywanego. Operacja LIST ma zastosowanie do wszystkich typów kluczy, jednak w odpowiedzi podano tylko podstawowy identyfikator klucza, atrybuty i tagi. Poszczególne wersje klucza nie są wymienione w odpowiedzi. Ta operacja wymaga uprawnień kluczy/listy.

GET {vaultBaseUrl}/keys?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/keys?maxresults={maxresults}&api-version=7.4

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
vaultBaseUrl	path	True	string	Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version	query	True	string	Wersja interfejsu API klienta.
maxresults	query		integer int32	Maksymalna liczba wyników do zwrócenia na stronie. Jeśli usługa nie zostanie określona, zwróci maksymalnie 25 wyników.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	KeyListResult	Komunikat odpowiedzi zawierający listę kluczy w magazynie wraz z linkiem do następnej strony kluczy.
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

GetKeys

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys?maxresults=1&api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "kid": "https://myvault.vault.azure.net/keys/sdktestkey",
      "attributes": {
        "enabled": true,
        "created": 1493937656,
        "updated": 1493937656,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1"
}

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.
KeyAttributes	Atrybuty klucza zarządzanego przez usługę magazynu kluczy.
KeyItem	Element klucza zawierający metadane klucza.
KeyListResult	Wynik listy kluczy.
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.

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.

KeyItem

Element klucza zawierający metadane klucza.

Nazwa	Typ	Opis
attributes	KeyAttributes	Atrybuty zarządzania kluczami.
kid	string	Identyfikator klucza.
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.
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

KeyListResult

Wynik listy kluczy.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu kluczy.
value	KeyItem[]	Komunikat odpowiedzi zawierający listę kluczy w magazynie kluczy wraz z linkiem do następnej strony kluczy.

KeyVaultError

Wyjątek błędu magazynu kluczy.

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