Sdílet prostřednictvím

@azure/keyvault-certificates package

  • Reference

Třídy

CertificateClient

Klient pro interakci s funkcemi certifikátů služby KeyVault

Rozhraní

AdministratorContact

Podrobnosti o správci organizace vystavitele certifikátu
BackupCertificateResult

Výsledek záložního certifikátu obsahující objekt blob zálohy.
BeginCreateCertificateOptions

Rozhraní představující volitelné parametry, které lze předat beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions

Volitelné parametry akceptované klientem CertificateClient služby KeyVault
CertificateContactAll

Tvar kontaktních informací pro certifikáty trezoru
CertificateIssuer

Rozhraní představující vlastnosti vystavitele.
CertificateOperation

V případě asynchronních požadavků se vrátí operace certifikátu.
CertificateOperationError

Chyba serveru trezoru klíčů.
CertificateOperationState

Rozhraní představující veřejně dostupné vlastnosti stavu CertificateOperationPoller.
CertificatePolicyProperties

Rozhraní představující zásady certifikátu (bez vlastností subjektu)
CertificatePollerOptions

Rozhraní představující volitelné parametry, které lze předat beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) a beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties

Rozhraní představující vlastnosti certifikátu
CoreSubjectAlternativeNames

Alternativní názvy subjektu objektu X509.
CreateCertificateOptions

Možnosti pro <xref:createCertificate>.
CreateIssuerOptions

Možnosti pro createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate

Rozhraní představující odstraněný certifikát.
ErrorModel

Model chyb serveru trezoru klíčů.
ImportCertificateOptions

Možnosti pro importCertificate(string, Uint8Array, ImportCertificateOptions).
IssuerAttributes

Atributy vystavitele spravovaného službou Key Vault.
IssuerCredentials

Přihlašovací údaje, které se mají použít pro vystavitele certifikátu.
IssuerParameters

Parametry vystavitele součásti X509 certifikátu
IssuerProperties

Rozhraní představující vlastnosti vystavitele certifikátu
KeyVaultCertificate

Rozhraní představující certifikát bez zásad certifikátu
KeyVaultCertificateIdentifier

Představuje segmenty, které tvoří ID certifikátu služby Key Vault.
KeyVaultCertificatePollOperationState

Rozhraní představující veřejný tvar stavu operací certifikátu služby Key Vault.
KeyVaultCertificateWithPolicy

Rozhraní představující certifikát se svými zásadami
LifetimeAction

Akce a její aktivační událost, kterou bude služba Key Vault provádět po celou dobu životnosti certifikátu
ListDeletedCertificatesOptions

Rozhraní představující volitelné parametry pro stránkované operace CertificateClient předané listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions

Rozhraní představující volitelné parametry pro stránkované operace CertificateClient předané listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties

Rozhraní představující možné vlastnosti subjektu zásady certifikátu. Poslední typ vyžaduje, aby existovaly alespoň některé z těchto vlastností.
PollerLike

Abstraktní reprezentace polleru, která má vystavit pouze minimální rozhraní API, se kterým musí uživatel pracovat.
PollerLikeWithCancellation

Abstraktní reprezentace polleru, která má vystavit pouze minimální rozhraní API, se kterým musí uživatel pracovat.
SubjectAlternativeNamesAll

Rozhraní představující alternativní názvy subjektu zásad certifikátu.
UpdateCertificateOptions

Možnosti pro <xref:updateCertificate>.
UpdateIssuerOptions

Možnosti pro updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties

Vlastnosti součásti X509 certifikátu

Aliasy typu

ActionType

Definuje hodnoty pro ActionType.
ArrayOneOrMore

Pole s minimálně jednou vlastností.
BackupCertificateOptions

Možnosti pro backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions

Rozhraní představující volitelné parametry, které lze předat beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions

Rozhraní představující volitelné parametry, které lze předat beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions

Možnosti pro <xref:cancelCertificateOperation>.
CertificateContact

Kontaktní informace pro certifikáty trezoru. Každý kontakt bude mít alespoň jednu z vlastností CertificateContactAll, které jsou: emailAddress, jméno nebo telefon.
CertificateContentType

Definuje hodnoty pro contentType. Mezi možné hodnoty patří: application/x-pem-file, application/x-pkcs12.
CertificateKeyCurveName

Definuje hodnoty jsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> lze použít zaměnitelně s JsonWebKeyCurveName, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

P-256
P-384
P-521
P-256K
CertificateKeyType

Definuje hodnoty jsonWebKeyType.
<xref:KnownJsonWebKeyType> lze použít zaměnitelně s JsonWebKeyType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

EC
EC-HSM
RSA
RSA-HSM
osmičkové
oct-HSM
CertificatePolicy

Typ představující zásadu certifikátu s alespoň jednou z vlastností subjektu.
CertificatePolicyAction

Akce, která se spustí.
CertificateTags

Rozhraní představující tvar značek certifikátů. Značky jsou jen páry klíč-hodnota řetězce.
CreateCertificateState

Veřejná reprezentace stavu operace CreateCertificatePoller.
DeleteCertificateOperationOptions

Možnosti pro deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState

Veřejná reprezentace stavu operace DeleteCertificatePoller.
DeleteContactsOptions

Možnosti pro deleteContacts(OperationOptions).
DeleteIssuerOptions

Možnosti pro deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel

Definuje hodnoty pro DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> lze použít zaměnitelně s DeletionRecoveryLevel, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

vyprázdnění: Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde ke ztrátě dat.
Obnovitelné+vyprázdnitelné: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů), pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví.
Obnovitelné: Označuje stav trezoru, ve kterém je odstranění možné obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví.
Obnovitelné +ProtectedSubscription: Označuje trezor a stav předplatného, ve kterém je odstranění mož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 samotné předplatné nelze trvale zrušit. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví.
CustomizedRecoverable+Purgeable: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vymazání, když 7<= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší.
Vlastní: Označuje stav trezoru, ve kterém se odstranění dá obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění, když 7<= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a v době, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém je odstranění možné obnovit, 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 také odráží skutečnost, že samotné předplatné nelze zrušit.
GetCertificateOperationOptions

Možnosti pro getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions

Možnosti pro getCertificate(string, OperationOptions).
GetCertificatePolicyOptions

Možnosti pro getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions

Možnosti pro getCertificateVersion(string, string, OperationOptions).
GetContactsOptions

Možnosti pro getContacts(OperationOptions).
GetDeletedCertificateOptions

Možnosti pro getDeletedCertificate(string, OperationOptions).
GetIssuerOptions

Možnosti pro getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions

Možnosti pro <xref:getPlainCertificateOperation>.
ImportCertificatePolicy

Typ představující zásadu certifikátu pro import, který nevyžaduje síť SAN nebo předmět
KVPollerLike

Zastaralá kopie keyVault core-lro PollerLike.
KeyUsageType

Definuje hodnoty pro KeyUsageType.
<xref:KnownKeyUsageType> lze zaměnitelně s keyUsageType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

digitalSignature
nonRepudiation
keyEncipherment
dataEncipherment
keyAgreement
keyCertSign
cRLSign
encipherOnly
decipherOnly
ListPropertiesOfCertificateVersionsOptions

Rozhraní představující volitelné parametry pro stránkované operace CertificateClient předané listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions

Rozhraní představující volitelné parametry pro stránkované operace CertificateClient předané listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions

Rozhraní představující volitelné parametry pro mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions

Možnosti pro purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState

Zastaralé: Veřejná reprezentace obnovení odstraněné operace dotazování certifikátu
RequireAtLeastOne

RequireAtLeastOne pomáhá vytvořit typ, kde je vyžadována alespoň jedna z vlastností rozhraní (může být libovolná vlastnost).

To funguje z důvodu typů nástrojů TypeScriptu: https://www.typescriptlang.org/docs/handbook/utility-types.html Pojďme to prozkoumat:

  • [K in keyof T]-? tato vlastnost (K) je platná pouze v případě, že má stejný název jako jakákoli vlastnost T.
  • Required<Pick<T, K>> vytvoří nový typ z T pouze s aktuální vlastností v iteraci a označí ho jako povinné.
  • Partial<Pick<T, Exclude<keyof T, K>>> vytvoří nový typ se všemi vlastnostmi T s výjimkou vlastnosti K.
  • & je to, co spojuje typ pouze s jednou požadovanou vlastností z Required<...> se všemi volitelnými vlastnostmi z Partial<...>.
  • [keyof T] zajišťuje, že jsou povoleny pouze vlastnosti T.
RestoreCertificateBackupOptions

Rozhraní představující volitelné parametry pro restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions

Možnosti pro setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames

Alternativy k vlastnosti předmětu. Pokud je k dispozici, měla by mít alespoň jednu z vlastností SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions

Možnosti pro updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Výčty

KnownCertificateKeyCurveNames

Známé hodnoty CertificateKeyCurveName, které služba přijímá.
KnownCertificateKeyTypes

Známé hodnoty CertificateKeyType, které služba přijímá.
KnownDeletionRecoveryLevels

Známé hodnoty DeletionRecoveryLevel, které služba přijímá.
KnownKeyUsageTypes

Známé hodnoty KeyUsageType, které služba přijímá.
WellKnownIssuer

Dobře známé vystavitele pro volbu výchozího

Funkce

parseKeyVaultCertificateIdentifier(string)

Analyzuje dané ID certifikátu služby Key Vault. Příkladem je:

https://.vault.azure.net/certificates//

Při analýze výše uvedeného ID vrátí tato funkce:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }

Podrobnosti funkce

parseKeyVaultCertificateIdentifier(string)

Analyzuje dané ID certifikátu služby Key Vault. Příkladem je:

https://.vault.azure.net/certificates//

Při analýze výše uvedeného ID vrátí tato funkce:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/certificates/<certificate-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<certificate-name>"
  }

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

Parametry

id

string

ID certifikátu služby Key Vault.

Návraty

KeyVaultCertificateIdentifier