@azure/keyvault-certificates package

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

Details des Organisationsadministrators des Zertifikatausstellers.

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

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

Die optionalen Parameter, die vom CertificateClient von KeyVault akzeptiert werden

Die Form der Kontaktinformationen für die Tresorzertifikate.

Eine Schnittstelle, die die Eigenschaften eines Ausstellers darstellt.

Bei asynchronen Anforderungen wird ein Zertifikatvorgang zurückgegeben.

Der Schlüsseltresorserverfehler.

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

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

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

Eine Schnittstelle, die die Eigenschaften eines Zertifikats darstellt

Die alternativen Antragstellernamen eines X509-Objekts.

Optionen für <xref:createCertificate>.

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

Eine Schnittstelle, die ein gelöschtes Zertifikat darstellt.

Fehlermodell des Key Vault-Servers.

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

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

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

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

Eine Schnittstelle, die die Eigenschaften eines Zertifikatausstellers darstellt

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

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

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

Eine Schnittstelle, die ein Zertifikat mit seiner Richtlinie darstellt

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

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

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

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.

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

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

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

Optionen für <xref:updateCertificate>.

Optionen für updateIssuer(string, UpdateIssuerOptions).

Eigenschaften der X509-Komponente eines Zertifikats.

Die Aktion, die ausgeführt wird.

Ein Array mit mindestens einer Eigenschaft.

Optionen für backupCertificate(string, OperationOptions).

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

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

Optionen für <xref:cancelCertificateOperation>.

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

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

Elliptische Kurvenname. Gültige Werte finden Sie unter 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: Die NIST P-256 elliptische Kurve, AKA SECG-Kurve SECP256R1.
P-384: Die NIST P-384 elliptische Kurve, AKA SECG-Kurve SECP384R1.
P-521: Die NIST P-521 elliptische Kurve, AKA SECG-Kurve SECP521R1.
P-256K-: Die SECG-SECP256K1 elliptische Kurve.

Der Typ des Schlüsselpaars, das für das Zertifikat verwendet werden soll.
<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-: Elliptische Kurve.
EC-HSM: Elliptische Kurve mit einem privaten Schlüssel, der nicht aus dem HSM exportiert werden kann.
RSA: RSA (https://tools.ietf.org/html/rfc3447).
RSA-HSM: RSA mit einem privaten Schlüssel, der nicht aus dem HSM exportiert werden kann.
okt: Oktettsequenz (wird verwendet, um symmetrische Schlüssel darzustellen).
oct-HSM: Oktettsequenz mit einem privaten Schlüssel, der nicht aus dem HSM exportiert werden kann.

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

Die Aktion, die ausgeführt wird.

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

Die öffentliche Darstellung des Vorgangsstatus "CreateCertificatePoller".

Optionen für deleteCertificateOperation(string, OperationOptions).

Die öffentliche Darstellung des Status des DeleteCertificatePoller-Vorgangs.

Optionen für deleteContacts(OperationOptions).

Optionen für deleteIssuer(string, OperationOptions).

Gibt die Löschwiederherstellungsebene wieder, die derzeit für geheime Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der geheime Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.
<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 löschungsfähig, sofortige und dauerhafte Löschung (d. h. Löschvorgang) nicht zulässig ist und in dem das Abonnement selbst nicht dauerhaft storniert 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.

Optionen für getCertificateOperation(string, CertificatePollerOptions).

Optionen für getCertificate(string, OperationOptions).

Optionen für getCertificatePolicy(string, OperationOptions).

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

Optionen für getContacts(OperationOptions).

Optionen für getDeletedCertificate(string, OperationOptions).

Optionen für getIssuer(string, OperationOptions).

Optionen für <xref:getPlainCertificateOperation>.

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

Veraltete KeyVault-Kopie von Core-lro PollerLike.

Unterstützte Verwendungen eines Zertifikatschlüssels.
<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: Gibt an, dass der Zertifikatschlüssel als digitale Signatur verwendet werden kann.
nichtrepudiation: Gibt an, dass der Zertifikatschlüssel für die Authentifizierung verwendet werden kann.
keyEncipherment: Gibt an, dass der Zertifikatschlüssel für die Schlüsselverschlüsselung verwendet werden kann.
dataEncipherment: Gibt an, dass der Zertifikatschlüssel für die Datenverschlüsselung verwendet werden kann.
keyAgreement: Gibt an, dass der Zertifikatschlüssel verwendet werden kann, um die Schlüsselvereinbarung zu bestimmen, z. B. einen Schlüssel, der mit dem Diffie-Hellman Schlüsselvereinbarungsalgorithmus erstellt wurde.
keyCertSign: Gibt an, dass der Zertifikatschlüssel zum Signieren von Zertifikaten verwendet werden kann.
cRLSign-: Gibt an, dass der Zertifikatschlüssel zum Signieren einer Zertifikatsperrliste verwendet werden kann.
encipherOnly: Gibt an, dass der Zertifikatschlüssel nur für die Verschlüsselung verwendet werden kann.
DezipherOnly: Gibt an, dass der Zertifikatschlüssel nur für die Entschlüsselung verwendet werden kann.

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

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

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

Optionen für purgeDeletedCertificate(string, OperationOptions).

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

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.

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

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

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

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

Bekannte Werte von CertificateKeyCurveName, die der Dienst akzeptiert.

Bekannte Werte von CertificateKeyType, die der Dienst akzeptiert.

Gibt die Löschwiederherstellungsebene wieder, die derzeit für geheime Schlüssel im aktuellen Tresor wirksam ist. Wenn er "Löschbar" enthält, kann der geheime Schlüssel von einem privilegierten Benutzer endgültig gelöscht werden. andernfalls kann nur das System den geheimen Schlüssel am Ende des Aufbewahrungsintervalls löschen.

Bekannte Werte von KeyUsageType, die der Dienst akzeptiert.

Bekannte Aussteller für die Auswahl eines Standardwerts

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

https://< keyvault-name.vault.azure.net/certificates/<> certificate-name>/<unique-version-id>

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