Get Deleted Certificates - Get Deleted Certificates

Odwołanie

Service:: Key Vault

API Version:: 7.4

Listy usuniętych certyfikatów w określonym magazynie, które są obecnie dostępne do odzyskiwania.
Operacja GetDeletedCertificates pobiera certyfikaty w bieżącym magazynie, które są w stanie usuniętym i są gotowe do odzyskiwania lub przeczyszczania. Ta operacja obejmuje informacje specyficzne dla usuwania. Ta operacja wymaga uprawnień certyfikatów/get/list. Tę operację można włączyć tylko w magazynach z włączoną obsługą usuwania nietrwałego.

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

With optional parameters:

GET {vaultBaseUrl}/deletedcertificates?maxresults={maxresults}&includePending={includePending}&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.
includePending	query		boolean	Określa, czy należy uwzględnić certyfikaty, które nie są całkowicie aprowizowane.
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	DeletedCertificateListResult	Komunikat odpowiedzi zawierający listę usuniętych certyfikatów w magazynie wraz z linkiem do następnej strony usuniętych certyfikatów
Other Status Codes	KeyVaultError	Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

GetDeletedCertificates

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "recoveryId": "https://myvault.vault.azure.net/deletedcertificates/listdeletedcerttest0",
      "deletedDate": 1493937659,
      "scheduledPurgeDate": 1501713659,
      "id": "https://myvault.vault.azure.net/certificates/listdeletedcerttest0",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1493937658,
        "updated": 1493937658,
        "recoveryLevel": "Recoverable+Purgeable"
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/deletedcertificates?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiExMTIhTURBd01ETTVJV05sY25ScFptbGpZWFJsTDB4SlUxUkVSVXhGVkVWRVEwVlNWRlJGVTFRd0wxQlBURWxEV1NFd01EQXdNamdoT1RrNU9TMHhNaTB6TVZReU16bzFPVG8xT1M0NU9UazVPVGs1V2lFLSIsIlRhcmdldExvY2F0aW9uIjowfQ&maxresults=1"
}

Definicje

Nazwa	Opis
CertificateAttributes	Atrybuty zarządzania certyfikatami.
DeletedCertificateItem	Usunięty element certyfikatu zawierający metadane dotyczące usuniętego certyfikatu.
DeletedCertificateListResult	Lista certyfikatów, które zostały usunięte w tym magazynie.
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.
Error	Błąd serwera magazynu kluczy.
KeyVaultError	Wyjątek błędu magazynu kluczy.

CertificateAttributes

Atrybuty zarządzania certyfikatami.

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.
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 certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat na końcu interwału przechowywania.
updated	integer	Czas ostatniej aktualizacji w formacie UTC.

DeletedCertificateItem

Usunięty element certyfikatu zawierający metadane dotyczące usuniętego certyfikatu.

Nazwa	Typ	Opis
attributes	CertificateAttributes	Atrybuty zarządzania certyfikatami.
deletedDate	integer	Czas usunięcia certyfikatu w formacie UTC
id	string	Identyfikator certyfikatu.
recoveryId	string	Adres URL obiektu odzyskiwania używany do identyfikowania i odzyskiwania usuniętego certyfikatu.
scheduledPurgeDate	integer	Godzina przeczyszczania certyfikatu w formacie UTC
tags	object	Metadane specyficzne dla aplikacji w postaci par klucz-wartość.
x5t	string	Odcisk palca certyfikatu.

DeletedCertificateListResult

Lista certyfikatów, 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 certyfikatów.
value	DeletedCertificateItem[]	Komunikat odpowiedzi zawierający listę usuniętych certyfikatów w magazynie wraz z linkiem do następnej strony usuniętych certyfikatów

DeletionRecoveryLevel

Odzwierciedla obecnie poziom odzyskiwania usuwania dla certyfikatów w bieżącym magazynie. Jeśli zawiera on element "Przeczyszczalny", certyfikat może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić certyfikat 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.

KeyVaultError

Wyjątek błędu magazynu kluczy.

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