SecretClient Klasse
Eine allgemeine Schnittstelle zum Verwalten der Geheimnisse eines Tresors.
- Vererbung
-
azure.keyvault.secrets._shared.client_base.KeyVaultClientBaseSecretClient
Konstruktor
SecretClient(vault_url: str, credential: TokenCredential, **kwargs)
Parameter
- vault_url
- str
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
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. Der Standardwert ist die neueste.
- verify_challenge_resource
- bool
Gibt an, ob die Authentifizierungsanforderungsressource mit der Key Vault Domäne übereinstimmt. Der Standardwert ist „True“.
Methoden
backup_secret |
Sichern Sie ein Geheimnis in einer geschützten Form, die nur von Azure Key Vault verwendet werden kann. Erfordert Geheimnisse/Sicherungsberechtigungen. |
begin_delete_secret |
Löschen Sie alle Versionen eines Geheimnisses. Erfordert Geheimnisse/Löschberechtigungen. Wenn diese Methode zurückgibt, Key Vault mit dem Löschen des Geheimnisses 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_secret |
Wiederherstellen eines gelöschten Geheimnisses auf die neueste Version. Nur in einem Tresor mit aktiviertem vorläufigem Löschen möglich. Erfordert die Berechtigung "Geheimnisse/Wiederherstellung". Wenn für den Tresor das vorläufige Löschen nicht aktiviert ist, begin_delete_secret ist dauerhaft, und diese Methode gibt einen Fehler zurück. Der Versuch, ein nicht gelöschtes Geheimnis wiederherzustellen, gibt ebenfalls einen Fehler zurück. Wenn diese Methode zurückgibt, Key Vault mit der Wiederherstellung des Geheimnisses begonnen hat. Die Wiederherstellung kann einige Sekunden dauern. Diese Methode gibt daher einen Poller zurück, mit dem Sie auf den Abschluss der Wiederherstellung warten können. Warten ist nur erforderlich, wenn Sie das wiederhergestellte Geheimnis 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. |
get_deleted_secret |
Ruft ein gelöschtes Geheimnis ab. Nur in Tresoren mit aktiviertem vorläufigem Löschen möglich. Erfordert Geheimnisse/Berechtigung erhalten. |
get_secret |
Rufen Sie ein Geheimnis ab. Erfordert die "secrets/get"-Berechtigung. |
list_deleted_secrets |
Listet alle gelöschten Geheimnisse auf. Nur in Tresoren mit aktiviertem vorläufigem Löschen möglich. Erfordert geheimnisse/listenberechtigungen. |
list_properties_of_secret_versions |
Listet die Eigenschaften aller Versionen eines Geheimnisses mit Ausnahme der zugehörigen Werte auf. Erfordert geheimnisse/listenberechtigungen. Listenelemente enthalten keine Geheimwerte. Verwenden Sie get_secret , um den Wert eines Geheimnisses abzurufen. |
list_properties_of_secrets |
Listet Bezeichner und Attribute aller Geheimnisse im Tresor auf. Erfordert geheimnisse/listenberechtigungen. Listenelemente enthalten keine Geheimwerte. Verwenden Sie get_secret , um den Wert eines Geheimnisses abzurufen. |
purge_deleted_secret |
Löscht ein gelöschtes Geheimnis dauerhaft. Nur in Tresoren mit aktiviertem vorläufigem Löschen möglich. Führt ein irreversibles Löschen des angegebenen Geheimnisses 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 ein Geheimnis vor seinem zu bereinigen scheduled_purge_date. Erfordert Geheimnisse/Löschberechtigungen. |
restore_secret_backup |
Stellen Sie ein gesichertes Geheimnis wieder her. Erfordert die Berechtigung "Geheimnisse/Wiederherstellung". |
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. |
set_secret |
Legen Sie einen Geheimniswert fest. Wenn name verwendet wird, erstellen Sie eine neue Version des Geheimnisses. Falls nicht, erstellen Sie ein neues Geheimnis. Erfordert Geheimnisse/Festlegen der Berechtigung. |
update_secret_properties |
Aktualisieren Sie die Eigenschaften eines Geheimnisses, das nicht seinen Wert aufweist. Erfordert Geheimnisse/Festlegen der Berechtigung. Diese Methode aktualisiert die Eigenschaften des Geheimnisses, z. B. ob es aktiviert ist, kann aber den Wert des Geheimnisses nicht ändern. Verwenden Sie set_secret , um den Wert des Geheimnisses zu ändern. |
backup_secret
Sichern Sie ein Geheimnis in einer geschützten Form, die nur von Azure Key Vault verwendet werden kann. Erfordert Geheimnisse/Sicherungsberechtigungen.
backup_secret(name: str, **kwargs) -> bytes
Parameter
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
begin_delete_secret
Löschen Sie alle Versionen eines Geheimnisses. Erfordert Geheimnisse/Löschberechtigungen.
Wenn diese Methode zurückgibt, Key Vault mit dem Löschen des Geheimnisses 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_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]
Parameter
Gibt zurück
Ein Poller für den Löschvorgang. Die Result-Methode des Pollers gibt zurück, DeletedSecret ohne auf den Abschluss des Löschvorgangs zu warten. Wenn für den Tresor vorläufiges Löschen aktiviert ist und Sie das Geheimnis mit purge_deleted_secretendgültig löschen möchten, rufen Sie zuerst die Wait-Methode des Abrufers auf. Es wird blockiert, bis der Löschvorgang abgeschlossen ist. Die Wait-Methode erfordert geheimnisse/get-Berechtigung.
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
begin_recover_deleted_secret
Wiederherstellen eines gelöschten Geheimnisses auf die neueste Version. Nur in einem Tresor mit aktiviertem vorläufigem Löschen möglich.
Erfordert die Berechtigung "Geheimnisse/Wiederherstellung". Wenn für den Tresor das vorläufige Löschen nicht aktiviert ist, begin_delete_secret ist dauerhaft, und diese Methode gibt einen Fehler zurück. Der Versuch, ein nicht gelöschtes Geheimnis wiederherzustellen, gibt ebenfalls einen Fehler zurück. Wenn diese Methode zurückgibt, Key Vault mit der Wiederherstellung des Geheimnisses begonnen hat. Die Wiederherstellung kann einige Sekunden dauern. Diese Methode gibt daher einen Poller zurück, mit dem Sie auf den Abschluss der Wiederherstellung warten können. Warten ist nur erforderlich, wenn Sie das wiederhergestellte Geheimnis sofort in einem anderen Vorgang verwenden möchten.
begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]
Parameter
Gibt zurück
Ein Poller für den Wiederherstellungsvorgang. Die Ergebnismethode des Pollers gibt die wiederhergestellten Geheimnisse zurück SecretProperties , ohne auf den Abschluss der Wiederherstellung zu warten. Wenn Sie das wiederhergestellte Geheimnis sofort verwenden möchten, rufen Sie die Wait-Methode des Abrufs auf, die blockiert, bis das Geheimnis verwendet werden kann. Die Wait-Methode erfordert geheimnisse/get-Berechtigung.
Rückgabetyp
Ausnahmen
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
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
get_deleted_secret
Ruft ein gelöschtes Geheimnis ab. Nur in Tresoren mit aktiviertem vorläufigem Löschen möglich. Erfordert Geheimnisse/Berechtigung erhalten.
get_deleted_secret(name: str, **kwargs) -> DeletedSecret
Parameter
Rückgabetyp
Ausnahmen
wenn das gelöschte Geheimnis nicht vorhanden ist,
für andere Fehler
get_secret
Rufen Sie ein Geheimnis ab. Erfordert die "secrets/get"-Berechtigung.
get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret
Parameter
- version
- str
(optional) Version des abzurufenden Geheimnisses. Wenn sie nicht angegeben ist, ruft die neueste Version ab.
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
list_deleted_secrets
Listet alle gelöschten Geheimnisse auf. Nur in Tresoren mit aktiviertem vorläufigem Löschen möglich.
Erfordert geheimnisse/listenberechtigungen.
list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]
Gibt zurück
Ein Iterator für gelöschte Geheimnisse, ohne deren Werte
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
list_properties_of_secret_versions
Listet die Eigenschaften aller Versionen eines Geheimnisses mit Ausnahme der zugehörigen Werte auf. Erfordert geheimnisse/listenberechtigungen.
Listenelemente enthalten keine Geheimwerte. Verwenden Sie get_secret , um den Wert eines Geheimnisses abzurufen.
list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]
Parameter
Gibt zurück
Ein Iterator von Geheimnissen, ohne deren Werte
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
list_properties_of_secrets
Listet Bezeichner und Attribute aller Geheimnisse im Tresor auf. Erfordert geheimnisse/listenberechtigungen.
Listenelemente enthalten keine Geheimwerte. Verwenden Sie get_secret , um den Wert eines Geheimnisses abzurufen.
list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]
Gibt zurück
Ein Iterator von Geheimnissen, ohne deren Werte
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
purge_deleted_secret
Löscht ein gelöschtes Geheimnis dauerhaft. Nur in Tresoren mit aktiviertem vorläufigem Löschen möglich.
Führt ein irreversibles Löschen des angegebenen Geheimnisses 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 ein Geheimnis vor seinem zu bereinigen scheduled_purge_date.
Erfordert Geheimnisse/Löschberechtigungen.
purge_deleted_secret(name: str, **kwargs) -> None
Parameter
Gibt zurück
Keine
Ausnahmen
Beispiele
# if the vault has soft-delete enabled, purge permanently deletes the secret
# (with soft-delete disabled, begin_delete_secret is permanent)
secret_client.purge_deleted_secret("secret-name")
restore_secret_backup
Stellen Sie ein gesichertes Geheimnis wieder her. Erfordert die Berechtigung "Geheimnisse/Wiederherstellung".
restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties
Parameter
Gibt zurück
Das wiederhergestellte Geheimnis
Rückgabetyp
Ausnahmen
, wenn der Name des Geheimnisses bereits verwendet wird,
für andere Fehler
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
- 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
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
set_secret
Legen Sie einen Geheimniswert fest. Wenn name verwendet wird, erstellen Sie eine neue Version des Geheimnisses. Falls nicht, erstellen Sie ein neues Geheimnis.
Erfordert Geheimnisse/Festlegen der Berechtigung.
set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret
Parameter
- enabled
- bool
Gibt an, ob das Geheimnis für die Verwendung aktiviert ist.
- content_type
- str
Eine beliebige Zeichenfolge, die den Typ des Geheimnisses angibt, z. B. "password"
- not_before
- datetime
Nicht vor dem Datum des Geheimnisses in UTC
- expires_on
- datetime
Ablaufdatum des Geheimnisses in UTC
Rückgabetyp
Ausnahmen
update_secret_properties
Aktualisieren Sie die Eigenschaften eines Geheimnisses, das nicht seinen Wert aufweist. Erfordert Geheimnisse/Festlegen der Berechtigung.
Diese Methode aktualisiert die Eigenschaften des Geheimnisses, z. B. ob es aktiviert ist, kann aber den Wert des Geheimnisses nicht ändern. Verwenden Sie set_secret , um den Wert des Geheimnisses zu ändern.
update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties
Parameter
- version
- str
(optional) Version des zu aktualisierenden Geheimnisses. Falls nicht angegeben, wird die neueste Version aktualisiert.
- enabled
- bool
Gibt an, ob das Geheimnis für die Verwendung aktiviert ist.
- content_type
- str
Eine beliebige Zeichenfolge, die den Typ des Geheimnisses angibt, z. B. "password"
- not_before
- datetime
Nicht vor dem Datum des Geheimnisses in UTC
- expires_on
- datetime
Ablaufdatum des Geheimnisses in UTC
Rückgabetyp
Ausnahmen
wenn das Geheimnis nicht vorhanden ist,
für andere Fehler
Attribute
vault_url
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für