@azure/keyvault-certificates package

Referenz

Klassen

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 Sicherungsblob enthält.
BeginCreateCertificateOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginCreateCertificate(string, CertificatePolicy, BeginCreateCertificateOptions)
CertificateClientOptions	Die optionalen Parameter, die vom CertificateClient des 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 des 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)übergeben werden können, beginDeleteCertificate(string, CertificatePollerOptions) und beginRecoverDeletedCertificate(string, CertificatePollerOptions)
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	Das Fehlermodell des Schlüsseltresorsservers.
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, aus denen eine Key Vault Zertifikat-ID besteht.
KeyVaultCertificatePollOperationState	Eine Schnittstelle, die die öffentliche Form des Zustands einer Key Vault Vorgänge des Zertifikatabfrages darstellt.
KeyVaultCertificateWithPolicy	Eine Schnittstelle, die ein Zertifikat mit seiner Richtlinie darstellt
LifetimeAction	Aktion und der zugehörige Trigger, der von Key Vault während der Lebensdauer eines Zertifikats ausgeführt wird.
ListDeletedCertificatesOptions	Eine Schnittstelle, die optionale Parameter für ausgelagerte CertificateClient-Vorgänge darstellt, die an listDeletedCertificates(ListDeletedCertificatesOptions)übergeben werden.
ListPropertiesOfCertificatesOptions	Eine Schnittstelle, die optionale Parameter für ausgelagerte CertificateClient-Vorgänge 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.
SubjectAlternativeNamesAll	Eine Schnittstelle, die die alternativen Namen des Antragstellers 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 übergeben werden können beginDeleteCertificate(string, CertificatePollerOptions)
BeginRecoverDeletedCertificateOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an übergeben werden können beginRecoverDeletedCertificate(string, CertificatePollerOptions)
CancelCertificateOperationOptions	Optionen für <xref:cancelCertificateOperation>.
CertificateContact	Die Kontaktinformationen für die Tresorzertifikate. Jeder Kontakt verfügt mindestens über eine der Eigenschaften von CertificateContactAll, die wie folgt lauten: emailAddress, name oder phone.
CertificateContentType	Definiert Werte für contentType. Mögliche Werte: "application/x-pem-file", "application/x-pkcs12"
CertificateKeyCurveName	Definiert Werte für JsonWebKeyCurveName. <xref:KnownJsonWebKeyCurveName> kann austauschbar mit JsonWebKeyCurveName verwendet werden. Diese Enumeration enthält 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> kann austauschbar mit JsonWebKeyType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden EC EC-HSM RSA RSA-HSM oct 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 Zeichenfolgenschlüssel-Wert-Paare.
CreateCertificateState	Die öffentliche Darstellung des CreateCertificatePoller-Vorgangsstatus.
DeleteCertificateOperationOptions	Optionen für deleteCertificateOperation(string, OperationOptions).
DeleteCertificateState	Die öffentliche Darstellung des DeleteCertificatePoller-Vorgangsstatus.
DeleteContactsOptions	Optionen für deleteContacts(OperationOptions).
DeleteIssuerOptions	Optionen für deleteIssuer(string, OperationOptions).
DeletionRecoveryLevel	Definiert Werte für DeletionRecoveryLevel. <xref:KnownDeletionRecoveryLevel> kann austauschbar mit DeletionRecoveryLevel verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Bereinigend: Gibt einen Tresorzustand an, in dem das Löschen ein irreversibler Vorgang ist, ohne dass eine Wiederherstellung möglich ist. Diese Ebene entspricht keinem Schutz vor einem Löschvorgang. Die Daten sind unwiederbringlich verloren, wenn Sie einen Löschvorgang auf Entitätsebene oder höher (Tresor, Ressourcengruppe, Abonnement usw.) akzeptieren. Wiederherstellbar+Bereinigungsfähig: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann und der auch das sofortige und dauerhafte Löschen (d. h. löschen) zulässt. Diese Ebene 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. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird Wiederherstellbar: Gibt einen Tresorzustand an, in dem der Löschvorgang wiederhergestellt werden kann, ohne dass die Möglichkeit einer sofortigen und dauerhaften Löschung (d. h. bereinigen) besteht. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls (90 Tage) und solange das Abonnement noch verfügbar ist. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird Wiederherstellbar+ProtectedSubscription: Gibt einen Tresor- und Abonnementstatus an, in dem der Löschvorgang innerhalb eines Aufbewahrungsintervalls (90 Tage) wiederhergestellt werden kann, sofortiges und dauerhaftes Löschen (d. h. Löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann. System wird es nach 90 Tagen endgültig löschen, wenn es nicht wiederhergestellt wird CustomizedRecoverable+Purgeable: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, und der auch das sofortige und dauerhafte Löschen zulässt (d. h. löschen, wenn 7< = SoftDeleteRetentionInDays < 90). Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls, es sei denn, es wird ein Bereinigungsvorgang angefordert oder das Abonnement gekündigt. CustomizedRecoverable: Gibt einen Tresorzustand an, in dem das Löschen wiederhergestellt werden kann, ohne die Möglichkeit eines sofortigen und dauerhaften Löschens (d. h. Löschvorgang, wenn 7< = SoftDeleteRetentionInDays < 90) ist. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und solange das Abonnement noch verfügbar ist. CustomizedRecoverable+ProtectedSubscription: Gibt einen Tresor- und Abonnementzustand an, in dem das Löschen wiederhergestellt werden kann, sofortiges und dauerhaftes Löschen (d. h. löschen) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft gekündigt werden kann, wenn 7<= SoftDeleteRetentionInDays < 90. Diese Ebene garantiert die Wiederherstellbarkeit der gelöschten Entität während des Aufbewahrungsintervalls und spiegelt auch die Tatsache wider, dass das Abonnement selbst nicht gekündigt 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 den kein SAN oder ein Antragsteller erforderlich ist.
KVPollerLike	Veraltete KeyVault-Kopie von PollerLike von core-lro.
KeyUsageType	Definiert Werte für KeyUsageType. <xref:KnownKeyUsageType> kann austauschbar mit KeyUsageType verwendet werden. Diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Digitalsignature nonRepudiation keyEncipherment dataEncipherment keyAgreement keyCertSign cRLSign encipherOnly decipherOnly
ListPropertiesOfCertificateVersionsOptions	Eine Schnittstelle, die optionale Parameter für ausgelagerte CertificateClient-Vorgänge darstellt, die an listPropertiesOfCertificateVersions(string, OperationOptions)übergeben werden.
ListPropertiesOfIssuersOptions	Eine Schnittstelle, die optionale Parameter für ausgelagerte CertificateClient-Vorgänge 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 Zertifikatabfragevorgangs
RequireAtLeastOne	RequireAtLeastOne hilft beim Erstellen eines Typs, in dem mindestens eine der Eigenschaften einer Schnittstelle (kann eine beliebige Eigenschaft sein) vorhanden sein muss. 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 den gleichen Namen wie jede Eigenschaft von T hat. `Required<Pick<T, K>>` erstellt einen neuen Typ aus T mit nur der aktuellen Eigenschaft in der Iteration und markiert ihn als erforderlich. `Partial<Pick<T, Exclude<keyof T, K>>>` erstellt einen neuen Typ mit allen Eigenschaften von T, mit Ausnahme der Eigenschaft K. `&` vereint den Typ mit nur einer erforderlichen Eigenschaft von mit `Required<...>` allen optionalen Eigenschaften von `Partial<...>`. `[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. Falls vorhanden, sollte sie mindestens eine der Eigenschaften von SubjectAlternativeNamesAll aufweisen.
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. Ein Beispiel hierfür ist:

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. Ein Beispiel hierfür ist:

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 Key Vault-Zertifikats.

Gibt zurück

KeyVaultCertificateIdentifier

@azure/keyvault-certificates package

Klassen

Schnittstellen

Typaliase

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Bekannte Werte, die vom Dienst unterstützt werden

Enumerationen

Functions

Details zur Funktion

parseKeyVaultCertificateIdentifier(string)

Parameter

Gibt zurück

Zusätzliche Ressourcen