CertificateClient Klasse

Eine allgemeine Schnittstelle zum Verwalten der Zertifikate eines Tresors.

Vererbung

azure.keyvault.certificates._shared.client_base.KeyVaultClientBase

CertificateClient

Konstruktor

CertificateClient(vault_url: str, credential: TokenCredential, **kwargs)

Parameter

vault_url

str

Erforderlich

URL des Tresors, auf den der Client zugreift. Dies wird auch als "DNS-Name" des Tresors bezeichnet. Sie sollten überprüfen, ob diese URL auf eine gültige Key Vault-Ressource verweist. Einzelheiten dazu finden Sie unter https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Erforderlich

Ein -Objekt, das ein Zugriffstoken für den Tresor bereitstellen kann, z. B. Anmeldeinformationen von identity

api_version

ApiVersion

Version der zu verwendenden Dienst-API. Standardmäßig wird der neueste Standardwert verwendet.

verify_challenge_resource

bool

Gibt an, ob die Authentifizierungsanforderungsressource mit der Key Vault Domäne übereinstimmt. Der Standardwert ist „True“.

Methoden

backup_certificate	Sichern Eines Zertifikats in einer geschützten Form, die nur von Azure Key Vault verwendet werden kann. Erfordert Zertifikate/Sicherungsberechtigungen. Dies soll das Kopieren eines Zertifikats aus einem Tresor in einen anderen ermöglichen. Beide Tresore müssen demselben Azure-Abonnement gehören. Außerdem können Sicherungen/Wiederherstellungen nicht über geopolitische Grenzen hinweg durchgeführt werden. Beispielsweise kann eine Sicherung aus einem Tresor in einer Region der USA nicht in einem Tresor in einer EU-Region wiederhergestellt werden.
begin_create_certificate	Erstellt ein neues Zertifikat. Wenn dies die erste Version ist, wird die Zertifikatressource erstellt. Für diesen Vorgang ist die Berechtigung für Zertifikate bzw. die Erstellung erforderlich. Das Warten auf den zurückgegebenen Poller erfordert die Zertifikate/get-Berechtigung und gibt Ihnen das Zertifikat, wenn die Erstellung erfolgreich ist, oder die CertificateOperation, falls nicht – andernfalls wird ein HttpResponseErrorausgelöst.
begin_delete_certificate	Löschen Sie alle Versionen eines Zertifikats. Erfordert Zertifikate/Löschberechtigungen. Wenn diese Methode Key Vault mit dem Löschen des Zertifikats begonnen hat. Das Löschen kann in einem Tresor mit aktiviertem vorläufigem Löschen mehrere Sekunden dauern. Diese Methode gibt daher einen Poller zurück, mit dem Sie auf den Abschluss des Löschvorgangs warten können.
begin_recover_deleted_certificate	Wiederherstellen eines gelöschten Zertifikats auf die neueste Version. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist. Erfordert Zertifikate/Wiederherstellungsberechtigungen. Wenn diese Methode zurückgibt, Key Vault mit der Wiederherstellung des Zertifikats begonnen hat. Die Wiederherstellung kann einige Sekunden dauern. Diese Methode gibt daher einen Poller zurück, mit dem Sie warten können, bis die Wiederherstellung abgeschlossen ist. Warten ist nur erforderlich, wenn Sie das wiederhergestellte Zertifikat sofort in einem anderen Vorgang verwenden möchten.
cancel_certificate_operation	Bricht einen laufenden Zertifikatvorgang ab. Erfordert die Zertifikat-/Updateberechtigung.
close	Schließen Sie Sockets, die vom Client geöffnet werden. Das Aufrufen dieser Methode ist nicht erforderlich, wenn der Client als Kontext-Manager verwendet wird.
create_issuer	Legt den angegebenen Zertifikataussteller fest. Erfordert zertifikate/setissuers-Berechtigung.
delete_certificate_operation	Löscht und beendet den Erstellungsvorgang für ein bestimmtes Zertifikat. Erfordert die Zertifikat-/Updateberechtigung.
delete_contacts	Löscht die Zertifikatkontakte für den Schlüsseltresor. Erfordert die Berechtigung zertifikate/managecontacts.
delete_issuer	Löscht den angegebenen Zertifikataussteller. Erfordert die Berechtigung zertifikate/manageissuers/deleteissuers.
get_certificate	Ruft ein Zertifikat ab, dessen Verwaltungsrichtlinie angefügt ist. Erfordert Zertifikate/Berechtigung abrufen. Akzeptiert die Version des Zertifikats nicht als Parameter. Um eine bestimmte Version des Zertifikats abzurufen, rufen Sie auf get_certificate_version.
get_certificate_operation	Ruft den Erstellungsvorgang eines Zertifikats ab. Erfordert die Zertifikate/Abrufen der Berechtigung.
get_certificate_policy	Ruft die Richtlinie für ein Zertifikat ab. Erfordert Zertifikate/Berechtigung abrufen. Gibt die angegebenen Zertifikatrichtlinienressourcen im Schlüsseltresor zurück.
get_certificate_version	Ruft eine bestimmte Version eines Zertifikats ab, ohne seine Verwaltungsrichtlinie zurückzugeben. Erfordert Zertifikate/Berechtigung abrufen. Rufen get_certificateSie auf, um die neueste Version des Zertifikats abzurufen oder auch die Richtlinie des Zertifikats abzurufen.
get_contacts	Ruft die Zertifikatkontakte für den Schlüsseltresor ab. Erfordert die Berechtigung zertifikate/managecontacts.
get_deleted_certificate	Rufen Sie ein gelöschtes Zertifikat ab. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist. Erfordert Zertifikate/Berechtigung abrufen. Ruft die gelöschten Zertifikatinformationen sowie die zugehörigen Attribute ab, z. B. Aufbewahrungsintervall, geplantes dauerhaftes Löschen und die aktuelle Löschwiederherstellungsebene.
get_issuer	Ruft den angegebenen Zertifikataussteller ab. Erfordert die Berechtigung zertifikate/manageissuers/getissuers.
import_certificate	Importieren Sie ein extern erstelltes Zertifikat. Erfordert Zertifikate/Importberechtigungen. Importiert ein vorhandenes gültiges Zertifikat mit einem privaten Schlüssel in Azure Key Vault. Das zu importierende Zertifikat kann im PFX- oder PEM-Format vorliegen. Wenn das Zertifikat im PEM-Format vorliegt, muss die PEM-Datei sowohl den Schlüssel als auch x509-Zertifikate enthalten, und Sie müssen ein policy mit content_type von pemangeben.
list_deleted_certificates	Listet die derzeit wiederherstellbaren gelöschten Zertifikate auf. Nur möglich, wenn der Tresor vorläufiges Löschen aktiviert ist. Erfordert zertifikate/get/list-Berechtigung. Ruft die Zertifikate im aktuellen Tresor ab, die sich in einem gelöschten Zustand befinden und zur Wiederherstellung oder Zum Löschen bereit sind. Dieser Vorgang enthält löschspezifische Informationen.
list_properties_of_certificate_versions	Listen Sie die Bezeichner und Eigenschaften der Versionen eines Zertifikats auf. Erfordert Zertifikate/Listenberechtigungen.
list_properties_of_certificates	Listet Bezeichner und Eigenschaften aller Zertifikate im Tresor auf. Erfordert Zertifikate/Listenberechtigungen.
list_properties_of_issuers	Listet die Eigenschaften der Zertifikataussteller für den Schlüsseltresor auf. Erfordert die Berechtigung zertifikate/manageissuers/getissuers.
merge_certificate	Führt ein Zertifikat oder eine Zertifikatkette mit einem Schlüsselpaar zusammen, das auf dem Server vorhanden ist. Benötigt die Berechtigung für Zertifikate bzw. die Erstellung. Führt die Zusammenführung eines Zertifikats oder einer Zertifikatkette mit einem Schlüsselpaar aus, das derzeit im Dienst verfügbar ist. Stellen Sie beim Erstellen des zu zusammenführenden begin_create_certificate Zertifikats sicher, dass Sie dessen Aussteller auf "Unbekannt" festlegen. Auf diese Weise weiß Key Vault, dass das Zertifikat nicht von einem ihr bekannten Aussteller signiert wird.
purge_deleted_certificate	Löscht ein gelöschtes Zertifikat endgültig. Nur in Tresoren möglich, bei denen vorläufiges Löschen aktiviert ist. Erfordert Zertifikate/Löschberechtigungen. Führt ein irreversibles Löschen des angegebenen Zertifikats ohne Möglichkeit zur Wiederherstellung durch. Der Vorgang ist nicht verfügbar, wenn " recovery_level Löschbar" nicht angegeben wird. Diese Methode ist nur erforderlich, um ein Zertifikat vor seinem scheduled_purge_datezu bereinigen.
restore_certificate_backup	Stellen Sie eine Zertifikatsicherung im Tresor wieder her. Erfordert Zertifikate/Wiederherstellungsberechtigungen. Dadurch werden alle Versionen des Zertifikats mit namen, attributen und Zugriffssteuerungsrichtlinien wiederhergestellt. Wenn der Name des Zertifikats bereits verwendet wird, schlägt die Wiederherstellung fehl. Außerdem muss der Zieltresor demselben Microsoft Azure-Abonnement wie der Quelltresor gehören.
send_request	Führt eine Netzwerkanforderung mithilfe der vorhandenen Pipeline des Clients aus. Die Anforderungs-URL kann relativ zur Tresor-URL sein. Sofern nicht anders angegeben, ist die für die Anforderung verwendete Dienst-API-Version mit der des Clients identisch. Diese Methode löst nicht aus, wenn die Antwort ein Fehler ist. Um eine Ausnahme auszulösen, rufen Sie raise_for_status() für das zurückgegebene Antwortobjekt auf. Weitere Informationen zum Senden benutzerdefinierter Anforderungen mit dieser Methode finden Sie unter https://aka.ms/azsdk/dpcodegen/python/send_request.
set_contacts	Legt die Zertifikatkontakte für den Schlüsseltresor fest. Erfordert die Berechtigung zertifikate/managecontacts.
update_certificate_policy	Updates die Richtlinie für ein Zertifikat. Erfordert Zertifikate/Updateberechtigungen. Legen Sie die angegebenen Member in der Zertifikatrichtlinie fest. Belässt andere als NULL.
update_certificate_properties	Ändern sie die Eigenschaften eines Zertifikats. Erfordert Zertifikate/Updateberechtigungen.
update_issuer	Updates den angegebenen Zertifikataussteller. Erfordert zertifikate/setissuers-Berechtigung.

backup_certificate

Sichern Eines Zertifikats in einer geschützten Form, die nur von Azure Key Vault verwendet werden kann.

Erfordert Zertifikate/Sicherungsberechtigungen. Dies soll das Kopieren eines Zertifikats aus einem Tresor in einen anderen ermöglichen. Beide Tresore müssen demselben Azure-Abonnement gehören. Außerdem können Sicherungen/Wiederherstellungen nicht über geopolitische Grenzen hinweg durchgeführt werden. Beispielsweise kann eine Sicherung aus einem Tresor in einer Region der USA nicht in einem Tresor in einer EU-Region wiederhergestellt werden.

backup_certificate(certificate_name: str, **kwargs) -> bytes

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

Gibt zurück

Das Sicherungsblob, das das gesicherte Zertifikat enthält.

Rückgabetyp

bytes

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

begin_create_certificate

Erstellt ein neues Zertifikat.

Wenn dies die erste Version ist, wird die Zertifikatressource erstellt. Für diesen Vorgang ist die Berechtigung für Zertifikate bzw. die Erstellung erforderlich. Das Warten auf den zurückgegebenen Poller erfordert die Zertifikate/get-Berechtigung und gibt Ihnen das Zertifikat, wenn die Erstellung erfolgreich ist, oder die CertificateOperation, falls nicht – andernfalls wird ein HttpResponseErrorausgelöst.

begin_create_certificate(certificate_name: str, policy: CertificatePolicy, **kwargs) -> LROPoller[KeyVaultCertificate | CertificateOperation]

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

policy

CertificatePolicy

Erforderlich

Die Verwaltungsrichtlinie für das Zertifikat. Entweder subject oder eine der alternativen Antragstellernameneigenschaften sind erforderlich.

enabled

bool

Gibt an, ob das Zertifikat für die Verwendung aktiviert ist.

tags

dict[str, str]

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

Gibt zurück

Ein LROPoller für den Zertifikaterstellungsvorgang. Wenn Sie auf dem Poller warten, erhalten Sie das Zertifikat, wenn die Erstellung erfolgreich ist, oder die CertificateOperation, falls nicht.

Rückgabetyp

LROPoller[KeyVaultCertificate,

CertificateOperation]

Ausnahmen

ValueError

wenn die Zertifikatrichtlinie ungültig ist,

HttpResponseError

für andere Fehler.

begin_delete_certificate

Löschen Sie alle Versionen eines Zertifikats. Erfordert Zertifikate/Löschberechtigungen.

Wenn diese Methode Key Vault mit dem Löschen des Zertifikats begonnen hat. Das Löschen kann in einem Tresor mit aktiviertem vorläufigem Löschen mehrere Sekunden dauern. Diese Methode gibt daher einen Poller zurück, mit dem Sie auf den Abschluss des Löschvorgangs warten können.

begin_delete_certificate(certificate_name: str, **kwargs) -> LROPoller[DeletedCertificate]

Parameter

certificate_name

str

Erforderlich

Der Name des zu löschenden Zertifikats.

Gibt zurück

Ein Abfrageprogramm für den Zertifikatlöschvorgang. Die Result-Methode des Pollers gibt den zurück, ohne auf den DeletedCertificate Abschluss des Löschvorgangs zu warten. Wenn für den Tresor vorläufiges Löschen aktiviert ist und Sie das Zertifikat purge_deleted_certificatesofort löschen möchten, rufen Sie zuerst die Wartemethode des Abfrageers auf. Es wird blockiert, bis der Löschvorgang abgeschlossen ist. Die Wartemethode erfordert Zertifikate/Berechtigung abrufen.

Rückgabetyp

LROPoller[DeletedCertificate]

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

begin_recover_deleted_certificate

Wiederherstellen eines gelöschten Zertifikats auf die neueste Version. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist.

Erfordert Zertifikate/Wiederherstellungsberechtigungen. Wenn diese Methode zurückgibt, Key Vault mit der Wiederherstellung des Zertifikats begonnen hat. Die Wiederherstellung kann einige Sekunden dauern. Diese Methode gibt daher einen Poller zurück, mit dem Sie warten können, bis die Wiederherstellung abgeschlossen ist. Warten ist nur erforderlich, wenn Sie das wiederhergestellte Zertifikat sofort in einem anderen Vorgang verwenden möchten.

begin_recover_deleted_certificate(certificate_name: str, **kwargs) -> LROPoller[KeyVaultCertificate]

Parameter

certificate_name

str

Erforderlich

Der Name des gelöschten Zertifikats, das wiederhergestellt werden soll

Gibt zurück

Ein Poller für den Wiederherstellungsvorgang. Die Ergebnismethode des Pollers gibt das wiederhergestellte zurück, KeyVaultCertificate ohne auf den Abschluss der Wiederherstellung zu warten. Wenn Sie das wiederhergestellte Zertifikat sofort verwenden möchten, rufen Sie die Wartemethode des Abfrageers auf, die blockiert, bis das Zertifikat zur Verwendung bereit ist. Für die Wartemethode ist die Berechtigung zertifikat/abrufen erforderlich.

Rückgabetyp

LROPoller[KeyVaultCertificate]

Ausnahmen

HttpResponseError

cancel_certificate_operation

Bricht einen laufenden Zertifikatvorgang ab. Erfordert die Zertifikat-/Updateberechtigung.

cancel_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

Gibt zurück

Der abgebrochene Zertifikatvorgang

Rückgabetyp

CertificateOperation

Ausnahmen

HttpResponseError

close

Schließen Sie Sockets, die vom Client geöffnet werden.

Das Aufrufen dieser Methode ist nicht erforderlich, wenn der Client als Kontext-Manager verwendet wird.

close() -> None

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

create_issuer

Legt den angegebenen Zertifikataussteller fest. Erfordert zertifikate/setissuers-Berechtigung.

create_issuer(issuer_name: str, provider: str, **kwargs) -> CertificateIssuer

Parameter

issuer_name

str

Erforderlich

Der Name des Herausgebers.

provider

str

Erforderlich

Der Ausstelleranbieter.

enabled

bool

Gibt an, ob der Aussteller für die Verwendung aktiviert ist.

account_id

str

Benutzername/Kontoname/Konto-ID.

password

str

Kennwort/Geheimnis/Kontoschlüssel.

organization_id

str

ID des organization

admin_contacts

list[AdministratorContact]

Kontaktdaten der organization Administratoren des Zertifikatausstellers.

Gibt zurück

Das erstellte CertificateIssuer

Rückgabetyp

CertificateIssuer

Ausnahmen

HttpResponseError

delete_certificate_operation

Löscht und beendet den Erstellungsvorgang für ein bestimmtes Zertifikat.

Erfordert die Zertifikat-/Updateberechtigung.

delete_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

Gibt zurück

Die gelöschte CertificateOperation

Rückgabetyp

CertificateOperation

Ausnahmen

HttpResponseError

delete_contacts

Löscht die Zertifikatkontakte für den Schlüsseltresor. Erfordert die Berechtigung zertifikate/managecontacts.

delete_contacts(**kwargs) -> List[CertificateContact]

Gibt zurück

Die gelöschten Kontakte für den Schlüsseltresor.

Rückgabetyp

list[CertificateContact]

Ausnahmen

HttpResponseError

delete_issuer

Löscht den angegebenen Zertifikataussteller.

Erfordert die Berechtigung zertifikate/manageissuers/deleteissuers.

delete_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parameter

issuer_name

str

Erforderlich

Der Name des Herausgebers.

Gibt zurück

CertificateIssuer

Rückgabetyp

CertificateIssuer

Ausnahmen

HttpResponseError

get_certificate

Ruft ein Zertifikat ab, dessen Verwaltungsrichtlinie angefügt ist. Erfordert Zertifikate/Berechtigung abrufen.

Akzeptiert die Version des Zertifikats nicht als Parameter. Um eine bestimmte Version des Zertifikats abzurufen, rufen Sie auf get_certificate_version.

get_certificate(certificate_name: str, **kwargs) -> KeyVaultCertificate

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats im angegebenen Tresor.

Gibt zurück

Eine instance von KeyVaultCertificate

Rückgabetyp

KeyVaultCertificate

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_certificate_operation

Ruft den Erstellungsvorgang eines Zertifikats ab. Erfordert die Zertifikate/Abrufen der Berechtigung.

get_certificate_operation(certificate_name: str, **kwargs) -> CertificateOperation

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

Gibt zurück

Das erstellte CertificateOperation

Rückgabetyp

CertificateOperation

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_certificate_policy

Ruft die Richtlinie für ein Zertifikat ab. Erfordert Zertifikate/Berechtigung abrufen.

Gibt die angegebenen Zertifikatrichtlinienressourcen im Schlüsseltresor zurück.

get_certificate_policy(certificate_name: str, **kwargs) -> CertificatePolicy

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats in einem bestimmten Schlüsseltresor.

Gibt zurück

Die Zertifikatrichtlinie

Rückgabetyp

CertificatePolicy

Ausnahmen

HttpResponseError

get_certificate_version

Ruft eine bestimmte Version eines Zertifikats ab, ohne seine Verwaltungsrichtlinie zurückzugeben.

Erfordert Zertifikate/Berechtigung abrufen. Rufen get_certificateSie auf, um die neueste Version des Zertifikats abzurufen oder auch die Richtlinie des Zertifikats abzurufen.

get_certificate_version(certificate_name: str, version: str, **kwargs) -> KeyVaultCertificate

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats im angegebenen Tresor.

version

str

Erforderlich

Die Version des Zertifikats.

Gibt zurück

Eine instance von KeyVaultCertificate

Rückgabetyp

KeyVaultCertificate

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_contacts

Ruft die Zertifikatkontakte für den Schlüsseltresor ab. Erfordert die Berechtigung zertifikate/managecontacts.

get_contacts(**kwargs) -> List[CertificateContact]

Gibt zurück

Die Zertifikatkontakte für den Schlüsseltresor.

Rückgabetyp

list[CertificateContact]

Ausnahmen

HttpResponseError

get_deleted_certificate

Rufen Sie ein gelöschtes Zertifikat ab. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist.

Erfordert Zertifikate/Berechtigung abrufen. Ruft die gelöschten Zertifikatinformationen sowie die zugehörigen Attribute ab, z. B. Aufbewahrungsintervall, geplantes dauerhaftes Löschen und die aktuelle Löschwiederherstellungsebene.

get_deleted_certificate(certificate_name: str, **kwargs) -> DeletedCertificate

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

Gibt zurück

Das gelöschte Zertifikat

Rückgabetyp

DeletedCertificate

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_issuer

Ruft den angegebenen Zertifikataussteller ab. Erfordert die Berechtigung zertifikate/manageissuers/getissuers.

get_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parameter

issuer_name

str

Erforderlich

Der Name des Herausgebers.

Gibt zurück

Der angegebene Zertifikataussteller.

Rückgabetyp

CertificateIssuer

Ausnahmen

ResourceNotFoundError

wenn der Aussteller nicht vorhanden ist,

HttpResponseError

für andere Fehler

import_certificate

Importieren Sie ein extern erstelltes Zertifikat. Erfordert Zertifikate/Importberechtigungen.

Importiert ein vorhandenes gültiges Zertifikat mit einem privaten Schlüssel in Azure Key Vault. Das zu importierende Zertifikat kann im PFX- oder PEM-Format vorliegen. Wenn das Zertifikat im PEM-Format vorliegt, muss die PEM-Datei sowohl den Schlüssel als auch x509-Zertifikate enthalten, und Sie müssen ein policy mit content_type von pemangeben.

import_certificate(certificate_name: str, certificate_bytes: bytes, **kwargs) -> KeyVaultCertificate

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

certificate_bytes

bytes

Erforderlich

Bytes des zu importierenden Zertifikatobjekts. Dieses Zertifikat muss den privaten Schlüssel enthalten.

enabled

bool

Gibt an, ob das Zertifikat für die Verwendung aktiviert ist.

tags

dict[str, str]

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

password

str

Wenn der private Schlüssel im übergebenen Zertifikat verschlüsselt ist, ist dies das Kennwort, das für die Verschlüsselung verwendet wird.

policy

CertificatePolicy

Die Verwaltungsrichtlinie für das Zertifikat. Erforderlich, wenn Sie ein Zertifikat im PEM-Format importieren, wobei content_type auf festgelegt ist pem.

Gibt zurück

Das importierte KeyVaultCertificate

Rückgabetyp

KeyVaultCertificate

Ausnahmen

HttpResponseError

list_deleted_certificates

Listet die derzeit wiederherstellbaren gelöschten Zertifikate auf. Nur möglich, wenn der Tresor vorläufiges Löschen aktiviert ist.

Erfordert zertifikate/get/list-Berechtigung. Ruft die Zertifikate im aktuellen Tresor ab, die sich in einem gelöschten Zustand befinden und zur Wiederherstellung oder Zum Löschen bereit sind. Dieser Vorgang enthält löschspezifische Informationen.

list_deleted_certificates(**kwargs) -> ItemPaged[DeletedCertificate]

Parameter

include_pending

bool

Gibt an, ob Zertifikate eingeschlossen werden sollen, die nicht vollständig gelöscht werden. Nur verfügbar für API-Versionen v7.0 und höher.

Gibt zurück

Eine iteratorähnliche instance von DeletedCertificate

Rückgabetyp

ItemPaged[DeletedCertificate]

Ausnahmen

HttpResponseError

list_properties_of_certificate_versions

Listen Sie die Bezeichner und Eigenschaften der Versionen eines Zertifikats auf.

Erfordert Zertifikate/Listenberechtigungen.

list_properties_of_certificate_versions(certificate_name: str, **kwargs) -> ItemPaged[CertificateProperties]

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats.

Gibt zurück

Eine iteratorähnliche instance von CertificateProperties

Rückgabetyp

ItemPaged[CertificateProperties]

Ausnahmen

HttpResponseError

list_properties_of_certificates

Listet Bezeichner und Eigenschaften aller Zertifikate im Tresor auf.

Erfordert Zertifikate/Listenberechtigungen.

list_properties_of_certificates(**kwargs) -> ItemPaged[CertificateProperties]

Parameter

include_pending

bool

Gibt an, ob Zertifikate eingeschlossen werden sollen, die nicht vollständig bereitgestellt werden. Nur verfügbar für API-Versionen v7.0 und höher.

Gibt zurück

Eine iteratorähnliche instance von CertificateProperties

Rückgabetyp

ItemPaged[CertificateProperties]

Ausnahmen

HttpResponseError

list_properties_of_issuers

Listet die Eigenschaften der Zertifikataussteller für den Schlüsseltresor auf.

Erfordert die Berechtigung zertifikate/manageissuers/getissuers.

list_properties_of_issuers(**kwargs) -> ItemPaged[IssuerProperties]

Gibt zurück

Eine iteratorähnliche instance von Ausstellern

Rückgabetyp

ItemPaged[CertificateIssuer]

Ausnahmen

HttpResponseError

merge_certificate

Führt ein Zertifikat oder eine Zertifikatkette mit einem Schlüsselpaar zusammen, das auf dem Server vorhanden ist.

Benötigt die Berechtigung für Zertifikate bzw. die Erstellung. Führt die Zusammenführung eines Zertifikats oder einer Zertifikatkette mit einem Schlüsselpaar aus, das derzeit im Dienst verfügbar ist. Stellen Sie beim Erstellen des zu zusammenführenden begin_create_certificate Zertifikats sicher, dass Sie dessen Aussteller auf "Unbekannt" festlegen. Auf diese Weise weiß Key Vault, dass das Zertifikat nicht von einem ihr bekannten Aussteller signiert wird.

merge_certificate(certificate_name: str, x509_certificates: List[bytes], **kwargs) -> KeyVaultCertificate

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats

x509_certificates

list[bytes]

Erforderlich

Das zu zusammenzuführende Zertifikat oder die Zertifikatkette.

enabled

bool oder None

Gibt an, ob das Zertifikat für die Verwendung aktiviert ist.

tags

dict[str, str] oder None

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

Gibt zurück

Das zusammengeführte Zertifikat

Rückgabetyp

KeyVaultCertificate

Ausnahmen

HttpResponseError

purge_deleted_certificate

Löscht ein gelöschtes Zertifikat endgültig. Nur in Tresoren möglich, bei denen vorläufiges Löschen aktiviert ist.

Erfordert Zertifikate/Löschberechtigungen. Führt ein irreversibles Löschen des angegebenen Zertifikats ohne Möglichkeit zur Wiederherstellung durch. Der Vorgang ist nicht verfügbar, wenn " recovery_level Löschbar" nicht angegeben wird. Diese Methode ist nur erforderlich, um ein Zertifikat vor seinem scheduled_purge_datezu bereinigen.

purge_deleted_certificate(certificate_name: str, **kwargs) -> None

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats

Gibt zurück

Keine

Rückgabetyp

None

Ausnahmen

HttpResponseError

restore_certificate_backup

Stellen Sie eine Zertifikatsicherung im Tresor wieder her. Erfordert Zertifikate/Wiederherstellungsberechtigungen.

Dadurch werden alle Versionen des Zertifikats mit namen, attributen und Zugriffssteuerungsrichtlinien wiederhergestellt. Wenn der Name des Zertifikats bereits verwendet wird, schlägt die Wiederherstellung fehl. Außerdem muss der Zieltresor demselben Microsoft Azure-Abonnement wie der Quelltresor gehören.

restore_certificate_backup(backup: bytes, **kwargs) -> KeyVaultCertificate

Parameter

backup

bytes

Erforderlich

Das Sicherungsblob, das einem Zertifikatpaket zugeordnet ist.

Gibt zurück

Das wiederhergestellte KeyVaultCertificate

Rückgabetyp

KeyVaultCertificate

Ausnahmen

HttpResponseError

send_request

Führt eine Netzwerkanforderung mithilfe der vorhandenen Pipeline des Clients aus.

Die Anforderungs-URL kann relativ zur Tresor-URL sein. Sofern nicht anders angegeben, ist die für die Anforderung verwendete Dienst-API-Version mit der des Clients identisch. Diese Methode löst nicht aus, wenn die Antwort ein Fehler ist. Um eine Ausnahme auszulösen, rufen Sie raise_for_status() für das zurückgegebene Antwortobjekt auf. Weitere Informationen zum Senden benutzerdefinierter Anforderungen mit dieser Methode finden Sie unter https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parameter

request

HttpRequest

Erforderlich

Die Netzwerkanforderung, die Sie stellen möchten.

stream

bool

Gibt an, ob die Antwortnutzlast gestreamt wird. Der Standardwert lautet „False“.

Gibt zurück

Die Antwort Ihres Netzwerkaufrufs. Führt keine Fehlerbehandlung für Ihre Antwort durch.

Rückgabetyp

HttpResponse

Ausnahmen

ResourceNotFoundError

wenn das Zertifikat nicht vorhanden ist,

HttpResponseError

für andere Fehler

set_contacts

Legt die Zertifikatkontakte für den Schlüsseltresor fest. Erfordert die Berechtigung zertifikate/managecontacts.

set_contacts(contacts: List[CertificateContact], **kwargs) -> List[CertificateContact]

Parameter

contacts

list[CertificateContact]

Erforderlich

Die Kontaktliste für die Tresorzertifikate.

Gibt zurück

Die erstellte Kontaktliste

Rückgabetyp

list[CertificateContact]

Ausnahmen

HttpResponseError

update_certificate_policy

Updates die Richtlinie für ein Zertifikat. Erfordert Zertifikate/Updateberechtigungen.

Legen Sie die angegebenen Member in der Zertifikatrichtlinie fest. Belässt andere als NULL.

update_certificate_policy(certificate_name: str, policy: CertificatePolicy, **kwargs) -> CertificatePolicy

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats im angegebenen Tresor.

policy

CertificatePolicy

Erforderlich

Die Richtlinie für das Zertifikat.

Gibt zurück

Die Zertifikatrichtlinie

Rückgabetyp

CertificatePolicy

Ausnahmen

HttpResponseError

update_certificate_properties

Ändern sie die Eigenschaften eines Zertifikats. Erfordert Zertifikate/Updateberechtigungen.

update_certificate_properties(certificate_name: str, version: str | None = None, **kwargs) -> KeyVaultCertificate

Parameter

certificate_name

str

Erforderlich

Der Name des Zertifikats im angegebenen Schlüsseltresor.

version

str

Erforderlich

Die Version des Zertifikats.

enabled

bool

Gibt an, ob das Zertifikat für die Verwendung aktiviert ist.

tags

dict[str, str]

Anwendungsspezifische Metadaten in Form von Schlüssel-Wert-Paaren.

Gibt zurück

Das aktualisierte KeyVaultCertificate

Rückgabetyp

KeyVaultCertificate

Ausnahmen

HttpResponseError

update_issuer

Updates den angegebenen Zertifikataussteller. Erfordert zertifikate/setissuers-Berechtigung.

update_issuer(issuer_name: str, **kwargs) -> CertificateIssuer

Parameter

issuer_name

str

Erforderlich

Der Name des Herausgebers.

enabled

bool

Gibt an, ob der Aussteller für die Verwendung aktiviert ist.

provider

str

Der Ausstelleranbieter

account_id

str

Benutzername/Kontoname/Konto-ID.

password

str

Kennwort/Geheimnis/Kontoschlüssel.

organization_id

str

ID des organization

admin_contacts

list[AdministratorContact]

Kontaktdaten der organization Administratoren des Zertifikatausstellers

Gibt zurück

Der aktualisierte Aussteller

Rückgabetyp

CertificateIssuer

Ausnahmen

HttpResponseError

Attribute

vault_url