SecretClient Classe

Interface de haut niveau pour la gestion des secrets d’un coffre.

Héritage

azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

Constructeur

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

Paramètres

vault_url

str

Obligatoire

URL du coffre accessible par le client. Il s’agit également du « nom DNS » du coffre. Vous devez vérifier que cette URL fait référence à une ressource Key Vault valide. Pour plus d'informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Obligatoire

Objet qui peut fournir un jeton d’accès pour le coffre, par exemple des informations d’identification provenant de identity

api_version

ApiVersion

Version de l’API de service à utiliser. La valeur par défaut est la plus récente.

verify_challenge_resource

bool

Vérifiez si la ressource de défi d’authentification correspond au domaine Key Vault. La valeur par défaut est True.

Méthodes

backup_secret	Sauvegardez un secret dans un formulaire protégé utilisable uniquement par Azure Key Vault. Nécessite l’autorisation secrets/sauvegarde.
begin_delete_secret	Supprimez toutes les versions d’un secret. Nécessite l’autorisation secrets/suppression. Lorsque cette méthode retourne Key Vault a commencé à supprimer le secret. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la suppression.
begin_recover_deleted_secret	Récupérer un secret supprimé dans sa dernière version. Possible uniquement dans un coffre avec la suppression réversible activée. Nécessite l’autorisation secrets/récupérer. Si la suppression réversible n’est pas activée dans le coffre, begin_delete_secret est permanente et cette méthode retourne une erreur. La tentative de récupération d’un secret non supprimé retourne également une erreur. Lorsque cette méthode retourne Key Vault a commencé à récupérer le secret. La récupération peut prendre plusieurs secondes. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la récupération. L’attente n’est nécessaire que lorsque vous souhaitez utiliser immédiatement le secret récupéré dans une autre opération.
close	Fermez les sockets ouverts par le client. L’appel de cette méthode n’est pas nécessaire lors de l’utilisation du client comme gestionnaire de contexte.
get_deleted_secret	Obtenir un secret supprimé. Possible uniquement dans les coffres avec la suppression réversible activée. Nécessite l’autorisation secrets/obtenir.
get_secret	Obtenez un secret. requiert l'autorisation secrets/get.
list_deleted_secrets	Répertorie tous les secrets supprimés. Possible uniquement dans les coffres avec la suppression réversible activée. Nécessite l’autorisation secrets/liste.
list_properties_of_secret_versions	Répertorie les propriétés de toutes les versions d’un secret, à l’exclusion de leurs valeurs. Nécessite l’autorisation secrets/liste. Les éléments de liste n’incluent pas de valeurs secrètes. Utilisez get_secret pour obtenir la valeur d’un secret.
list_properties_of_secrets	Répertoriez les identificateurs et les attributs de tous les secrets dans le coffre. Nécessite l’autorisation secrets/liste. Les éléments de liste n’incluent pas de valeurs secrètes. Utilisez get_secret pour obtenir la valeur d’un secret.
purge_deleted_secret	Supprime définitivement un secret supprimé. Possible uniquement dans les coffres avec la suppression réversible activée. Effectue une suppression irréversible du secret spécifié, sans possibilité de récupération. L’opération n’est pas disponible si le recovery_level ne spécifie pas « Purgeable ». Cette méthode n’est nécessaire que pour purger un secret avant son scheduled_purge_date. Nécessite l’autorisation secrets/purge.
restore_secret_backup	Restaurer un secret sauvegardé. Nécessite l’autorisation secrets/restauration.
send_request	Exécute une requête réseau à l’aide du pipeline existant du client. L’URL de requête peut être relative à l’URL du coffre. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Cette méthode ne déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de requêtes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	Définissez une valeur de secret. Si le nom est en cours d’utilisation, créez une nouvelle version du secret. Si ce n’est pas le cas, créez un nouveau secret. Nécessite l’autorisation secrets/set.
update_secret_properties	Mettre à jour les propriétés d’un secret autre que sa valeur. Nécessite l’autorisation secrets/set. Cette méthode met à jour les propriétés du secret, par exemple si elle est activée, mais ne peut pas modifier la valeur du secret. Utilisez set_secret pour modifier la valeur du secret.

backup_secret

Sauvegardez un secret dans un formulaire protégé utilisable uniquement par Azure Key Vault. Nécessite l’autorisation secrets/sauvegarde.

backup_secret(name: str, **kwargs) -> bytes

Paramètres

name

str

Obligatoire

Nom du secret à sauvegarder

Type de retour

bytes

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

begin_delete_secret

Supprimez toutes les versions d’un secret. Nécessite l’autorisation secrets/suppression.

Lorsque cette méthode retourne Key Vault a commencé à supprimer le secret. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la suppression.

begin_delete_secret(name: str, **kwargs) -> LROPoller[DeletedSecret]

Paramètres

name

str

Obligatoire

Nom du secret à supprimer.

Retours

Polleur pour l’opération de suppression. La méthode de résultat de l’polleur retourne le DeletedSecret sans attendre la fin de la suppression. Si la suppression réversible est activée dans le coffre et que vous souhaitez supprimer définitivement le secret avec purge_deleted_secret, appelez d’abord la méthode d’attente de l’polleur. Il se bloque jusqu’à ce que la suppression soit terminée. La méthode wait nécessite l’autorisation secrets/get.

Type de retour

LROPoller[DeletedSecret]

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

begin_recover_deleted_secret

Récupérer un secret supprimé dans sa dernière version. Possible uniquement dans un coffre avec la suppression réversible activée.

Nécessite l’autorisation secrets/récupérer. Si la suppression réversible n’est pas activée dans le coffre, begin_delete_secret est permanente et cette méthode retourne une erreur. La tentative de récupération d’un secret non supprimé retourne également une erreur. Lorsque cette méthode retourne Key Vault a commencé à récupérer le secret. La récupération peut prendre plusieurs secondes. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la récupération. L’attente n’est nécessaire que lorsque vous souhaitez utiliser immédiatement le secret récupéré dans une autre opération.

begin_recover_deleted_secret(name: str, **kwargs) -> LROPoller[SecretProperties]

Paramètres

name

str

Obligatoire

Nom du secret supprimé à récupérer

Retours

Polleur pour l’opération de récupération. La méthode de résultat de l’polleur retourne le secret récupéré sans attendre la fin de SecretProperties la récupération. Si vous souhaitez utiliser le secret récupéré immédiatement, appelez la méthode d’attente du polleur, qui bloque jusqu’à ce que le secret soit prêt à être utilisé. La méthode wait nécessite l’autorisation secrets/get.

Type de retour

LROPoller[SecretProperties]

Exceptions

HttpResponseError

close

Fermez les sockets ouverts par le client.

L’appel de cette méthode n’est pas nécessaire lors de l’utilisation du client comme gestionnaire de contexte.

close() -> None

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

get_deleted_secret

Obtenir un secret supprimé. Possible uniquement dans les coffres avec la suppression réversible activée. Nécessite l’autorisation secrets/obtenir.

get_deleted_secret(name: str, **kwargs) -> DeletedSecret

Paramètres

name

str

Obligatoire

Nom du secret supprimé

Type de retour

DeletedSecret

Exceptions

ResourceNotFoundError

si le secret supprimé n’existe pas,

HttpResponseError

pour d’autres erreurs

get_secret

Obtenez un secret. requiert l'autorisation secrets/get.

get_secret(name: str, version: str | None = None, **kwargs) -> KeyVaultSecret

Paramètres

name

str

Obligatoire

Nom du secret

version

str

Obligatoire

(facultatif) Version du secret à obtenir. Si elle n’est pas spécifiée, obtient la dernière version.

Type de retour

KeyVaultSecret

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

list_deleted_secrets

Répertorie tous les secrets supprimés. Possible uniquement dans les coffres avec la suppression réversible activée.

Nécessite l’autorisation secrets/liste.

list_deleted_secrets(**kwargs) -> ItemPaged[DeletedSecret]

Retours

Itérateur de secrets supprimés, à l’exclusion de leurs valeurs

Type de retour

ItemPaged[DeletedSecret]

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

list_properties_of_secret_versions

Répertorie les propriétés de toutes les versions d’un secret, à l’exclusion de leurs valeurs. Nécessite l’autorisation secrets/liste.

Les éléments de liste n’incluent pas de valeurs secrètes. Utilisez get_secret pour obtenir la valeur d’un secret.

list_properties_of_secret_versions(name: str, **kwargs) -> ItemPaged[SecretProperties]

Paramètres

name

str

Obligatoire

Nom du secret

Retours

Itérateur de secrets, à l’exclusion de leurs valeurs

Type de retour

ItemPaged[SecretProperties]

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

list_properties_of_secrets

Répertoriez les identificateurs et les attributs de tous les secrets dans le coffre. Nécessite l’autorisation secrets/liste.

Les éléments de liste n’incluent pas de valeurs secrètes. Utilisez get_secret pour obtenir la valeur d’un secret.

list_properties_of_secrets(**kwargs) -> ItemPaged[SecretProperties]

Retours

Itérateur de secrets, à l’exclusion de leurs valeurs

Type de retour

ItemPaged[SecretProperties]

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

purge_deleted_secret

Supprime définitivement un secret supprimé. Possible uniquement dans les coffres avec la suppression réversible activée.

Effectue une suppression irréversible du secret spécifié, sans possibilité de récupération. L’opération n’est pas disponible si le recovery_level ne spécifie pas « Purgeable ». Cette méthode n’est nécessaire que pour purger un secret avant son scheduled_purge_date.

Nécessite l’autorisation secrets/purge.

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

Paramètres

name

str

Obligatoire

Nom du secret supprimé à purger

Retours

None

Exceptions

HttpResponseError

Exemples

   # 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

Restaurer un secret sauvegardé. Nécessite l’autorisation secrets/restauration.

restore_secret_backup(backup: bytes, **kwargs) -> SecretProperties

Paramètres

backup

bytes

Obligatoire

Sauvegarde secrète retournée par backup_secret

Retours

Le secret restauré

Type de retour

SecretProperties

Exceptions

ResourceExistsError

si le nom du secret est déjà utilisé,

HttpResponseError

pour d’autres erreurs

send_request

Exécute une requête réseau à l’aide du pipeline existant du client.

L’URL de requête peut être relative à l’URL du coffre. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Cette méthode ne déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de requêtes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Paramètres

request

HttpRequest

Obligatoire

Demande réseau que vous souhaitez effectuer.

stream

bool

Indique si la charge utile de réponse sera diffusée en continu. Valeur par défaut False.

Retours

Réponse de votre appel réseau. Ne gère pas les erreurs sur votre réponse.

Type de retour

HttpResponse

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

set_secret

Définissez une valeur de secret. Si le nom est en cours d’utilisation, créez une nouvelle version du secret. Si ce n’est pas le cas, créez un nouveau secret.

Nécessite l’autorisation secrets/set.

set_secret(name: str, value: str, **kwargs) -> KeyVaultSecret

Paramètres

name

str

Obligatoire

Nom du secret

value

str

Obligatoire

Valeur du secret

enabled

bool

Indique si le secret est activé pour l’utilisation.

tags

Dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

content_type

str

Chaîne arbitraire indiquant le type du secret, par exemple « password »

not_before

datetime

Date non antérieure du secret en UTC

expires_on

datetime

Date d’expiration du secret en UTC

Type de retour

KeyVaultSecret

Exceptions

HttpResponseError

update_secret_properties

Mettre à jour les propriétés d’un secret autre que sa valeur. Nécessite l’autorisation secrets/set.

Cette méthode met à jour les propriétés du secret, par exemple si elle est activée, mais ne peut pas modifier la valeur du secret. Utilisez set_secret pour modifier la valeur du secret.

update_secret_properties(name: str, version: str | None = None, **kwargs) -> SecretProperties

Paramètres

name

str

Obligatoire

Nom du secret

version

str

Obligatoire

(facultatif) Version du secret à mettre à jour. Si elle n’est pas spécifiée, la dernière version est mise à jour.

enabled

bool

Indique si le secret est activé pour l’utilisation.

tags

Dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

content_type

str

Chaîne arbitraire indiquant le type du secret, par exemple « password »

not_before

datetime

Date non antérieure du secret en UTC

expires_on

datetime

Date d’expiration du secret en UTC

Type de retour

SecretProperties

Exceptions

ResourceNotFoundError

si le secret n’existe pas,

HttpResponseError

pour d’autres erreurs

Attributs

vault_url