Keyvault Clase

  • Referencia

Administra los secretos almacenados en Azure Key Vault asociados a un área de trabajo de Azure Machine Learning.

Cada área de trabajo de Azure Machine Learning tiene una instancia de Azure Key Vault asociada. La clase Keyvault es un contenedor simplificado de Azure Key Vault que permite administrar los secretos en el almacén de claves, incluida la configuración, recuperación, eliminación y enumeración de secretos. Usa la clase Keyvault para pasar secretos a ejecuciones remotas de forma segura sin exponer información confidencial en texto no cifrado.

Para más información, consulte Uso de secretos en ejecuciones de entrenamiento.

Constructor keyvault de clase.

Herencia
builtins.object
Keyvault

Constructor

Keyvault(workspace)

Parámetros

Nombre Description
workspace
Requerido
Workspace

Área de trabajo de Azure Machine Learning asociada a este almacén de claves.
workspace
Requerido
Workspace

Área de trabajo de Azure Machine Learning asociada a este almacén de claves.

Comentarios

En las ejecuciones enviadas en el proceso local y remoto, puede usar el método get_secret de la instancia de ejecución para obtener el valor del secreto de Key Vault. Para obtener varios secretos, use el método get_secrets de la instancia de ejecución.

Estos métodos de ejecución le proporcionan un acceso directo sencillo porque la instancia de ejecución reconoce su área de trabajo y almacén de claves, y puede obtener directamente el secreto sin necesidad de crear instancias del área de trabajo y el almacén de claves dentro de la ejecución remota.

En el ejemplo siguiente se muestra cómo acceder al almacén de claves predeterminado asociado a un área de trabajo y establecer un secreto.


   import uuid

   local_secret = os.environ.get("LOCAL_SECRET", default = str(uuid.uuid4())) # Use random UUID as a substitute for real secret.
   keyvault = ws.get_default_keyvault()
   keyvault.set_secret(name="secret-name", value = local_secret)

El ejemplo completo está disponible en https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb.

Métodos

delete_secret

Elimina el secreto con el nombre especificado.
delete_secrets

Elimina una lista de secretos de la instancia de Azure Key Vault asociada al área de trabajo.
get_secret

Devuelve el valor del secreto para un nombre de secreto determinado.
get_secret_content_type

Devuelve el tipo de contenido del secreto para un nombre de secreto determinado.
get_secrets

Devuelve los valores de secretos para una lista determinada de nombres de secretos.
list_secrets

Devuelve una lista de nombre secretos de la instancia de Azure Key Vault asociada al área de trabajo.

Este método no devuelve los valores de secretos.
set_secret

Agrega un secreto a la instancia de Azure Key Vault asociada al área de trabajo.
set_secrets

Agrega el diccionario de secretos a la instancia de Azure Key Vault asociada al área de trabajo.

delete_secret

Elimina el secreto con el nombre especificado.

delete_secret(name)

Parámetros

Nombre Description
name
Requerido
str

Nombre del secreto que se eliminará.

Devoluciones

Tipo Description
None

delete_secrets

Elimina una lista de secretos de la instancia de Azure Key Vault asociada al área de trabajo.

delete_secrets(secrets)

Parámetros

Nombre Description
secrets_batch
Requerido
list[str]

Lista de secretos que se eliminarán.
secrets
Requerido

Devoluciones

Tipo Description
None

get_secret

Devuelve el valor del secreto para un nombre de secreto determinado.

get_secret(name)

Parámetros

Nombre Description
name
Requerido
str

Nombre del secreto para el que se devuelve el valor.

Devoluciones

Tipo Description
str

Valor del secreto para el nombre de secreto especificado.

get_secret_content_type

Devuelve el tipo de contenido del secreto para un nombre de secreto determinado.

get_secret_content_type(name)

Parámetros

Nombre Description
name
Requerido
str

Nombre del secreto para el que se va a devolver el tipo de contenido.

Devoluciones

Tipo Description
str

Tipo de contenido secreto para un nombre de secreto especificado.

get_secrets

Devuelve los valores de secretos para una lista determinada de nombres de secretos.

get_secrets(secrets)

Parámetros

Nombre Description
secrets
Requerido
list[str]

Lista de nombres de secretos para los que se recuperarán valores.

Devoluciones

Tipo Description
dict(str: str)

Diccionario de secretos encontrados y no encontrados.

list_secrets

Devuelve una lista de nombre secretos de la instancia de Azure Key Vault asociada al área de trabajo.

Este método no devuelve los valores de secretos.

list_secrets()

Devoluciones

Tipo Description
dict(str:str)

Lista del diccionario de nombres de secretos con el formato {name: "nombreSecreto"}

set_secret

Agrega un secreto a la instancia de Azure Key Vault asociada al área de trabajo.

set_secret(name, value, content_type=KeyVaultContentType.not_provided)

Parámetros

Nombre Description
name
Requerido
str

Nombre del secreto que se agregará.
value
Requerido
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

Valor del secreto que se agregará.
value
Requerido

Tipo de contenido del secreto que se va a agregar.
content_type
Valor predeterminado: KeyVaultContentType.not_provided

Devoluciones

Tipo Description
None

set_secrets

Agrega el diccionario de secretos a la instancia de Azure Key Vault asociada al área de trabajo.

set_secrets(secrets_batch)

Parámetros

Nombre Description
secrets_batch
Requerido
dict(<xref:str:str>)

Diccionario de nombres y valores de secretos que se agregarán.

Devoluciones

Tipo Description
None