@azure/keyvault-certificates package

Klient do interakcji z funkcją certyfikatów KeyVault

Szczegóły administratora organizacji wystawcy certyfikatu.

Wynik certyfikatu kopii zapasowej zawierający obiekt blob kopii zapasowej.

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)

Opcjonalne parametry akceptowane przez klienta CertificateClient usługi KeyVault

Kształt informacji kontaktowych dotyczących certyfikatów magazynu.

Interfejs reprezentujący właściwości wystawcy.

Operacja certyfikatu jest zwracana w przypadku żądań asynchronicznych.

Błąd serwera magazynu kluczy.

Interfejs reprezentujący publicznie dostępne właściwości stanu CertificateOperationPoller.

Interfejs reprezentujący zasady certyfikatu (bez właściwości podmiotu).

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) i beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Interfejs reprezentujący właściwości certyfikatu

Alternatywne nazwy podmiotu obiektu X509.

Opcje <xref:createCertificate>.

Opcje createIssuer(string, string, CreateIssuerOptions).

Interfejs reprezentujący usunięty certyfikat.

Model błędów serwera magazynu kluczy.

Opcje importCertificate(string, Uint8Array, ImportCertificateOptions).

Atrybuty wystawcy zarządzanego przez usługę Key Vault.

Poświadczenia, które mają być używane dla wystawcy certyfikatu.

Parametry wystawcy składnika X509 certyfikatu.

Interfejs reprezentujący właściwości wystawcy certyfikatu

Interfejs reprezentujący certyfikat bez zasad certyfikatu

Reprezentuje segmenty tworzące identyfikator certyfikatu usługi Key Vault.

Interfejs reprezentujący publiczny kształt stanu operacji usługi Key Vault Certificate Poller.

Interfejs reprezentujący certyfikat z jego zasadami

Akcja i jego wyzwalacz, który będzie wykonywany przez usługę Key Vault w okresie istnienia certyfikatu.

Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listDeletedCertificates(ListDeletedCertificatesOptions).

Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).

Interfejs reprezentujący możliwe właściwości podmiotu zasad certyfikatu. Ostateczny typ wymaga istnienia co najmniej jednej z tych właściwości.

Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.

Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.

Interfejs reprezentujący alternatywne nazwy podmiotu zasad certyfikatu.

Opcje <xref:updateCertificate>.

Opcje updateIssuer(string, UpdateIssuerOptions).

Właściwości składnika X509 certyfikatu.

Definiuje wartości typu ActionType.

Tablica z jedną właściwością co najmniej.

Opcje backupCertificate(string, OperationOptions).

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginDeleteCertificate(string, CertificatePollerOptions)

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginRecoverDeletedCertificate(string, CertificatePollerOptions)

Opcje <xref:cancelCertificateOperation>.

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.

Definiuje wartości właściwości contentType. Możliwe wartości obejmują: "application/x-pem-file", "application/x-pkcs12"

Definiuje wartości dla JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> można używać zamiennie z JsonWebKeyCurveName, 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

Definiuje wartości JsonWebKeyType.
<xref:KnownJsonWebKeyType> można używać zamiennie z JsonWebKeyType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

WE
EC-HSM
RSA
RSA-HSM
października
oct-HSM

Typ reprezentujący zasady certyfikatu z co najmniej jedną z właściwości podmiotu.

Akcja, która zostanie wykonana.

Interfejs reprezentujący kształt tagów certyfikatów. Tagi to tylko pary klucz-wartość ciągu.

Publiczna reprezentacja stanu operacji CreateCertificatePoller.

Opcje deleteCertificateOperation(string, OperationOptions).

Publiczna reprezentacja stanu operacji DeleteCertificatePoller.

Opcje deleteContacts(OperationOptions).

Opcje deleteIssuer(string, OperationOptions).

Definiuje wartości elementu DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> można używać zamiennie z elementem DeletionRecoveryLevel, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

można przeczyścić: określa stan magazynu, w którym usunięcie jest operacją nieodwracalną bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuwania na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
możliwe do odzyskania i przeczyszczania: oznacza stan magazynu, w którym można odzyskać, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w przedziale przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
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 zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
możliwe do odzyskania+ChronioneSubskrypcja: oznacza magazyn i stan subskrypcji, w którym usunięcie można odzyskać w przedziale 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 zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
CustomizedRecoverable+Purgeable: oznacza 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 okresie 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: oznacza magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone 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.

Opcje getCertificateOperation(string, CertificatePollerOptions).

Opcje getCertificate(string, OperationOptions).

Opcje getCertificatePolicy(string, OperationOptions).

Opcje getCertificateVersion(string, string, OperationOptions).

Opcje getContacts(OperationOptions).

Opcje getDeletedCertificate(string, OperationOptions).

Opcje getIssuer(string, OperationOptions).

Opcje <xref:getPlainCertificateOperation>.

Typ reprezentujący zasady certyfikatu do zaimportowania, który nie wymaga sieci SAN lub podmiotu

Przestarzała kopia keyVault pollerLike core-lro.

Definiuje wartości keyUsageType.
<xref:KnownKeyUsageType> można używać zamiennie z keyUsageType, 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
rozszyfrujOnly

Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfCertificateVersions(string, OperationOptions).

Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfIssuers(OperationOptions).

Interfejs reprezentujący parametry opcjonalne dla mergeCertificate(string, Uint8Array[], OperationOptions).

Opcje purgeDeletedCertificate(string, OperationOptions).

Przestarzałe: publiczna reprezentacja odzyskiwania usuniętej operacji sondowania certyfikatu

RequireAtLeastOne pomaga utworzyć typ, w którym co najmniej jedna z właściwości interfejsu (może być dowolną właściwością) musi istnieć.

Działa to z powodu typów narzędzi języka TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Przyjrzyjmy się temu:

• [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 potrzebami
• Partial<Pick<T, Exclude<keyof T, K>>> tworzy nowy typ ze wszystkimi właściwościami języka T, z wyjątkiem właściwości K.
• & to, co łączy typ z tylko jedną wymaganą właściwością z Required<...> ze wszystkimi opcjonalnymi właściwościami z Partial<...>.
• [keyof T] gwarantuje, że dozwolone są tylko właściwości T.

Interfejs reprezentujący parametry opcjonalne dla restoreCertificateBackup(Uint8Array, OperationOptions).

Opcje setContacts(CertificateContact[], OperationOptions).

Alternatywy dla właściwości podmiotu. Jeśli istnieje, powinien mieć co najmniej jedną z właściwości SubjectAlternativeNamesAll.

Opcje updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Znane wartości CertificateKeyCurveName akceptowane przez usługę.

Znane wartości CertificateKeyType akceptowane przez usługę.

Znane wartości DeletionRecoveryLevel akceptowane przez usługę.

Znane wartości KeyUsageType akceptowane przez usługę.

Dobrze znani wystawcy do wybierania wartości domyślnej

Analizuje dany identyfikator certyfikatu usługi Key Vault. Przykład:

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

Podczas analizowania powyższego identyfikatora ta funkcja zwraca następujące elementy:

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