Keyvault Classe

Gere segredos armazenados no Azure Key Vault associados a uma área de trabalho do Azure Machine Learning.

Cada área de trabalho do Azure Machine Learning tem uma Key Vault do Azure associada. A classe Keyvault é um wrapper simplificado do Key Vault do Azure que lhe permite gerir segredos no cofre de chaves, incluindo definir, obter, eliminar e listar segredos. Utilize a classe Keyvault para transmitir segredos para execuções remotas de forma segura sem expor informações confidenciais em texto não encriptado.

Para obter mais informações, veja Utilizar segredos em execuções de preparação.

Construtor keyvault de classe.

Herança

builtins.object

Keyvault

Construtor

Keyvault(workspace)

Parâmetros

Name	Description
workspace Necessário	Workspace A Área de Trabalho do Azure Machine Learning associada a este cofre de chaves.
workspace Necessário	Workspace A Área de Trabalho do Azure Machine Learning associada a este cofre de chaves.

Observações

Em execuções submetidas em computação local e remota, pode utilizar o get_secret método da instância Executar para obter o valor secreto de Key Vault. Para obter múltiplos segredos, utilize o get_secrets método da instância Executar.

Estes métodos Executar fornecem-lhe um atalho simples porque a instância Executar tem conhecimento da área de trabalho e do Keyvault e pode obter diretamente o segredo sem a necessidade de instanciar a Área de Trabalho e o Keyvault na execução remota.

O exemplo seguinte mostra como aceder ao cofre de chaves predefinido associado a uma área de trabalho e definir um segredo.

   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)

O exemplo completo está disponível a partir de 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 o segredo com o nome especificado.
delete_secrets	Elimine uma lista de segredos do Azure Key Vault associados à área de trabalho.
get_secret	Devolver o valor do segredo de um determinado nome de segredo.
get_secret_content_type	Devolver o tipo de conteúdo do segredo para um determinado nome de segredo.
get_secrets	Devolver os valores secretos de uma determinada lista de nomes de segredos.
list_secrets	Devolva a lista de nomes de segredos do Key Vault do Azure associados à área de trabalho. Este método não devolve os valores secretos.
set_secret	Adicione um segredo à Key Vault do Azure associada à área de trabalho.
set_secrets	Adicione o dicionário de segredos à Key Vault do Azure associada à área de trabalho.

delete_secret

Elimine o segredo com o nome especificado.

delete_secret(name)

Parâmetros

Name	Description
name Necessário	str O nome do segredo a eliminar.

Devoluções

Tipo	Description
None

delete_secrets

Elimine uma lista de segredos do Azure Key Vault associados à área de trabalho.

delete_secrets(secrets)

Parâmetros

Name	Description
secrets_batch Necessário	list[str] A lista de segredos a eliminar.
secrets Necessário

Devoluções

Tipo	Description
None

get_secret

Devolver o valor do segredo de um determinado nome de segredo.

get_secret(name)

Parâmetros

Name	Description
name Necessário	str O nome do segredo para o qual devolver o valor.

Devoluções

Tipo	Description
str	O valor do segredo de um nome de segredo especificado.

get_secret_content_type

Devolver o tipo de conteúdo do segredo para um determinado nome de segredo.

get_secret_content_type(name)

Parâmetros

Name	Description
name Necessário	str O nome do segredo para o qual devolver o tipo de conteúdo.

Devoluções

Tipo	Description
str	O tipo de conteúdo secreto para um nome de segredo especificado.

get_secrets

Devolver os valores secretos de uma determinada lista de nomes de segredos.

get_secrets(secrets)

Parâmetros

Name	Description
secrets Necessário	list[str] A lista de nomes secretos para os qual obter valores.

Devoluções

Tipo	Description
dict(str: str)	Um dicionário de segredos encontrados e não encontrados.

list_secrets

Devolva a lista de nomes de segredos do Key Vault do Azure associados à área de trabalho.

Este método não devolve os valores secretos.

list_secrets()

Devoluções

Tipo	Description
dict(str:str)	Uma lista de dicionários de nomes secretos com o formato {name : "secretName"}

set_secret

Adicione um segredo à Key Vault do Azure associada à área de trabalho.

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

Parâmetros

Name	Description
name Necessário	str O nome do segredo a adicionar.
value Necessário	<xref:azureml.core.azureml._restclient.models.KeyVaultContentType> O valor do segredo a adicionar.
value Necessário	O tipo de conteúdo do segredo a adicionar.
content_type	Default value: KeyVaultContentType.not_provided

Devoluções

Tipo	Description
None

set_secrets

Adicione o dicionário de segredos à Key Vault do Azure associada à área de trabalho.

set_secrets(secrets_batch)

Parâmetros

Name	Description
secrets_batch Necessário	dict(<xref:str:str>) Um dicionário de nomes e valores secretos a adicionar.

Devoluções

Tipo	Description
None