Keyvault Classe

Gerencia os segredos armazenados no Azure Key Vault associado a um workspace do Azure Machine Learning.

Cada workspace do Azure Machine Learning tem um Azure Key Vault associado. A classe Keyvault é um wrapper simplificado do Azure Key Vault que permite a você gerenciar segredos no cofre de chaves, incluindo configuração, recuperação, exclusão e listagem de segredos. Use a classe Keyvault para passar segredos para execuções remotas com segurança sem expor informações confidenciais em texto não criptografado.

Para obter mais informações, consulte Usar segredos em execuções de treinamento.

Construtor keyvault de classe.

Herança

builtins.object

Keyvault

Construtor

Keyvault(workspace)

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace do Azure Machine Learning associado a esse cofre de chaves.
workspace Obrigatório	Workspace O workspace do Azure Machine Learning associado a esse cofre de chaves.

Comentários

Em execuções enviadas em computação local e remoto, você pode usar o método get_secret da instância de Execução para obter o valor do segredo do Key Vault. Para obter vários segredos, use o método get_secrets da instância de Execução.

Esses métodos de Execução fornecem um atalho simples porque a instância de Execução reconhece seu workspace e o Keyvault, e pode obter diretamente o segredo sem a necessidade de instanciar o workspace e o Keyvault na execução remota.

O exemplo a seguir mostra como acessar o cofre de chaves padrão associado a um workspace 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 em 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	Exclua o segredo com o nome especificado.
delete_secrets	Exclua uma lista de segredos do Azure Key Vault associado ao workspace.
get_secret	Retorna a valor do segredo para um determinado nome de segredo.
get_secret_content_type	Retornar o tipo de conteúdo do segredo para um determinado nome secreto.
get_secrets	Retorna os valores de segredos para uma determinada lista de nomes de segredo.
list_secrets	Retorna a lista de nomes de segredos do Azure Key Vault associado ao workspace. Esse método não retorna os valores dos segredos.
set_secret	Adicione um segredo ao Azure Key Vault associado ao workspace.
set_secrets	Adicione um dicionário de segredos ao Azure Key Vault associado ao workspace.

delete_secret

Exclua o segredo com o nome especificado.

delete_secret(name)

Parâmetros

Nome	Description
name Obrigatório	str O nome do segredo a ser excluído.

Retornos

Tipo	Description
None

delete_secrets

Exclua uma lista de segredos do Azure Key Vault associado ao workspace.

delete_secrets(secrets)

Parâmetros

Nome	Description
secrets_batch Obrigatório	list[str] O lista de segredos a serem excluídos.
secrets Obrigatório

Retornos

Tipo	Description
None

get_secret

Retorna a valor do segredo para um determinado nome de segredo.

get_secret(name)

Parâmetros

Nome	Description
name Obrigatório	str O nome do segredo para o qual retornar o valor.

Retornos

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

get_secret_content_type

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

get_secret_content_type(name)

Parâmetros

Nome	Description
name Obrigatório	str O nome do segredo para o qual retornar o tipo de conteúdo.

Retornos

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

get_secrets

Retorna os valores de segredos para uma determinada lista de nomes de segredo.

get_secrets(secrets)

Parâmetros

Nome	Description
secrets Obrigatório	list[str] A lista de nomes de segredo para os quais recuperar valores.

Retornos

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

list_secrets

Retorna a lista de nomes de segredos do Azure Key Vault associado ao workspace.

Esse método não retorna os valores dos segredos.

list_secrets()

Retornos

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

set_secret

Adicione um segredo ao Azure Key Vault associado ao workspace.

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

Parâmetros

Nome	Description
name Obrigatório	str O nome do segredo a ser adicionado.
value Obrigatório	<xref:azureml.core.azureml._restclient.models.KeyVaultContentType> O valor do segredo a ser adicionado.
value Obrigatório	O tipo de conteúdo do segredo a ser adicionado.
content_type	Valor padrão: KeyVaultContentType.not_provided

Retornos

Tipo	Description
None

set_secrets

Adicione um dicionário de segredos ao Azure Key Vault associado ao workspace.

set_secrets(secrets_batch)

Parâmetros

Nome	Description
secrets_batch Obrigatório	dict(<xref:str:str>) Um dicionário de nomes e valores de segredo a serem adicionados.

Retornos

Tipo	Description
None