Get Certificates - Get Certificates

Výpis certifikátů v zadaném trezoru klíčů
Operace GetCertificates vrátí sadu prostředků certifikátů v zadaném trezoru klíčů. Tato operace vyžaduje oprávnění k certifikátům nebo seznamu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
vaultBaseUrl
path True

string

Název trezoru, například https://myvault.vault.azure.net.

api-version
query True

string

Verze rozhraní API klienta.

includePending
query

boolean

Určuje, jestli se mají zahrnout certifikáty, které nejsou zcela zřízené.

maxresults
query

integer

int32

Maximální počet výsledků, které se mají na stránce vrátit Pokud ho nezadáte, vrátí služba až 25 výsledků.

Odpovědi

Name Typ Description
200 OK

CertificateListResult

Zpráva s odpovědí obsahující seznam certifikátů spolu s odkazem na další stránku certifikátů.

Other Status Codes

KeyVaultError

Key Vault chybovou odpověď popisující, proč operace selhala.

Příklady

GetCertificates

Sample Request

GET https://myvault.vault.azure.net//certificates?api-version=7.4

Sample Response

{
  "value": [
    {
      "id": "https://myvault.vault.azure.net/certificates/listCert01",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1482188987,
        "updated": 1482188987
      }
    },
    {
      "id": "https://myvault.vault.azure.net/certificates/listCert02",
      "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
      "attributes": {
        "enabled": true,
        "nbf": 1430344421,
        "exp": 2208988799,
        "created": 1482188988,
        "updated": 1482188988
      }
    }
  ],
  "nextLink": null
}

Definice

Name Description
CertificateAttributes

Atributy správy certifikátů.

CertificateItem

Položka certifikátu obsahující metadata certifikátu.

CertificateListResult

Výsledek seznamu certifikátů

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Purgeable", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.

Error

Chyba serveru trezoru klíčů.

KeyVaultError

Výjimka chyby trezoru klíčů

CertificateAttributes

Atributy správy certifikátů.

Name Typ Description
created

integer

Čas vytvoření ve standardu UTC

enabled

boolean

Určuje, zda je objekt povolen.

exp

integer

Datum vypršení platnosti v UTC.

nbf

integer

Není před datem ve standardu UTC.

recoverableDays

integer

softDelete data retention days. Pokud je povolená funkce softDelete, hodnota by měla být >=7 a <=90, jinak 0.

recoveryLevel

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Purgeable", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.

updated

integer

Čas poslední aktualizace v UTC.

CertificateItem

Položka certifikátu obsahující metadata certifikátu.

Name Typ Description
attributes

CertificateAttributes

Atributy správy certifikátů.

id

string

Identifikátor certifikátu.

tags

object

Metadata specifická pro aplikaci ve formě párů klíč-hodnota.

x5t

string

Kryptografický otisk certifikátu

CertificateListResult

Výsledek seznamu certifikátů

Name Typ Description
nextLink

string

Adresa URL pro získání další sady certifikátů

value

CertificateItem[]

Zpráva odpovědi obsahující seznam certifikátů v trezoru klíčů spolu s odkazem na další stránku certifikátů.

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro certifikáty v aktuálním trezoru. Pokud obsahuje "Purgeable", může být certifikát trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát na konci intervalu uchovávání vyprázdnit pouze systém.

Name Typ Description
CustomizedRecoverable

string

Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.

CustomizedRecoverable+ProtectedSubscription

string

Označuje stav trezoru a předplatného, ve kterém je odstranění obnovitelné, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, když 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.

CustomizedRecoverable+Purgeable

string

Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnění při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není vyžadována operace vyprázdnění nebo se nezruší předplatné.

Purgeable

string

Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá žádné ochraně není k dispozici proti operaci Odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde k nenávratné ztrátě dat.

Recoverable

string

Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a po dobu, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví

Recoverable+ProtectedSubscription

string

Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vyprázdnění) není povoleno a ve kterém nelze trvale zrušit samotné předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví

Recoverable+Purgeable

string

Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud se nevyžádá operace vyprázdnění nebo se nezruší předplatné. Systém ho po 90 dnech trvale odstraní, pokud se neobnoví

Error

Chyba serveru trezoru klíčů.

Name Typ Description
code

string

Kód chyby

innererror

Error

Chyba serveru trezoru klíčů.

message

string

Chybová zpráva

KeyVaultError

Výjimka chyby trezoru klíčů

Name Typ Description
error

Error

Chyba serveru trezoru klíčů.