@azure/keyvault-certificates package

Odwołanie

Klasy

Klient do interakcji z funkcjami certyfikatów usługi KeyVault

Interfejsy

AdministratorContact	Szczegóły administratora organizacji wystawcy certyfikatu.
BackupCertificateResult	Wynik certyfikatu kopii zapasowej zawierający obiekt blob kopii zapasowej.
BeginCreateCertificateOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	Opcjonalne parametry akceptowane przez element CertificateClient usługi KeyVault
CertificateContactAll	Kształt informacji kontaktowych dla certyfikatów magazynu.
CertificateIssuer	Interfejs reprezentujący właściwości wystawcy.
CertificateOperation	Operacja certyfikatu jest zwracana w przypadku żądań asynchronicznych.
CertificateOperationError	Błąd serwera magazynu kluczy.
CertificateOperationState	Interfejs reprezentujący publicznie dostępne właściwości stanu CertificateOperationPoller.
CertificatePolicyProperties	Interfejs reprezentujący zasady certyfikatu (bez właściwości podmiotu).
CertificatePollerOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) i beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CertificateProperties	Interfejs reprezentujący właściwości certyfikatu
CoreSubjectAlternativeNames	Alternatywne nazwy podmiotu obiektu X509.
CreateCertificateOptions	Opcje dla .<xref:createCertificate>
CreateIssuerOptions	Opcje dla .createIssuer(string, string, CreateIssuerOptions)
DeletedCertificate	Interfejs reprezentujący usunięty certyfikat.
ErrorModel	Model błędu serwera magazynu kluczy.
ImportCertificateOptions	Opcje dla .importCertificate(string, Uint8Array, ImportCertificateOptions)
IssuerAttributes	Atrybuty wystawcy zarządzanego przez usługę Key Vault.
IssuerCredentials	Poświadczenia, które mają być używane dla wystawcy certyfikatu.
IssuerParameters	Parametry wystawcy składnika X509 certyfikatu.
IssuerProperties	Interfejs reprezentujący właściwości wystawcy certyfikatu
KeyVaultCertificate	Interfejs reprezentujący certyfikat bez zasad certyfikatu
KeyVaultCertificateIdentifier	Reprezentuje segmenty tworzące identyfikator certyfikatu Key Vault.
KeyVaultCertificatePollOperationState	Interfejs reprezentujący publiczny kształt stanu operacji Key Vault Certificate Poller.
KeyVaultCertificateWithPolicy	Interfejs reprezentujący certyfikat z jego zasadami
LifetimeAction	Akcja i jego wyzwalacz, który zostanie wykonany przez Key Vault w okresie istnienia certyfikatu.
ListDeletedCertificatesOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listDeletedCertificates(ListDeletedCertificatesOptions)elementu .
ListPropertiesOfCertificatesOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)elementu .
PolicySubjectProperties	Interfejs reprezentujący możliwe właściwości podmiotu zasad certyfikatu. Ostateczny typ wymaga co najmniej jednej z tych właściwości do istnienia.
PollerLike	Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.
SubjectAlternativeNamesAll	Interfejs reprezentujący alternatywne nazwy podmiotu zasad certyfikatu.
UpdateCertificateOptions	Opcje dla .<xref:updateCertificate>
UpdateIssuerOptions	Opcje dla .updateIssuer(string, UpdateIssuerOptions)
X509CertificateProperties	Właściwości składnika X509 certyfikatu.

Aliasy typu

ActionType	Definiuje wartości typu ActionType.
ArrayOneOrMore	Tablica z jedną właściwością co najmniej.
BackupCertificateOptions	Opcje dla .backupCertificate(string, OperationOptions)
BeginDeleteCertificateOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	Opcje dla .<xref:cancelCertificateOperation>
CertificateContact	Informacje kontaktowe dotyczące certyfikatów magazynu. Każdy kontakt będzie miał co najmniej jedną z właściwości CertificateContactAll, które są: adres e-mail, nazwa lub telefon.
CertificateContentType	Definiuje wartości typu contentType. Możliwe wartości obejmują: "application/x-pem-file", "application/x-pkcs12"
CertificateKeyCurveName	Definiuje wartości JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> można używać zamiennie z JsonWebKeyCurveName. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę P-256 P-384 P-521 P-256K
CertificateKeyType	Definiuje wartości JsonWebKeyType. <xref:KnownJsonWebKeyType> można używać zamiennie z JsonWebKeyType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę EC Moduł EC-HSM RSA RSA-HSM Października oct-HSM
CertificatePolicy	Typ reprezentujący zasady certyfikatu z co najmniej jedną z właściwości podmiotu.
CertificatePolicyAction	Akcja, która zostanie wykonana.
CertificateTags	Interfejs reprezentujący kształt tagów certyfikatów. Tagi to tylko pary klucz-wartość ciągu.
CreateCertificateState	Publiczna reprezentacja stanu operacji CreateCertificatePoller.
DeleteCertificateOperationOptions	Opcje dla .deleteCertificateOperation(string, OperationOptions)
DeleteCertificateState	Publiczna reprezentacja stanu operacji DeleteCertificatePoller.
DeleteContactsOptions	Opcje dla .deleteContacts(OperationOptions)
DeleteIssuerOptions	Opcje dla .deleteIssuer(string, OperationOptions)
DeletionRecoveryLevel	Definiuje wartości elementu DeletionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> można używać zamiennie z elementem DeletionRecoveryLevel. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Możliwe do przeczyszczenia: 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.) Możliwe do odzyskania+Przeczyszczanie: określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). 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 Możliwe do odzyskania: 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 Możliwe do odzyskania+ChronioneSubskrypcja: oznacza magazyn i stan subskrypcji, w którym usunięcie można odzyskać w okresie 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 CustomizedRecoverable+Purgeable: określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7<= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w przedziale czasu przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. CustomizedRecoverable: 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: określa stan magazynu i 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.
GetCertificateOperationOptions	Opcje dla .getCertificateOperation(string, CertificatePollerOptions)
GetCertificateOptions	Opcje dla .getCertificate(string, OperationOptions)
GetCertificatePolicyOptions	Opcje dla .getCertificatePolicy(string, OperationOptions)
GetCertificateVersionOptions	Opcje dla .getCertificateVersion(string, string, OperationOptions)
GetContactsOptions	Opcje dla .getContacts(OperationOptions)
GetDeletedCertificateOptions	Opcje dla .getDeletedCertificate(string, OperationOptions)
GetIssuerOptions	Opcje dla .getIssuer(string, OperationOptions)
GetPlainCertificateOperationOptions	Opcje dla .<xref:getPlainCertificateOperation>
ImportCertificatePolicy	Typ reprezentujący zasady certyfikatu do zaimportowania, które nie wymagają sieci SAN ani podmiotu
KVPollerLike	Przestarzała kopia keyVault core-lro's PollerLike.
KeyUsageType	Definiuje wartości keyUsageType. <xref:KnownKeyUsageType> można używać zamiennie z keyUsageType, to wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę digitalSignature nonRepudiation keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfCertificateVersions(string, OperationOptions)elementu .
ListPropertiesOfIssuersOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfIssuers(OperationOptions)elementu .
MergeCertificateOptions	Interfejs reprezentujący opcjonalne parametry dla mergeCertificate(string, Uint8Array[], OperationOptions)elementu .
PurgeDeletedCertificateOptions	Opcje dla .purgeDeletedCertificate(string, OperationOptions)
RecoverDeletedCertificateState	Przestarzałe: publiczna reprezentacja odzyskiwania usuniętej operacji sondowania certyfikatu
RequireAtLeastOne	RequireAtLeastOne pomaga utworzyć typ, w którym wymagana jest co najmniej jedna z właściwości interfejsu (może być dowolną właściwością). Działa to z powodu typów narzędzi języka TypeScript: Przyjrzyjmy się temu: https://www.typescriptlang.org/docs/handbook/utility-types.html `[K in keyof T]-?` ta właściwość (K) jest prawidłowa tylko wtedy, gdy ma taką samą nazwę jak dowolna właściwość T. `Required<Pick<T, K>>` tworzy nowy typ z języka T z tylko bieżącą właściwością w iteracji i oznacza go zgodnie z wymaganiami `Partial<Pick<T, Exclude<keyof T, K>>>` tworzy nowy typ ze wszystkimi właściwościami T, z wyjątkiem właściwości K. `&` to, co łączy typ z tylko jedną wymaganą właściwością z `Required<...>` wszystkich opcjonalnych właściwości z `Partial<...>`. `[keyof T]` zapewnia, że dozwolone są tylko właściwości języka T.
RestoreCertificateBackupOptions	Interfejs reprezentujący opcjonalne parametry dla restoreCertificateBackup(Uint8Array, OperationOptions)elementu .
SetContactsOptions	Opcje dla .setContacts(CertificateContact[], OperationOptions)
SubjectAlternativeNames	Alternatywy dla właściwości podmiotu. Jeśli jest obecny, powinien mieć co najmniej jedną z właściwości SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions	Opcje dla .updateCertificatePolicy(string, CertificatePolicy, OperationOptions)

Wyliczenia

KnownCertificateKeyCurveNames	Znane wartości CertificateKeyCurveName akceptowane przez usługę.
KnownCertificateKeyTypes	Znane wartości CertificateKeyType , które akceptuje usługa.
KnownDeletionRecoveryLevels	Znane wartości DeletionRecoveryLevel , które akceptuje usługa.
KnownKeyUsageTypes	Znane wartości KeyUsageType , które akceptuje usługa.
WellKnownIssuer	Dobrze znani wystawcy do wybierania wartości domyślnej

Funkcje

parseKeyVaultCertificateIdentifier(string)

Analizuje podany identyfikator certyfikatu Key Vault. Przykład:

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

Po przeanalizowaniu powyższego identyfikatora ta funkcja zwraca:

  {
     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>"
  }

Szczegóły funkcji

parseKeyVaultCertificateIdentifier(string)

Analizuje podany identyfikator certyfikatu Key Vault. Przykład:

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

Po przeanalizowaniu powyższego identyfikatora ta funkcja zwraca:

  {
     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

Identyfikator certyfikatu Key Vault.

Zwraca

KeyVaultCertificateIdentifier

@azure/keyvault-certificates package

Klasy

Interfejsy

Aliasy typu

Znane wartości obsługiwane przez usługę

Znane wartości obsługiwane przez usługę

Znane wartości obsługiwane przez usługę

Znane wartości obsługiwane przez usługę

Wyliczenia

Funkcje

Szczegóły funkcji

parseKeyVaultCertificateIdentifier(string)

Parametry

Zwraca

Dodatkowe zasoby