Compartir a través de

Keyvault Clase

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 secretos en el almacén de claves, incluida la configuración, la recuperación, eliminación y enumeración de secretos. Use la clase Keyvault para pasar secretos a ejecuciones remotas de forma segura sin exponer información confidencial en texto no cifrado.

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

Constructor keyvault de clase.

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 get_secret método de la instancia de ejecución para obtener el valor de secreto de Key Vault. Para obtener varios secretos, use el get_secrets método de la instancia run.

Estos métodos Run proporcionan un acceso directo sencillo porque la instancia de Ejecución es consciente de su área de trabajo y Keyvault, y puede obtener directamente el secreto sin necesidad de crear instancias del área de trabajo y keyvault 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 a 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

Elimine el secreto con el nombre especificado.
delete_secrets

Elimine una lista de secretos de Azure Key Vault asociado 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 secretos de una lista determinada de nombres secretos.
list_secrets

Devuelve la lista de nombres secretos de Azure Key Vault asociados al área de trabajo.

Este método no devuelve los valores secretos.
set_secret

Agregue un secreto a Azure Key Vault asociado al área de trabajo.
set_secrets

Agregue el diccionario de secretos a Azure Key Vault asociado al área de trabajo.

delete_secret

Elimine el secreto con el nombre especificado.

delete_secret(name)

Parámetros

Nombre Description
name
Requerido
str

Nombre del secreto que se va a eliminar.

Devoluciones

Tipo Description
None

delete_secrets

Elimine una lista de secretos de Azure Key Vault asociado al área de trabajo.

delete_secrets(secrets)

Parámetros

Nombre Description
secrets_batch
Requerido
list[str]

Lista de secretos que se van a eliminar.
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 va a devolver el valor.

Devoluciones

Tipo Description
str

Valor de secreto para un 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 secretos de una lista determinada de nombres secretos.

get_secrets(secrets)

Parámetros

Nombre Description
secrets
Requerido
list[str]

Lista de nombres secretos para los que se van a recuperar los valores.

Devoluciones

Tipo Description
dict(str: str)

Diccionario de secretos encontrados y no encontrados.

list_secrets

Devuelve la lista de nombres secretos de Azure Key Vault asociados al área de trabajo.

Este método no devuelve los valores secretos.

list_secrets()

Devoluciones

Tipo Description
dict(str:str)

Lista de diccionarios de nombres secretos con formato {name : "secretName"}

set_secret

Agregue un secreto a Azure Key Vault asociado 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 va a agregar.
value
Requerido
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

Valor del secreto que se va a 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

Agregue el diccionario de secretos a Azure Key Vault asociado al área de trabajo.

set_secrets(secrets_batch)

Parámetros

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

Diccionario de nombres y valores secretos que se van a agregar.

Devoluciones

Tipo Description
None