@azure/keyvault-certificates package

Klasy

Klient do interakcji z funkcją certyfikatów KeyVault

Interfejsy

AdministratorContact	Szczegóły administratora organizacji wystawcy certyfikatu.
BackupCertificateResult	Wynik certyfikatu kopii zapasowej zawierający obiekt blob kopii zapasowej.
BeginCreateCertificateOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	Opcjonalne parametry akceptowane przez klienta CertificateClient usługi KeyVault
CertificateContactAll	Kształt informacji kontaktowych dotyczących 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 parametry opcjonalne, 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 <xref:createCertificate>.
CreateIssuerOptions	Opcje createIssuer(string, string, CreateIssuerOptions).
DeletedCertificate	Interfejs reprezentujący usunięty certyfikat.
ErrorModel	Model błędów serwera magazynu kluczy.
ImportCertificateOptions	Opcje 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 usługi Key Vault.
KeyVaultCertificatePollOperationState	Interfejs reprezentujący publiczny kształt stanu operacji usługi Key Vault Certificate Poller.
KeyVaultCertificateWithPolicy	Interfejs reprezentujący certyfikat z jego zasadami
LifetimeAction	Akcja i jego wyzwalacz, który będzie wykonywany przez usługę Key Vault w okresie istnienia certyfikatu.
ListDeletedCertificatesOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listDeletedCertificates(ListDeletedCertificatesOptions).
ListPropertiesOfCertificatesOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions).
PolicySubjectProperties	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.
PollerLike	Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.
PollerLikeWithCancellation	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 <xref:updateCertificate>.
UpdateIssuerOptions	Opcje updateIssuer(string, UpdateIssuerOptions).
X509CertificateProperties	Właściwości składnika X509 certyfikatu.

Aliasy typu

ActionType	Akcja, która zostanie wykonana.
ArrayOneOrMore	Tablica z jedną właściwością co najmniej.
BackupCertificateOptions	Opcje backupCertificate(string, OperationOptions).
BeginDeleteCertificateOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	Opcje <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 właściwości contentType. Możliwe wartości obejmują: "application/x-pem-file", "application/x-pkcs12"
CertificateKeyCurveName	Nazwa krzywej eliptycznej. Aby uzyskać prawidłowe wartości, zobacz 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: Krzywa eliptyczna NIST P-256, krzywa AKA SECG SECP256R1. P-384: krzywa eliptyczna NIST P-384, krzywa AKA SECG SECP384R1. P-521: krzywa eliptyczna NIST P-521, krzywa AKA SECG SECP521R1. P-256K: krzywa eliptyczna SECG SECP256K1.
CertificateKeyType	Typ pary kluczy, która ma być używana dla certyfikatu. <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ę EC: Krzywa eliptyczna. ec-HSM: Krzywa eliptyczna z kluczem prywatnym, który nie można wyeksportować z modułu HSM. rsa: RSA (https://tools.ietf.org/html/rfc3447). RSA-HSM: RSA z kluczem prywatnym, który nie można wyeksportować z modułu HSM. października: sekwencja oktetu (używana do reprezentowania kluczy symetrycznych). oct-HSM: sekwencja octet z kluczem prywatnym, który nie można wyeksportować z modułu 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 deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	Publiczna reprezentacja stanu operacji DeleteCertificatePoller.
DeleteContactsOptions	Opcje deleteContacts(OperationOptions).
DeleteIssuerOptions	Opcje deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania. <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 zezwala na 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: oznacza 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) 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 getCertificateOperation(string, CertificatePollerOptions).
GetCertificateOptions	Opcje getCertificate(string, OperationOptions).
GetCertificatePolicyOptions	Opcje getCertificatePolicy(string, OperationOptions).
GetCertificateVersionOptions	Opcje getCertificateVersion(string, string, OperationOptions).
GetContactsOptions	Opcje getContacts(OperationOptions).
GetDeletedCertificateOptions	Opcje getDeletedCertificate(string, OperationOptions).
GetIssuerOptions	Opcje getIssuer(string, OperationOptions).
GetPlainCertificateOperationOptions	Opcje <xref:getPlainCertificateOperation>.
ImportCertificatePolicy	Typ reprezentujący zasady certyfikatu do zaimportowania, który nie wymaga sieci SAN lub podmiotu
KVPollerLike	Przestarzała kopia keyVault pollerLike core-lro.
KeyUsageType	Obsługiwane użycie klucza certyfikatu. <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: wskazuje, że klucz certyfikatu może być używany jako podpis cyfrowy. nonRepudiation : wskazuje, że klucz certyfikatu może być używany do uwierzytelniania. keyEncipherment: wskazuje, że klucz certyfikatu może być używany do szyfrowania kluczy. dataEncipherment: wskazuje, że klucz certyfikatu może być używany do szyfrowania danych. keyAgreement: wskazuje, że klucz certyfikatu może służyć do określania umowy klucza, takiej jak klucz utworzony przy użyciu algorytmu umowy klucza Diffie-Hellman. keyCertSign: wskazuje, że klucz certyfikatu może służyć do podpisywania certyfikatów. cRLSign: wskazuje, że klucz certyfikatu może służyć do podpisywania listy odwołania certyfikatów. encipherOnly: wskazuje, że klucz certyfikatu może być używany tylko do szyfrowania. rozszyfrowaćOnly: wskazuje, że klucz certyfikatu może być używany tylko do odszyfrowywania.
ListPropertiesOfCertificateVersionsOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfCertificateVersions(string, OperationOptions).
ListPropertiesOfIssuersOptions	Interfejs reprezentujący opcjonalne parametry dla operacji stronicowanych CertificateClient przekazanych do listPropertiesOfIssuers(OperationOptions).
MergeCertificateOptions	Interfejs reprezentujący parametry opcjonalne dla mergeCertificate(string, Uint8Array[], OperationOptions).
PurgeDeletedCertificateOptions	Opcje purgeDeletedCertificate(string, OperationOptions).
RecoverDeletedCertificateState	Przestarzałe: publiczna reprezentacja odzyskiwania usuniętej operacji sondowania certyfikatu
RequireAtLeastOne	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.
RestoreCertificateBackupOptions	Interfejs reprezentujący parametry opcjonalne dla restoreCertificateBackup(Uint8Array, OperationOptions).
SetContactsOptions	Opcje setContacts(CertificateContact[], OperationOptions).
SubjectAlternativeNames	Alternatywy dla właściwości podmiotu. Jeśli istnieje, powinien mieć co najmniej jedną z właściwości SubjectAlternativeNamesAll.
UpdateCertificatePolicyOptions	Opcje updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Wyliczenia

KnownCertificateKeyCurveNames	Znane wartości CertificateKeyCurveName akceptowane przez usługę.
KnownCertificateKeyTypes	Znane wartości CertificateKeyType akceptowane przez usługę.
KnownDeletionRecoveryLevels	Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
KnownKeyUsageTypes	Znane wartości KeyUsageType akceptowane przez usługę.
WellKnownIssuer	Dobrze znani wystawcy do wybierania wartości domyślnej

Funkcje

parseKeyVaultCertificateIdentifier(string)

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

https://< nazwa-magazynu.vault.azure.net/certificates/<> nazwa-certyfikatu>/<unikatowy-identyfikator-wersji->

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

Szczegóły funkcji

parseKeyVaultCertificateIdentifier(string)

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

https://< nazwa-magazynu.vault.azure.net/certificates/<> nazwa-certyfikatu>/<unikatowy-identyfikator-wersji->

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

function parseKeyVaultCertificateIdentifier(id: string): KeyVaultCertificateIdentifier

Parametry

id: string

Identyfikator certyfikatu usługi Key Vault.

Zwraca

KeyVaultCertificateIdentifier

Udostępnij za pośrednictwem

@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