SecretClient Clase

Una interfaz de alto nivel para administrar los secretos de un almacén.

Herencia

azure.keyvault.secrets._shared.client_base.KeyVaultClientBase

SecretClient

Constructor

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

Parámetros

vault_url

str

Requerido

Dirección URL del almacén al que tendrá acceso el cliente. Esto también se denomina "Nombre DNS" del almacén. Debe validar que esta dirección URL hace referencia a un recurso de Key Vault válido. Para obtener información detallada, vea https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Requerido

Objeto que puede proporcionar un token de acceso para el almacén, como una credencial de . identity

api_version

ApiVersion

Versión de la API de servicio que se va a usar. El valor predeterminado es el más reciente.

verify_challenge_resource

bool

Si se debe comprobar que el recurso de desafío de autenticación coincide con el dominio Key Vault. El valor predeterminado es True.

Métodos

backup_secret	Realice una copia de seguridad de un secreto en un formulario protegido que solo pueda usar Azure Key Vault. Requiere el permiso de copia de seguridad y secretos.
begin_delete_secret	Elimine todas las versiones de un secreto. Requiere el permiso secrets/delete. Cuando este método devuelve Key Vault ha comenzado a eliminar el secreto. La eliminación puede tardar varios segundos en un almacén con la eliminación temporal habilitada. Por lo tanto, este método devuelve un sondeo que le permite esperar a que se complete la eliminación.
begin_recover_deleted_secret	Recupere un secreto eliminado en su versión más reciente. Solo es posible en un almacén con la eliminación temporal habilitada. Requiere el permiso secrets/recover. Si el almacén no tiene habilitada la eliminación temporal, begin_delete_secret es permanente y este método devolverá un error. Al intentar recuperar un secreto no eliminado, también se devolverá un error. Cuando este método devuelve Key Vault ha empezado a recuperar el secreto. La recuperación puede tardar varios segundos. Por lo tanto, este método devuelve un sondeo que le permite esperar a que se complete la recuperación. Esperar solo es necesario cuando desea usar el secreto recuperado en otra operación inmediatamente.
close	Cierre los sockets abiertos por el cliente. Llamar a este método no es necesario cuando se usa el cliente como administrador de contextos.
get_deleted_secret	Obtenga un secreto eliminado. Solo es posible en almacenes con eliminación temporal habilitada. Requiere el permiso secrets/get.
get_secret	Obtenga un secreto. requiere el permiso secrets/get.
list_deleted_secrets	Enumera todos los secretos eliminados. Solo es posible en almacenes con eliminación temporal habilitada. Requiere el permiso secrets/list.
list_properties_of_secret_versions	Enumera las propiedades de todas las versiones de un secreto, excepto sus valores. Requiere el permiso secrets/list. Los elementos de lista no incluyen valores secretos. Use get_secret para obtener el valor de un secreto.
list_properties_of_secrets	Enumera los identificadores y atributos de todos los secretos del almacén. Requiere el permiso secrets/list. Los elementos de lista no incluyen valores secretos. Use get_secret para obtener el valor de un secreto.
purge_deleted_secret	Elimina permanentemente un secreto eliminado. Solo es posible en almacenes con eliminación temporal habilitada. Realiza una eliminación irreversible del secreto especificado, sin posibilidad de recuperación. La operación no está disponible si recovery_level no especifica "Purgable". Este método solo es necesario para purgar un secreto antes de su scheduled_purge_date. Requiere el permiso secrets/purge.
restore_secret_backup	Restaure un secreto de copia de seguridad. Requiere el permiso secrets/restore.
send_request	Ejecuta una solicitud de red mediante la canalización existente del cliente. La dirección URL de la solicitud puede ser relativa a la dirección URL del almacén. La versión de la API de servicio usada para la solicitud es la misma que la del cliente, a menos que se especifique lo contrario. Este método no genera si la respuesta es un error; para generar una excepción, llame a raise_for_status() en el objeto de respuesta devuelto. Para obtener más información sobre cómo enviar solicitudes personalizadas con este método, vea https://aka.ms/azsdk/dpcodegen/python/send_request.
set_secret	Establezca un valor secreto. Si el nombre está en uso, cree una nueva versión del secreto. Si no es así, cree un nuevo secreto. Requiere el permiso secrets/set.
update_secret_properties	Actualice las propiedades de un secreto distinto de su valor. Requiere el permiso secrets/set. Este método actualiza las propiedades del secreto, como si está habilitado, pero no puede cambiar el valor del secreto. Use set_secret para cambiar el valor del secreto.

backup_secret

Realice una copia de seguridad de un secreto en un formulario protegido que solo pueda usar Azure Key Vault. Requiere el permiso de copia de seguridad y secretos.

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

Parámetros

name

str

Requerido

Nombre del secreto del que se va a realizar una copia de seguridad

Tipo de valor devuelto

bytes

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

begin_delete_secret

Elimine todas las versiones de un secreto. Requiere el permiso secrets/delete.

Cuando este método devuelve Key Vault ha comenzado a eliminar el secreto. La eliminación puede tardar varios segundos en un almacén con la eliminación temporal habilitada. Por lo tanto, este método devuelve un sondeo que le permite esperar a que se complete la eliminación.

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

Parámetros

name

str

Requerido

Nombre del secreto que se va a eliminar.

Devoluciones

Un sondeo para la operación de eliminación. El método de resultado del sondeo devuelve sin DeletedSecret esperar a que se complete la eliminación. Si el almacén tiene habilitada la eliminación temporal y desea eliminar permanentemente el secreto con purge_deleted_secret, llame primero al método de espera del sondeo. Se bloqueará hasta que se complete la eliminación. El método wait requiere el permiso secrets/get.

Tipo de valor devuelto

LROPoller[DeletedSecret]

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

begin_recover_deleted_secret

Recupere un secreto eliminado en su versión más reciente. Solo es posible en un almacén con la eliminación temporal habilitada.

Requiere el permiso secrets/recover. Si el almacén no tiene habilitada la eliminación temporal, begin_delete_secret es permanente y este método devolverá un error. Al intentar recuperar un secreto no eliminado, también se devolverá un error. Cuando este método devuelve Key Vault ha empezado a recuperar el secreto. La recuperación puede tardar varios segundos. Por lo tanto, este método devuelve un sondeo que le permite esperar a que se complete la recuperación. Esperar solo es necesario cuando desea usar el secreto recuperado en otra operación inmediatamente.

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

Parámetros

name

str

Requerido

Nombre del secreto eliminado que se va a recuperar

Devoluciones

Un sondeo para la operación de recuperación. El método de resultado del sondeo devuelve el secreto SecretProperties recuperado sin esperar a que se complete la recuperación. Si desea usar el secreto recuperado inmediatamente, llame al método wait del sondeo, que se bloquea hasta que el secreto esté listo para usarse. El método wait requiere el permiso secrets/get.

Tipo de valor devuelto

LROPoller[SecretProperties]

Excepciones

HttpResponseError

close

Cierre los sockets abiertos por el cliente.

Llamar a este método no es necesario cuando se usa el cliente como administrador de contextos.

close() -> None

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

get_deleted_secret

Obtenga un secreto eliminado. Solo es posible en almacenes con eliminación temporal habilitada. Requiere el permiso secrets/get.

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

Parámetros

name

str

Requerido

Nombre del secreto eliminado

Tipo de valor devuelto

DeletedSecret

Excepciones

ResourceNotFoundError

si el secreto eliminado no existe,

HttpResponseError

para otros errores

get_secret

Obtenga un secreto. requiere el permiso secrets/get.

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

Parámetros

name

str

Requerido

Nombre del secreto

version

str

Requerido

(opcional) Versión del secreto que se va a obtener. Si no se especifica, obtiene la versión más reciente.

Tipo de valor devuelto

KeyVaultSecret

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

list_deleted_secrets

Enumera todos los secretos eliminados. Solo es posible en almacenes con eliminación temporal habilitada.

Requiere el permiso secrets/list.

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

Devoluciones

Iterador de secretos eliminados, excepto sus valores

Tipo de valor devuelto

ItemPaged[DeletedSecret]

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

list_properties_of_secret_versions

Enumera las propiedades de todas las versiones de un secreto, excepto sus valores. Requiere el permiso secrets/list.

Los elementos de lista no incluyen valores secretos. Use get_secret para obtener el valor de un secreto.

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

Parámetros

name

str

Requerido

Nombre del secreto

Devoluciones

Iterador de secretos, excepto sus valores

Tipo de valor devuelto

ItemPaged[SecretProperties]

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

list_properties_of_secrets

Enumera los identificadores y atributos de todos los secretos del almacén. Requiere el permiso secrets/list.

Los elementos de lista no incluyen valores secretos. Use get_secret para obtener el valor de un secreto.

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

Devoluciones

Iterador de secretos, excepto sus valores

Tipo de valor devuelto

ItemPaged[SecretProperties]

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

purge_deleted_secret

Elimina permanentemente un secreto eliminado. Solo es posible en almacenes con eliminación temporal habilitada.

Realiza una eliminación irreversible del secreto especificado, sin posibilidad de recuperación. La operación no está disponible si recovery_level no especifica "Purgable". Este método solo es necesario para purgar un secreto antes de su scheduled_purge_date.

Requiere el permiso secrets/purge.

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

Parámetros

name

str

Requerido

Nombre del secreto eliminado para purgar

Devoluciones

None

Excepciones

HttpResponseError

Ejemplos

   # 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

Restaure un secreto de copia de seguridad. Requiere el permiso secrets/restore.

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

Parámetros

backup

bytes

Requerido

Copia de seguridad de secretos devuelta por backup_secret

Devoluciones

El secreto restaurado

Tipo de valor devuelto

SecretProperties

Excepciones

ResourceExistsError

si el nombre del secreto ya está en uso,

HttpResponseError

para otros errores

send_request

Ejecuta una solicitud de red mediante la canalización existente del cliente.

La dirección URL de la solicitud puede ser relativa a la dirección URL del almacén. La versión de la API de servicio usada para la solicitud es la misma que la del cliente, a menos que se especifique lo contrario. Este método no genera si la respuesta es un error; para generar una excepción, llame a raise_for_status() en el objeto de respuesta devuelto. Para obtener más información sobre cómo enviar solicitudes personalizadas con este método, vea https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parámetros

request

HttpRequest

Requerido

Solicitud de red que desea realizar.

stream

bool

Si se transmitirá la carga de respuesta. El valor predeterminado es False.

Devoluciones

Respuesta de la llamada de red. No realiza el control de errores en la respuesta.

Tipo de valor devuelto

HttpResponse

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

set_secret

Establezca un valor secreto. Si el nombre está en uso, cree una nueva versión del secreto. Si no es así, cree un nuevo secreto.

Requiere el permiso secrets/set.

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

Parámetros

name

str

Requerido

Nombre del secreto

value

str

Requerido

Valor del secreto

enabled

bool

Indica si el secreto está habilitado para su uso.

tags

Dict[str, str] o None

Metadatos específicos de la aplicación en forma de pares clave-valor.

content_type

str

Cadena arbitraria que indica el tipo del secreto, por ejemplo, "contraseña".

not_before

datetime

No antes de la fecha del secreto en UTC

expires_on

datetime

Fecha de expiración del secreto en UTC

Tipo de valor devuelto

KeyVaultSecret

Excepciones

HttpResponseError

update_secret_properties

Actualice las propiedades de un secreto distinto de su valor. Requiere el permiso secrets/set.

Este método actualiza las propiedades del secreto, como si está habilitado, pero no puede cambiar el valor del secreto. Use set_secret para cambiar el valor del secreto.

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

Parámetros

name

str

Requerido

Nombre del secreto

version

str

Requerido

(opcional) Versión del secreto que se va a actualizar. Si no se especifica, se actualiza la versión más reciente.

enabled

bool

Indica si el secreto está habilitado para su uso.

tags

Dict[str, str] o None

Metadatos específicos de la aplicación en forma de pares clave-valor.

content_type

str

Cadena arbitraria que indica el tipo del secreto, por ejemplo, "contraseña".

not_before

datetime

No antes de la fecha del secreto en UTC

expires_on

datetime

Fecha de expiración del secreto en UTC

Tipo de valor devuelto

SecretProperties

Excepciones

ResourceNotFoundError

si el secreto no existe,

HttpResponseError

para otros errores

Atributos

vault_url