Get Deleted Keys - Get Deleted Keys

Odwołanie

Usługa:: Key Vault

Wersja interfejsu API:: 7.4

Listy usuniętych kluczy w określonym magazynie.
Pobiera listę kluczy w Key Vault jako struktury klucza sieci Web JSON, które zawierają publiczną część usuniętego klucza. Ta operacja obejmuje informacje specyficzne dla usuwania. Operacja Pobierz usunięte klucze ma zastosowanie do magazynów z włączoną obsługą usuwania nietrwałego. Chociaż operację można wywołać w dowolnym magazynie, zostanie zwrócony błąd w przypadku wywołania w magazynie z włączonym usuwaniem nietrwałym. Ta operacja wymaga uprawnień kluczy/listy.

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

Z parametrami opcjonalnymi:

GET {vaultBaseUrl}/deletedkeys?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	DeletedKeyListResult	Komunikat odpowiedzi zawierający listę usuniętych kluczy w magazynie wraz z linkiem do następnej strony usuniętych kluczy.
Other Status Codes	KeyVaultError	Key Vault odpowiedzi na błąd opisujący, dlaczego operacja nie powiodła się.

Przykłady

GetDeletedKeys

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedkeys/listdeletedkeytest0",
      "deletedDate": 1493938031,
      "scheduledPurgeDate": 1501714031,
      "kid": "https://myvault.vault.azure.net/keys/listdeletedkeytest0",
      "attributes": {
        "enabled": true,
        "created": 1493938031,
        "updated": 1493938031,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedkeys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMzYhTURBd01EVTJJV3RsZVM5TVNWTlVSRVZNUlZSRlJFdEZXVlJGVTFRd0x6RkRRa0ZGTkVaQk5qQTBNelJGTmtZNE9FUXdORE5GTkRFM09FUkNPVFE1SVRBd01EQXlPQ0V5TURFM0xUQTFMVEEwVkRJeU9qUTNPakU1TGpVeU1UZ3dPVEZhSVEtLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Definicje

Nazwa	Opis
DeletedKeyItem	Usunięty element klucza zawierający usunięte metadane klucza i informacje o usunięciu.
DeletedKeyListResult	Lista kluczy, które zostały usunięte w tym magazynie.
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.
KeyVaultError	Wyjątek błędu magazynu kluczy.

DeletedKeyItem

Usunięty element klucza zawierający usunięte metadane klucza i informacje o usunięciu.

Nazwa	Typ	Opis
attributes	KeyAttributes	Atrybuty zarządzania kluczami.
deletedDate	integer	Godzina usunięcia klucza w formacie UTC
kid	string	Identyfikator klucza.
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.
recoveryId	string	Adres URL obiektu odzyskiwania używany do identyfikowania i odzyskiwania usuniętego klucza.
scheduledPurgeDate	integer	Godzina przeczyszczania klucza w formacie UTC
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.

DeletedKeyListResult

Lista kluczy, które zostały usunięte w tym magazynie.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu usuniętych kluczy.
value	DeletedKeyItem[]	Komunikat odpowiedzi zawierający listę usuniętych kluczy w magazynie wraz z linkiem do następnej strony usuniętych 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.

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.

KeyVaultError

Wyjątek błędu magazynu kluczy.

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

Udostępnij za pośrednictwem