Freigeben über


@azure/keyvault-certificates package

Klassen

CertificateClient

Der Client für die Interaktion mit der KeyVault-Zertifikatfunktionalität

Schnittstellen

AdministratorContact

Details des Organisationsadministrators des Zertifikatausstellers.

BackupCertificateResult

Das Ergebnis des Sicherungszertifikats, das das Sicherungs-BLOB enthält.

BeginCreateCertificateOptions

Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions) übergeben werden können

CertificateClientOptions

Die optionalen Parameter, die vom CertificateClient von KeyVault akzeptiert werden

CertificateContactAll

Die Form der Kontaktinformationen für die Tresorzertifikate.

CertificateIssuer

Eine Schnittstelle, die die Eigenschaften eines Ausstellers darstellt.

CertificateOperation

Bei asynchronen Anforderungen wird ein Zertifikatvorgang zurückgegeben.

CertificateOperationError

Der Schlüsseltresorserverfehler.

CertificateOperationState

Eine Schnittstelle, die die öffentlich verfügbaren Eigenschaften des Status von CertificateOperationPoller darstellt.

CertificatePolicyProperties

Eine Schnittstelle, die die Richtlinie eines Zertifikats (ohne die Betreffeigenschaften) darstellt.

CertificatePollerOptions

Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions), beginDeleteCertificate(string, CertificatePollerOptions) und beginRecoverDeletedCertificate(string, CertificatePollerOptions) übergeben werden können

CertificateProperties

Eine Schnittstelle, die die Eigenschaften eines Zertifikats darstellt

CoreSubjectAlternativeNames

Die alternativen Antragstellernamen eines X509-Objekts.

CreateCertificateOptions

Optionen für <xref:createCertificate>.

CreateIssuerOptions

Optionen für createIssuer(string, string, CreateIssuerOptions).

DeletedCertificate

Eine Schnittstelle, die ein gelöschtes Zertifikat darstellt.

ErrorModel

Fehlermodell des Key Vault-Servers.

ImportCertificateOptions

Optionen für importCertificate(string, Uint8Array, ImportCertificateOptions).

IssuerAttributes

Die Attribute eines Ausstellers, der vom Key Vault-Dienst verwaltet wird.

IssuerCredentials

Die Anmeldeinformationen, die für den Zertifikataussteller verwendet werden sollen.

IssuerParameters

Parameter für den Aussteller der X509-Komponente eines Zertifikats.

IssuerProperties

Eine Schnittstelle, die die Eigenschaften eines Zertifikatausstellers darstellt

KeyVaultCertificate

Eine Schnittstelle, die ein Zertifikat ohne die Richtlinie des Zertifikats darstellt

KeyVaultCertificateIdentifier

Stellt die Segmente dar, die eine Key Vault-Zertifikat-ID erstellen.

KeyVaultCertificatePollOperationState

Eine Schnittstelle, die das öffentliche Shape des Zustands der Vorgänge eines Key Vault-Zertifikatsabfragers darstellt.

KeyVaultCertificateWithPolicy

Eine Schnittstelle, die ein Zertifikat mit seiner Richtlinie darstellt

LifetimeAction

Aktion und deren Auslöser, die von Key Vault während der Lebensdauer eines Zertifikats ausgeführt werden.

ListDeletedCertificatesOptions

Eine Schnittstelle, die optionale Parameter für Paged-Vorgänge des CertificateClient darstellt, die an listDeletedCertificates(ListDeletedCertificatesOptions)übergeben werden.

ListPropertiesOfCertificatesOptions

Eine Schnittstelle, die optionale Parameter für Paged-Vorgänge des CertificateClient darstellt, die an listPropertiesOfCertificates(ListPropertiesOfCertificatesOptions)übergeben werden.

PolicySubjectProperties

Eine Schnittstelle, die die möglichen Betreffeigenschaften der Richtlinie eines Zertifikats darstellt. Für den endgültigen Typ muss mindestens eine dieser Eigenschaften vorhanden sein.

PollerLike

Abstrakte Darstellung eines Pollers, die nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss.

PollerLikeWithCancellation

Abstrakte Darstellung eines Pollers, die nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss.

SubjectAlternativeNamesAll

Eine Schnittstelle, die die alternativen Namen des Betreffs einer Zertifikatrichtlinie darstellt.

UpdateCertificateOptions

Optionen für <xref:updateCertificate>.

UpdateIssuerOptions

Optionen für updateIssuer(string, UpdateIssuerOptions).

X509CertificateProperties

Eigenschaften der X509-Komponente eines Zertifikats.

Typaliase

ActionType

Definiert Werte für ActionType.

ArrayOneOrMore

Ein Array mit mindestens einer Eigenschaft.

BackupCertificateOptions

Optionen für backupCertificate(string, OperationOptions).

BeginDeleteCertificateOptions

Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginDeleteCertificate(string, CertificatePollerOptions) übergeben werden können

BeginRecoverDeletedCertificateOptions

Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginRecoverDeletedCertificate(string, CertificatePollerOptions) übergeben werden können

CancelCertificateOperationOptions

Optionen für <xref:cancelCertificateOperation>.

CertificateContact

Die Kontaktinformationen für die Tresorzertifikate. Jeder Kontakt verfügt über mindestens eine der Eigenschaften von CertificateContactAll, also E-MailAddress, Name oder Telefon.

CertificateContentType

Definiert Werte für contentType. Mögliche Werte sind: "application/x-pem-file", "application/x-pkcs12"

CertificateKeyCurveName

Definiert Werte für JsonWebKeyCurveName.
<xref:KnownJsonWebKeyCurveName> austauschbar mit JsonWebKeyCurveName verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

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

CertificateKeyType

Definiert Werte für JsonWebKeyType.
<xref:KnownJsonWebKeyType> austauschbar mit JsonWebKeyType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

EC-
EC-HSM-
RSA-
RSA-HSM-
okt
oct-HSM-

CertificatePolicy

Ein Typ, der die Richtlinie eines Zertifikats mit mindestens einer der Betreffeigenschaften darstellt.

CertificatePolicyAction

Die Aktion, die ausgeführt wird.

CertificateTags

Eine Schnittstelle, die die Form der Zertifikattags darstellt. Die Tags sind nur Zeichenfolgen-Schlüssel-Wert-Paare.

CreateCertificateState

Die öffentliche Darstellung des Vorgangsstatus "CreateCertificatePoller".

DeleteCertificateOperationOptions

Optionen für deleteCertificateOperation(string, OperationOptions).

DeleteCertificateState

Die öffentliche Darstellung des Status des DeleteCertificatePoller-Vorgangs.

DeleteContactsOptions

Optionen für deleteContacts(OperationOptions).

DeleteIssuerOptions

Optionen für deleteIssuer(string, OperationOptions).

DeletionRecoveryLevel

Definiert Werte für DeletionRecoveryLevel.
<xref:KnownDeletionRecoveryLevel> austauschbar mit DeletionRecoveryLevel verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

bereinigungsfähig: Gibt einen Tresorstatus an, in dem das Löschen ein unumkehrbarer Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Stufe entspricht keinem Schutz vor einem Löschvorgang; die Daten werden unwiderruflich verloren, wenn sie einen Löschvorgang auf Entitätsebene oder höher akzeptieren (Tresor, Ressourcengruppe, Abonnement usw.)
Wiederherstellbare+bereinigungsfähige: Gibt einen Tresorstatus an, in dem die Löschung wiederherstellbar ist und die auch sofortige und dauerhafte Löschung (d. h. Löschvorgang) zulässt. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage), es sei denn, ein Bereinigungsvorgang wird angefordert, oder das Abonnement wird gekündigt. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt.
Wiederherstellbare: Gibt einen Tresorstatus an, in dem die Löschung ohne die Möglichkeit zum sofortigen und dauerhaften Löschen (d. h. Löschen) wiederhergestellt werden kann. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und während das Abonnement noch verfügbar ist. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt.
Wiederherstellbare+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem die Löschung innerhalb des Aufbewahrungsintervalls (90 Tage), sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft storniert werden kann. Das System löscht es nach 90 Tagen dauerhaft, falls nicht wiederhergestellt.
CustomRecoverable+Purgeable: Gibt einen Tresorstatus an, in dem die Löschung wiederherstellbar ist und die auch sofortige und dauerhafte Löschung ermöglicht (d. h. 7<= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, ein Löschvorgang wird angefordert, oder das Abonnement wird gekündigt.
CustomRecoverable: Gibt einen Tresorstatus an, in dem die Löschung ohne die Möglichkeit zum sofortigen und dauerhaften Löschen wiederhergestellt werden kann (d. h. 7<= SoftDeleteRetentionInDays < 90). Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und während der Verfügbarkeit des Abonnements.
CustomRecoverable+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem die Löschung wiederherstellbar, sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Stufe garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht storniert werden kann.

GetCertificateOperationOptions

Optionen für getCertificateOperation(string, CertificatePollerOptions).

GetCertificateOptions

Optionen für getCertificate(string, OperationOptions).

GetCertificatePolicyOptions

Optionen für getCertificatePolicy(string, OperationOptions).

GetCertificateVersionOptions

Optionen für getCertificateVersion(string, string, OperationOptions).

GetContactsOptions

Optionen für getContacts(OperationOptions).

GetDeletedCertificateOptions

Optionen für getDeletedCertificate(string, OperationOptions).

GetIssuerOptions

Optionen für getIssuer(string, OperationOptions).

GetPlainCertificateOperationOptions

Optionen für <xref:getPlainCertificateOperation>.

ImportCertificatePolicy

Ein Typ, der die Richtlinie eines Zertifikats für den Import darstellt, für die kein SAN oder ein Antragsteller erforderlich ist

KVPollerLike

Veraltete KeyVault-Kopie von Core-lro PollerLike.

KeyUsageType

Definiert Werte für KeyUsageType.
<xref:KnownKeyUsageType> austauschbar mit KeyUsageType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

digitalSignature-

keyEncipherment-
dataEncipherment-
keyAgreement-
keyCertSign-
cRLSign-
encipherOnly
dezipherOnly

ListPropertiesOfCertificateVersionsOptions

Eine Schnittstelle, die optionale Parameter für Paged-Vorgänge des CertificateClient darstellt, die an listPropertiesOfCertificateVersions(string, OperationOptions)übergeben werden.

ListPropertiesOfIssuersOptions

Eine Schnittstelle, die optionale Parameter für Paged-Vorgänge des CertificateClient darstellt, die an listPropertiesOfIssuers(OperationOptions)übergeben werden.

MergeCertificateOptions

Eine Schnittstelle, die optionale Parameter für mergeCertificate(string, Uint8Array[], OperationOptions)darstellt.

PurgeDeletedCertificateOptions

Optionen für purgeDeletedCertificate(string, OperationOptions).

RecoverDeletedCertificateState

Veraltet: Öffentliche Darstellung der Wiederherstellung eines gelöschten Zertifikatabfragvorgangs

RequireAtLeastOne

RequireAtLeastOne hilft beim Erstellen eines Typs, bei dem mindestens eine der Eigenschaften einer Schnittstelle (kann eine beliebige Eigenschaft sein) vorhanden ist.

Dies funktioniert aufgrund der Hilfsprogrammtypen von TypeScript: https://www.typescriptlang.org/docs/handbook/utility-types.html Lassen Sie uns dies untersuchen:

  • [K in keyof T]-? diese Eigenschaft (K) ist nur gültig, wenn sie denselben Namen wie jede Eigenschaft von T hat.
  • Required<Pick<T, K>> einen neuen Typ von T mit nur der aktuellen Eigenschaft in der Iteration erstellt und als erforderlich markiert
  • Partial<Pick<T, Exclude<keyof T, K>>> einen neuen Typ mit allen Eigenschaften von T, mit Ausnahme der Eigenschaft K.
  • & wird der Typ mit nur einer erforderlichen Eigenschaft aus Required<...> mit allen optionalen Eigenschaften aus Partial<...>vereint.
  • [keyof T] stellt sicher, dass nur Eigenschaften von T zulässig sind.
RestoreCertificateBackupOptions

Eine Schnittstelle, die optionale Parameter für restoreCertificateBackup(Uint8Array, OperationOptions)darstellt.

SetContactsOptions

Optionen für setContacts(CertificateContact[], OperationOptions).

SubjectAlternativeNames

Alternativen zur Subject-Eigenschaft. Wenn vorhanden, sollte mindestens eine der Eigenschaften von SubjectAlternativeNamesAll vorhanden sein.

UpdateCertificatePolicyOptions

Optionen für updateCertificatePolicy(string, CertificatePolicy, OperationOptions).

Enumerationen

KnownCertificateKeyCurveNames

Bekannte Werte von CertificateKeyCurveName, die der Dienst akzeptiert.

KnownCertificateKeyTypes

Bekannte Werte von CertificateKeyType, die der Dienst akzeptiert.

KnownDeletionRecoveryLevels

Bekannte Werte von DeletionRecoveryLevel, die der Dienst akzeptiert.

KnownKeyUsageTypes

Bekannte Werte von KeyUsageType, die der Dienst akzeptiert.

WellKnownIssuer

Bekannte Aussteller für die Auswahl eines Standardwerts

Functions

parseKeyVaultCertificateIdentifier(string)

Analysiert die angegebene Key Vault-Zertifikat-ID. Beispiel:

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

Bei der Analyse der obigen ID gibt diese Funktion Folgendes zurück:

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

Details zur Funktion

parseKeyVaultCertificateIdentifier(string)

Analysiert die angegebene Key Vault-Zertifikat-ID. Beispiel:

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

Bei der Analyse der obigen ID gibt diese Funktion Folgendes zurück:

  {
     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

Parameter

id

string

Die ID des Schlüsseltresorzertifikats.

Gibt zurück