Get Certificates - Get Certificates

Vypíše certifikáty 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 seznamům.

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

Parametry identifikátoru URI

Name In Required Type 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 kompletně zřízené.

maxresults
query
  • integer
int32

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

Odpovědi

Name Type Description
200 OK

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

Other Status Codes

Key Vaulta chybová odezva popisující, proč se operace nezdařila.

Příklady

GetCertificates

Sample Request

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

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

CertificateAttributes

Atributy správy certifikátů.

CertificateItem

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

CertificateListResult

Výsledek seznamu certifikátů.

DeletionRecoveryLevel

Odráží aktuálně probíhající úroveň obnovení v rámci platnosti certifikátů v aktuálním trezoru. Pokud obsahuje hodnotu "Vyprázdněnelné", certifikát může být trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát vyprázdnit jenom systém na konci intervalu uchování.

Error

Chyba serveru trezoru klíčů

KeyVaultError

Výjimka chyby trezoru klíčů

CertificateAttributes

Atributy správy certifikátů.

Name Type 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í dřívější než datum v UTC.

recoverableDays
  • integer

dny uchovávání dat softDelete. Hodnota by měla být >= 7 a <= 90, když je povolený softDelete, jinak 0.

recoveryLevel

Odráží aktuálně probíhající úroveň obnovení v rámci platnosti certifikátů v aktuálním trezoru. Pokud obsahuje hodnotu "Vyprázdněnelné", certifikát může být trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát vyprázdnit jenom systém na konci intervalu uchování.

updated
  • integer

Čas poslední aktualizace ve standardu UTC

CertificateItem

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

Name Type Description
attributes

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 Type Description
nextLink
  • string

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

value

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

DeletionRecoveryLevel

Odráží aktuálně probíhající úroveň obnovení v rámci platnosti certifikátů v aktuálním trezoru. Pokud obsahuje hodnotu "Vyprázdněnelné", certifikát může být trvale odstraněn privilegovaným uživatelem; v opačném případě může certifikát vyprázdnit jenom systém na konci intervalu uchování.

Name Type Description
CustomizedRecoverable
  • string

Označuje stav trezoru, ve kterém je odstranění obnovitelné bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnit při 7<= SoftDeleteRetentionInDays < 90). Tato úroveň garantuje obnovitelnost odstraněné entity během intervalu uchování a předplatné je stále k dispozici.

CustomizedRecoverable+ProtectedSubscription
  • string

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

CustomizedRecoverable+Purgeable
  • string

Označuje stav trezoru, ve kterém je odstranění obnovitelné a které také umožňuje okamžité a trvalé odstranění (tj. vyprázdnit při 7<= SoftDeleteRetentionInDays < 90). Tato úroveň garantuje obnovitelnost odstraněné entity během intervalu uchování, pokud se nepožaduje operace vyprázdnění nebo je předplatné zrušené.

Purgeable
  • string

Označuje stav trezoru, ve kterém je odstranění nevratné operace bez možnosti obnovení. Tato úroveň odpovídá nedostupnosti ochrany proti operaci odstranění. data se irretrievably ztratila při přijetí operace odstranění na úrovni entity nebo vyšších (trezor, skupina prostředků, předplatné atd.).

Recoverable
  • string

Označuje stav trezoru, ve kterém je odstranění obnovitelné bez možnosti okamžitého a trvalého odstranění (tj. mazání). Tato úroveň garantuje obnovitelnost odstraněné entity během intervalu uchování (90 dní) a předplatné je stále k dispozici. Systém probíhal ho po 90 dnech trvale odstraní, pokud se neobnoví.

Recoverable+ProtectedSubscription
  • string

Označuje trezor a stav předplatného, ve kterém je odstranění obnovitelné v rámci intervalu uchování (90 dní), okamžitého a trvalého odstranění (tj. vyprázdnění) není dovolené a v němž samotné předplatné nelze trvale zrušit. Systém probíhal ho po 90 dnech trvale odstraní, pokud se neobnoví.

Recoverable+Purgeable
  • string

Označuje stav trezoru, ve kterém je odstranění obnovitelné a které zároveň umožňuje okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň garantuje obnovitelnost odstraněné entity během intervalu uchování (90 dní), pokud není požadována operace vyprázdnění nebo je předplatné zrušeno. Systém probíhal ho po 90 dnech trvale odstraní, pokud se neobnoví.

Error

Chyba serveru trezoru klíčů

Name Type Description
code
  • string

Kód chyby

innererror

Chyba serveru trezoru klíčů

message
  • string

Chybová zpráva

KeyVaultError

Výjimka chyby trezoru klíčů

Name Type Description
error

Chyba serveru trezoru klíčů