@azure/keyvault-certificates package
Třídy
CertificateClient |
Klient pro interakci s funkcí certifikátů KeyVault |
Rozhraní
AdministratorContact |
Podrobnosti o správci organizace vystavitele certifikátu |
BackupCertificateResult |
Výsledek zálohovacího certifikátu obsahující objekt blob zálohování |
BeginCreateCertificateOptions |
Rozhraní představující volitelné parametry, které lze předat do 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í předmětu) |
CertificatePollerOptions |
Rozhraní představující volitelné parametry, které lze předat do beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)a beginDeleteCertificate(string, CertificatePollerOptions)beginRecoverDeletedCertificate(string, CertificatePollerOptions) |
CertificateProperties |
Rozhraní představující vlastnosti certifikátu |
CoreSubjectAlternativeNames |
Alternativní názvy předmětu 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 komponenty 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 Key Vault. |
KeyVaultCertificatePollOperationState |
Rozhraní představující veřejný tvar stavu operací Key Vault Certificate Poller. |
KeyVaultCertificateWithPolicy |
Rozhraní představující certifikát s jeho zásadami |
LifetimeAction |
Akce a její aktivační událost, kterou bude provádět Key Vault po celou dobu životnosti certifikátu. |
ListDeletedCertificatesOptions |
Rozhraní představující volitelné parametry stránkovaných operací CertificateClient předaných do listDeletedCertificates(ListDeletedCertificatesOptions). |
ListPropertiesOfCertificatesOptions |
Rozhraní představující volitelné parametry stránkovaných operací CertificateClient předaných do listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions). |
PolicySubjectProperties |
Rozhraní představující možné vlastnosti předmětu zásad certifikátu. Konečný typ vyžaduje, aby existovala alespoň jedna z těchto vlastností. |
PollerLike |
Abstraktní reprezentace polleru, která má zveřejnit pouze minimální rozhraní API, se kterým uživatel potřebuje pracovat. |
SubjectAlternativeNamesAll |
Rozhraní představující alternativní názvy předmětu zásad certifikátů. |
UpdateCertificateOptions |
Možnosti pro <xref:updateCertificate>. |
UpdateIssuerOptions |
Možnosti pro updateIssuer(string, UpdateIssuerOptions). |
X509CertificateProperties |
Vlastnosti komponenty 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 do beginDeleteCertificate(string, CertificatePollerOptions) |
BeginRecoverDeletedCertificateOptions |
Rozhraní představující volitelné parametry, které lze předat do 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ými 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 pro JsonWebKeyCurveName. Známé hodnoty podporované službouP-256 |
CertificateKeyType |
Definuje hodnoty pro JsonWebKeyType. Známé hodnoty podporované službouEC |
CertificatePolicy |
Typ představující zásadu certifikátu s alespoň jednou z vlastností předmětu. |
CertificatePolicyAction |
Akce, která se provede. |
CertificateTags |
Rozhraní představující tvar značek certifikátů. Značky jsou pouze 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. Známé hodnoty podporované službouVymazatelné: 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 k nenávratné ztrátě dat. |
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 ani předmět |
KVPollerLike |
Zastaralá kopie KeyVault core-lro's PollerLike. |
KeyUsageType |
Definuje hodnoty pro KeyUsageType. Známé hodnoty podporované službouDigitalsignature |
ListPropertiesOfCertificateVersionsOptions |
Rozhraní představující volitelné parametry stránkovaných operací CertificateClient předaných do listPropertiesOfCertificateVersions(string, OperationOptions). |
ListPropertiesOfIssuersOptions |
Rozhraní představující volitelné parametry stránkovaných operací CertificateClient předaných do 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í operace dotazování odstraněného certifikátu |
RequireAtLeastOne |
RequireAtLeastOne pomáhá vytvořit typ, kde se vyžaduje alespoň jedna z vlastností rozhraní (může být libovolná vlastnost). Funguje to kvůli typům nástrojů TypeScriptu: https://www.typescriptlang.org/docs/handbook/utility-types.html Pojďme se na to podívat:
|
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 existuje, měl 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í vystaviteři pro volbu výchozího nastavení |
Funkce
parse |
Analyzuje dané ID certifikátu Key Vault. Příklad: https://.vault.azure.net/certificates// Při parsování výše uvedeného ID tato funkce vrátí:
|
Podrobnosti funkce
parseKeyVaultCertificateIdentifier(string)
Analyzuje dané ID certifikátu Key Vault. Příklad:
https://.vault.azure.net/certificates//
Při parsování výše uvedeného ID tato funkce vrátí:
{
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 Key Vault.