KeyClient Klasse

Eine allgemeine Schnittstelle zum Verwalten der Schlüssel eines Tresors.

Vererbung

azure.keyvault.keys._shared.client_base.KeyVaultClientBase

KeyClient

Konstruktor

KeyClient(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- oder verwaltete HSM-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- oder verwalteten HSM-Domäne übereinstimmt. Der Standardwert ist „True“.

Methoden

backup_key	Sichern Sie einen Schlüssel in einer geschützten Form, die nur von Azure Key Vault verwendet werden kann. Erfordert Schlüssel/Sicherungsberechtigungen. Dies soll das Kopieren eines Schlüssels 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_delete_key	Löschen Sie alle Versionen eines Schlüssels und dessen kryptografisches Material. Erfordert Schlüssel/Löschberechtigung. Wenn diese Methode zurückgibt, Key Vault mit dem Löschen des Schlüssels 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_key	Wiederherstellen eines gelöschten Schlüssels auf die neueste Version. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist. Erfordert Schlüssel/Wiederherstellungsberechtigung. Wenn diese Methode zurückgibt, Key Vault mit der Wiederherstellung des Schlüssels 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 den wiederhergestellten Schlüssel sofort in einem anderen Vorgang verwenden möchten.
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_ec_key	Erstellen Sie einen neuen elliptischen Kurvenschlüssel, oder erstellen Sie, wenn name sie bereits verwendet wird, eine neue Version des Schlüssels. Erfordert die "keys/create"-Berechtigung.
create_key	Erstellen Sie einen Schlüssel, oder erstellen Sie, falls name bereits verwendet wird, eine neue Version des Schlüssels. Erfordert Schlüssel/Berechtigung erstellen.
create_oct_key	Erstellen Sie einen neuen (symmetrischen) Oktettsequenzschlüssel, oder erstellen Sie bei name Verwendung eine neue Version des Schlüssels. Erfordert die "keys/create"-Berechtigung.
create_rsa_key	Erstellen Sie einen neuen RSA-Schlüssel, oder erstellen Sie, falls name bereits verwendet wird, eine neue Version des Schlüssels. Erfordert die "keys/create"-Berechtigung.
get_cryptography_client	Ruft einen CryptographyClient für den angegebenen Schlüssel ab.
get_deleted_key	Ruft einen gelöschten Schlüssel ab. Nur in einem Tresor mit aktiviertem vorläufigem Löschen möglich. Erfordert Schlüssel/Berechtigung abrufen.
get_key	Rufen Sie die Attribute eines Schlüssels und, wenn es sich um einen asymmetrischen Schlüssel handelt, dessen öffentliches Material ab. Erfordert Schlüssel/Berechtigung abrufen.
get_key_rotation_policy	Ruft die Rotationsrichtlinie eines Key Vault Schlüssels ab.
get_random_bytes	Rufen Sie die angeforderte Anzahl zufälliger Bytes von einem verwalteten HSM ab.
import_key	Importieren Sie einen extern erstellten Schlüssel. Erfordert Schlüssel/Importberechtigungen. Wenn name bereits verwendet wird, wird der Schlüssel als neue Version importiert.
list_deleted_keys	Listet alle gelöschten Schlüssel auf, einschließlich des öffentlichen Teils der einzelnen Schlüssel. Nur in einem Tresor mit aktiviertem vorläufigem Löschen möglich. Erfordert schlüssel-/listenberechtigungen.
list_properties_of_key_versions	Listet die Bezeichner und Eigenschaften der Versionen eines Schlüssels auf. Erfordert schlüssel-/listenberechtigungen.
list_properties_of_keys	Listet Bezeichner und Eigenschaften aller Schlüssel im Tresor auf. Erfordert schlüssel-/listenberechtigungen.
purge_deleted_key	Löscht einen gelöschten Schlüssel endgültig. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist. Führt ein irreversibles Löschen des angegebenen Schlüssels aus, ohne dass eine Wiederherstellung möglich ist. Der Vorgang ist nicht verfügbar, wenn " recovery_level Löschbar" nicht angegeben wird. Diese Methode ist nur erforderlich, um einen Schlüssel vor dessen zu bereinigen scheduled_purge_date. Erfordert Schlüssel/Löschberechtigungen.
release_key	Gibt einen Schlüssel frei. Der Vorgang zum Freigeben des Schlüssels gilt für alle Schlüsseltypen. Der Zielschlüssel muss als exportierbar gekennzeichnet sein. Für diesen Vorgang ist die Schlüssel-/Freigabeberechtigung erforderlich.
restore_key_backup	Stellen Sie eine Schlüsselsicherung im Tresor wieder her. Erfordert Schlüssel/Wiederherstellungsberechtigung. Dadurch werden alle Versionen des Schlüssels mit dem Namen, den Attributen und den Zugriffssteuerungsrichtlinien importiert. Wenn der Name des Schlüssels bereits verwendet wird, schlägt die Wiederherstellung fehl. Außerdem muss sich der Zieltresor im Besitz desselben Microsoft Azure-Abonnements wie der Quelltresor befinden.
rotate_key	Rotieren Sie den Schlüssel basierend auf der Schlüsselrichtlinie, indem Sie eine neue Version des Schlüssels generieren. Für diesen Vorgang ist die Berechtigung schlüssel/rotieren erforderlich.
send_request	Führt eine Netzwerkanforderung mithilfe der vorhandenen Pipeline des Clients aus. Die Anforderungs-URL kann relativ zur Tresor-URL sein. Die für die Anforderung verwendete Dienst-API-Version ist mit der des Clients identisch, sofern nichts anderes angegeben ist. Diese Methode wird nicht ausgelöst, 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.
update_key_properties	Ändern der Eigenschaften eines Schlüssels (nicht seines kryptografischen Materials). Erfordert Schlüssel/Updateberechtigungen.
update_key_rotation_policy	Updates die Rotationsrichtlinie eines Key Vault Schlüssels. Für diesen Vorgang ist die Berechtigung schlüssel/update erforderlich.

backup_key

Sichern Sie einen Schlüssel in einer geschützten Form, die nur von Azure Key Vault verwendet werden kann.

Erfordert Schlüssel/Sicherungsberechtigungen.

Dies soll das Kopieren eines Schlüssels 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_key(name: str, **kwargs) -> bytes

Parameter

name

str

Erforderlich

Der Name des zu sichernden Schlüssels

Rückgabetyp

bytes

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

begin_delete_key

Löschen Sie alle Versionen eines Schlüssels und dessen kryptografisches Material.

Erfordert Schlüssel/Löschberechtigung. Wenn diese Methode zurückgibt, Key Vault mit dem Löschen des Schlüssels 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_key(name: str, **kwargs) -> LROPoller[DeletedKey]

Parameter

name

str

Erforderlich

Der Name des zu löschenden Schlüssels.

Gibt zurück

Ein Poller für den Löschschlüsselvorgang. Die Result-Methode des Pollers gibt den zurück, ohne auf den DeletedKey Abschluss des Löschvorgangs zu warten. Wenn für den Tresor vorläufiges Löschen aktiviert ist und Sie den Schlüssel mit purge_deleted_keydauerhaft löschen möchten, rufen Sie zuerst die Wartemethode des Abfrageers auf. Es wird blockiert, bis der Löschvorgang abgeschlossen ist. Die Wartemethode erfordert Schlüssel/Abrufen der Berechtigung.

Rückgabetyp

LROPoller[DeletedKey]

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

begin_recover_deleted_key

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

Erfordert Schlüssel/Wiederherstellungsberechtigung.

Wenn diese Methode zurückgibt, Key Vault mit der Wiederherstellung des Schlüssels 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 den wiederhergestellten Schlüssel sofort in einem anderen Vorgang verwenden möchten.

begin_recover_deleted_key(name: str, **kwargs) -> LROPoller[KeyVaultKey]

Parameter

name

str

Erforderlich

Der Name des gelöschten Schlüssels, der wiederhergestellt werden soll

Gibt zurück

Ein Poller für den Wiederherstellungsvorgang. Die Ergebnismethode des Pollers gibt das wiederhergestellte zurück, KeyVaultKey ohne auf den Abschluss der Wiederherstellung zu warten. Wenn Sie den wiederhergestellten Schlüssel sofort verwenden möchten, rufen Sie die Wartemethode des Pollers auf, die blockiert, bis der Schlüssel zur Verwendung bereit ist. Die Wartemethode erfordert Schlüssel/Abrufen der Berechtigung.

Rückgabetyp

LROPoller[KeyVaultKey]

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 der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

create_ec_key

Erstellen Sie einen neuen elliptischen Kurvenschlüssel, oder erstellen Sie, wenn name sie bereits verwendet wird, eine neue Version des Schlüssels.

Erfordert die "keys/create"-Berechtigung.

create_ec_key(name: str, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name für den neuen Schlüssel.

curve

KeyCurveName oder str oder None

Name der elliptischen Kurve. Standardmäßig wird die elliptische Kurve NIST P-256 verwendet.

key_operations

list[KeyOperation oder str] oder None

Zulässige Schlüsselvorgänge

hardware_protected

bool oder None

Gibt an, ob der Schlüssel in einem Hardwaresicherheitsmodul erstellt werden soll. Wird standardmäßig auf False festgelegt.

enabled

bool oder None

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

tags

dict[str, str] oder None

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

not_before

datetime oder None

Nicht vor dem Datum des Schlüssels in UTC

expires_on

datetime oder None

Ablaufdatum des Schlüssels in UTC

exportable

bool oder None

Gibt an, ob der private Schlüssel exportiert werden kann.

release_policy

KeyReleasePolicy oder None

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.

Gibt zurück

Der erstellte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

HttpResponseError

create_key

Erstellen Sie einen Schlüssel, oder erstellen Sie, falls name bereits verwendet wird, eine neue Version des Schlüssels.

Erfordert Schlüssel/Berechtigung erstellen.

create_key(name: str, key_type: str | KeyType, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name des neuen Schlüssels.

key_type

KeyType oder str

Erforderlich

Der Typ des zu erstellenden Schlüssels

size

int oder None

Schlüsselgröße in Bits. Gilt nur für RSA- und symmetrische Schlüssel. Erwägen Sie stattdessen die Verwendung create_rsa_key oder create_oct_key .

curve

KeyCurveName oder str oder None

Name der elliptischen Kurve. Gilt nur für elliptische Kurventasten. Standardmäßig wird die elliptische Kurve NIST P-256 verwendet. Um einen elliptischen Kurvenschlüssel zu erstellen, sollten Sie stattdessen verwenden create_ec_key .

public_exponent

int oder None

Der zu verwendende öffentliche RSA-Exponent. Gilt nur für RSA-Schlüssel, die in einem verwalteten HSM erstellt wurden.

key_operations

list[KeyOperation oder str] oder None

Zulässige Schlüsselvorgänge

enabled

bool oder None

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

tags

dict[str, str] oder None

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

not_before

datetime oder None

Nicht vor dem Datum des Schlüssels in UTC

expires_on

datetime oder None

Ablaufdatum des Schlüssels in UTC

exportable

bool oder None

Gibt an, ob der private Schlüssel exportiert werden kann.

release_policy

KeyReleasePolicy oder None

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.

Gibt zurück

Der erstellte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

HttpResponseError

create_oct_key

Erstellen Sie einen neuen (symmetrischen) Oktettsequenzschlüssel, oder erstellen Sie bei name Verwendung eine neue Version des Schlüssels.

Erfordert die "keys/create"-Berechtigung.

create_oct_key(name: str, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name für den neuen Schlüssel.

size

int oder None

Schlüsselgröße in Bits, z. B. 128, 192 oder 256.

key_operations

list[KeyOperation oder str] oder None

Zulässige Schlüsselvorgänge.

hardware_protected

bool oder None

Gibt an, ob der Schlüssel in einem Hardwaresicherheitsmodul erstellt werden soll. Wird standardmäßig auf False festgelegt.

enabled

bool oder None

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

tags

dict[str, str] oder None

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

not_before

datetime oder None

Nicht vor dem Datum des Schlüssels in UTC

expires_on

datetime oder None

Ablaufdatum des Schlüssels in UTC

exportable

bool oder None

Gibt an, ob der Schlüssel exportiert werden kann.

release_policy

KeyReleasePolicy oder None

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.

Gibt zurück

Der erstellte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

HttpResponseError

create_rsa_key

Erstellen Sie einen neuen RSA-Schlüssel, oder erstellen Sie, falls name bereits verwendet wird, eine neue Version des Schlüssels.

Erfordert die "keys/create"-Berechtigung.

create_rsa_key(name: str, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name für den neuen Schlüssel.

size

int oder None

Schlüsselgröße in Bits, z. B. 2048, 3072 oder 4096.

public_exponent

int oder None

Der zu verwendende öffentliche RSA-Exponent. Gilt nur für RSA-Schlüssel, die in einem verwalteten HSM erstellt wurden.

hardware_protected

bool oder None

Gibt an, ob der Schlüssel in einem Hardwaresicherheitsmodul erstellt werden soll. Wird standardmäßig auf False festgelegt.

key_operations

list[KeyOperation oder str] oder None

Zulässige Schlüsselvorgänge

enabled

bool oder None

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

tags

dict[str, str] oder None

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

not_before

datetime oder None

Nicht vor dem Datum des Schlüssels in UTC

expires_on

datetime oder None

Ablaufdatum des Schlüssels in UTC

exportable

bool oder None

Gibt an, ob der private Schlüssel exportiert werden kann.

release_policy

KeyReleasePolicy oder None

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.

Gibt zurück

Der erstellte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

HttpResponseError

get_cryptography_client

Ruft einen CryptographyClient für den angegebenen Schlüssel ab.

get_cryptography_client(key_name: str, **kwargs) -> CryptographyClient

Parameter

key_name

str

Erforderlich

Der Name des Schlüssels, der zum Ausführen kryptografischer Vorgänge verwendet wird.

key_version

str

Optionale Version des Schlüssels, der zum Ausführen kryptografischer Vorgänge verwendet wird.

Gibt zurück

Ein CryptographyClient mit den gleichen Optionen, Anmeldeinformationen und HTTP-Client wie dieser KeyClient.

Rückgabetyp

CryptographyClient

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_deleted_key

Ruft einen gelöschten Schlüssel ab. Nur in einem Tresor mit aktiviertem vorläufigem Löschen möglich.

Erfordert Schlüssel/Berechtigung abrufen.

get_deleted_key(name: str, **kwargs) -> DeletedKey

Parameter

name

str

Erforderlich

Der Name des Schlüssels

Gibt zurück

Der gelöschte Schlüssel

Rückgabetyp

DeletedKey

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_key

Rufen Sie die Attribute eines Schlüssels und, wenn es sich um einen asymmetrischen Schlüssel handelt, dessen öffentliches Material ab.

Erfordert Schlüssel/Berechtigung abrufen.

get_key(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name des abzurufenden Schlüssels.

version

str oder None

Erforderlich

(optional) Eine bestimmte Version des abzurufenden Schlüssels. Wenn nicht angegeben, ruft die neueste Version des Schlüssels ab.

Rückgabetyp

KeyVaultKey

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

get_key_rotation_policy

Ruft die Rotationsrichtlinie eines Key Vault Schlüssels ab.

get_key_rotation_policy(key_name: str, **kwargs) -> KeyRotationPolicy

Parameter

key_name

str

Erforderlich

Der Name des Schlüssels.

Gibt zurück

Die Schlüsselrotationsrichtlinie.

Rückgabetyp

KeyRotationPolicy

Ausnahmen

*azure.core.exceptions.HttpResponseError*

get_random_bytes

Rufen Sie die angeforderte Anzahl zufälliger Bytes von einem verwalteten HSM ab.

get_random_bytes(count: int, **kwargs) -> bytes

Parameter

count

int

Erforderlich

Die angeforderte Anzahl zufälliger Bytes.

Gibt zurück

Die zufälligen Bytes.

Rückgabetyp

bytes

Ausnahmen

ValueError

, wenn weniger als ein zufälliges Byte angefordert wird,

HttpResponseError

für andere Fehler

import_key

Importieren Sie einen extern erstellten Schlüssel.

Erfordert Schlüssel/Importberechtigungen. Wenn name bereits verwendet wird, wird der Schlüssel als neue Version importiert.

import_key(name: str, key: JsonWebKey, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Name für den importierten Schlüssel

key

JsonWebKey

Erforderlich

Der zu importierende JSON-Webschlüssel

hardware_protected

bool oder None

Gibt an, ob der Schlüssel von einem Hardwaresicherheitsmodul gesichert werden soll.

enabled

bool oder None

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

tags

dict[str, str] oder None

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

not_before

datetime oder None

Nicht vor dem Datum des Schlüssels in UTC

expires_on

datetime oder None

Ablaufdatum des Schlüssels in UTC

exportable

bool oder None

Gibt an, ob der private Schlüssel exportiert werden kann.

release_policy

KeyReleasePolicy oder None

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.

Gibt zurück

Der importierte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

HttpResponseError

list_deleted_keys

Listet alle gelöschten Schlüssel auf, einschließlich des öffentlichen Teils der einzelnen Schlüssel. Nur in einem Tresor mit aktiviertem vorläufigem Löschen möglich.

Erfordert schlüssel-/listenberechtigungen.

list_deleted_keys(**kwargs) -> ItemPaged[DeletedKey]

Gibt zurück

Ein Iterator gelöschter Schlüssel

Rückgabetyp

ItemPaged[DeletedKey]

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

list_properties_of_key_versions

Listet die Bezeichner und Eigenschaften der Versionen eines Schlüssels auf.

Erfordert schlüssel-/listenberechtigungen.

list_properties_of_key_versions(name: str, **kwargs) -> ItemPaged[KeyProperties]

Parameter

name

str

Erforderlich

Der Name des Schlüssels

Gibt zurück

Ein Iterator von Schlüsseln ohne kryptografisches Material

Rückgabetyp

ItemPaged[KeyProperties]

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

list_properties_of_keys

Listet Bezeichner und Eigenschaften aller Schlüssel im Tresor auf.

Erfordert schlüssel-/listenberechtigungen.

list_properties_of_keys(**kwargs) -> ItemPaged[KeyProperties]

Gibt zurück

Ein Iterator von Schlüsseln ohne deren kryptografisches Material oder Versionsinformationen

Rückgabetyp

ItemPaged[KeyProperties]

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

purge_deleted_key

Löscht einen gelöschten Schlüssel endgültig. Nur in einem Tresor möglich, bei dem vorläufiges Löschen aktiviert ist.

Führt ein irreversibles Löschen des angegebenen Schlüssels aus, ohne dass eine Wiederherstellung möglich ist. Der Vorgang ist nicht verfügbar, wenn " recovery_level Löschbar" nicht angegeben wird. Diese Methode ist nur erforderlich, um einen Schlüssel vor dessen zu bereinigen scheduled_purge_date.

Erfordert Schlüssel/Löschberechtigungen.

purge_deleted_key(name: str, **kwargs) -> None

Parameter

name

str

Erforderlich

Der Name des gelöschten Schlüssels, der gelöscht werden soll

Gibt zurück

Keine

Ausnahmen

HttpResponseError

Beispiele

   # if the vault has soft-delete enabled, purge permanently deletes a deleted key
   # (with soft-delete disabled, begin_delete_key is permanent)
   key_client.purge_deleted_key("key-name")

release_key

Gibt einen Schlüssel frei.

Der Vorgang zum Freigeben des Schlüssels gilt für alle Schlüsseltypen. Der Zielschlüssel muss als exportierbar gekennzeichnet sein. Für diesen Vorgang ist die Schlüssel-/Freigabeberechtigung erforderlich.

release_key(name: str, target_attestation_token: str, **kwargs) -> ReleaseKeyResult

Parameter

name

str

Erforderlich

Der Name des abzurufenden Schlüssels.

target_attestation_token

str

Erforderlich

Die Nachweisassertion für das Ziel der Schlüsselfreigabe.

version

str oder None

Eine bestimmte Version des zu veröffentlichenden Schlüssels. Falls nicht angegeben, wird die neueste Version veröffentlicht.

algorithm

str oder KeyExportEncryptionAlgorithm oder None

Der Verschlüsselungsalgorithmus, der zum Schutz des freigegebenen Schlüsselmaterials verwendet werden soll.

nonce

str oder None

Eine vom Client bereitgestellte Nonce für Die Aktualität.

Gibt zurück

Das Ergebnis der Schlüsselfreigabe.

Rückgabetyp

ReleaseKeyResult

Ausnahmen

HttpResponseError

restore_key_backup

Stellen Sie eine Schlüsselsicherung im Tresor wieder her.

Erfordert Schlüssel/Wiederherstellungsberechtigung.

Dadurch werden alle Versionen des Schlüssels mit dem Namen, den Attributen und den Zugriffssteuerungsrichtlinien importiert. Wenn der Name des Schlüssels bereits verwendet wird, schlägt die Wiederherstellung fehl. Außerdem muss sich der Zieltresor im Besitz desselben Microsoft Azure-Abonnements wie der Quelltresor befinden.

restore_key_backup(backup: bytes, **kwargs) -> KeyVaultKey

Parameter

backup

bytes

Erforderlich

Eine Schlüsselsicherung, wie von zurückgegeben backup_key

Gibt zurück

Der wiederhergestellte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

ResourceExistsError

, wenn der Name des gesicherten Schlüssels bereits verwendet wird,

HttpResponseError

für andere Fehler

rotate_key

Rotieren Sie den Schlüssel basierend auf der Schlüsselrichtlinie, indem Sie eine neue Version des Schlüssels generieren.

Für diesen Vorgang ist die Berechtigung schlüssel/rotieren erforderlich.

rotate_key(name: str, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name des zu rotierenden Schlüssels.

Gibt zurück

Die neue Version des gedrehten Schlüssels.

Rückgabetyp

KeyVaultKey

Ausnahmen

HttpResponseError

send_request

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

Die Anforderungs-URL kann relativ zur Tresor-URL sein. Die für die Anforderung verwendete Dienst-API-Version ist mit der des Clients identisch, sofern nichts anderes angegeben ist. Diese Methode wird nicht ausgelöst, 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 ausführen 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 der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

update_key_properties

Ändern der Eigenschaften eines Schlüssels (nicht seines kryptografischen Materials).

Erfordert Schlüssel/Updateberechtigungen.

update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Parameter

name

str

Erforderlich

Der Name des zu aktualisierenden Schlüssels

version

str oder None

Erforderlich

(optional) Die Version des zu aktualisierenden Schlüssels. Falls nicht angegeben, wird die neueste Version aktualisiert.

key_operations

list[KeyOperation oder str] oder None

Zulässige Schlüsselvorgänge

enabled

bool oder None

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

tags

dict[str, str] oder None

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

not_before

datetime oder None

Nicht vor dem Datum des Schlüssels in UTC

expires_on

datetime oder None

Ablaufdatum des Schlüssels in UTC

release_policy

KeyReleasePolicy oder None

Die Richtlinienregeln, unter denen der Schlüssel exportiert werden kann.

Gibt zurück

Der aktualisierte Schlüssel

Rückgabetyp

KeyVaultKey

Ausnahmen

ResourceNotFoundError

wenn der Schlüssel nicht vorhanden ist,

HttpResponseError

für andere Fehler

update_key_rotation_policy

Updates die Rotationsrichtlinie eines Key Vault Schlüssels.

Für diesen Vorgang ist die Berechtigung schlüssel/update erforderlich.

update_key_rotation_policy(key_name: str, policy: KeyRotationPolicy, **kwargs) -> KeyRotationPolicy

Parameter

key_name

str

Erforderlich

Der Name des Schlüssels im angegebenen Tresor.

policy

KeyRotationPolicy

Erforderlich

Die neue Rotationsrichtlinie für den Schlüssel.

lifetime_actions

list[KeyRotationLifetimeAction]

Aktionen, die von Key Vault während der Lebensdauer eines Schlüssels ausgeführt werden. Dadurch werden die Lebensdaueraktionen der bereitgestellten policyüberschrieben.

expires_in

str

Die Ablaufzeit der Richtlinie, die auf neue Schlüsselversionen angewendet wird, definiert als ISO 8601-Dauer. Beispiel: 90 Tage ist "P90D", 3 Monate "P3M", und 48 Stunden sind "PT48H". Weitere Informationen zur Dauer von ISO 8601 finden Sie in Wikipedia . Dadurch wird die Ablaufzeit des bereitgestellten policyüberschrieben.

Gibt zurück

Die aktualisierte Rotationsrichtlinie.

Rückgabetyp

KeyRotationPolicy

Ausnahmen

HttpResponseError

Attribute

vault_url