Keyvault Classe

Gerencia os segredos armazenados no Azure Key Vault associado a um espaço de trabalho Azure Machine Learning.

Cada espaço de trabalho Azure Machine Learning tem um Azure Key Vaultassociado. A classe keyvault é um wrapper simplificado do Azure Key Vault que permite que você gerencie 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 usando segredos em execuções de treinamento.

Herança
builtins.object
Keyvault

Construtor

Keyvault(workspace)

Parâmetros

workspace
Workspace

O Workspace do Azure Machine Learning associado a esse cofre de chaves.

Comentários

Em o envio é executado em computação local e remota, você pode usar o get_secret método da instância de execução para obter o valor secreto de Key Vault. Para obter vários segredos, use o get_secrets método 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 espaço de trabalho e o keyvault, e pode obter diretamente o segredo sem a necessidade de instanciar o espaço de trabalho e o keyvault na execução remota.

O exemplo a seguir mostra como acessar o cofre de chaves padrão associado a um espaço 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 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 espaço de trabalho.

get_secret

Retornar o valor secreto para um determinado nome de segredo.

get_secrets

Retornar os valores secretos para uma determinada lista de nomes de segredo.

list_secrets

Retornar a lista de nomes de segredo do Azure Key Vault associado ao espaço de trabalho.

Esse método não retorna os valores secretos.

set_secret

Adicione um segredo ao Azure Key Vault associado ao espaço de trabalho.

set_secrets

Adicione o dicionário de segredos ao Azure Key Vault associado ao espaço de trabalho.

delete_secret

Exclua o segredo com o nome especificado.

delete_secret(name)

Parâmetros

name
<xref:str>

O nome do segredo a ser excluído.

Tipo de retorno

<xref:None>

delete_secrets

Exclua uma lista de segredos do Azure Key Vault associado ao espaço de trabalho.

delete_secrets(secrets)

Parâmetros

secrets_batch
list[<xref:str>]

A lista de segredos a serem excluídos.

Tipo de retorno

<xref:None>

get_secret

Retornar o valor secreto para um determinado nome de segredo.

get_secret(name)

Parâmetros

name
<xref:str>

O nome do segredo para o qual retornar o valor.

Retornos

O valor secreto para um nome de segredo especificado.

Tipo de retorno

<xref:str>

get_secrets

Retornar os valores secretos para uma determinada lista de nomes de segredo.

get_secrets(secrets)

Parâmetros

secrets
list[<xref:str>]

A lista de nomes de segredo para os quais recuperar valores.

Retornos

Um dicionário de segredos encontrados e não encontrados.

Tipo de retorno

<xref:dict>(<xref:str: str>)

list_secrets

Retornar a lista de nomes de segredo do Azure Key Vault associado ao espaço de trabalho.

Esse método não retorna os valores secretos.

list_secrets()

Retornos

Uma lista de dicionários de nomes secretos com o formato {name: "secretname"}

Tipo de retorno

<xref:dict>(<xref:str:str>)

set_secret

Adicione um segredo ao Azure Key Vault associado ao espaço de trabalho.

set_secret(name, value)

Parâmetros

name
<xref:str>

O nome do segredo a ser adicionado.

value
<xref:str>

O valor do segredo a ser adicionado.

Tipo de retorno

<xref:None>

set_secrets

Adicione o dicionário de segredos ao Azure Key Vault associado ao espaço de trabalho.

set_secrets(secrets_batch)

Parâmetros

secrets_batch
<xref:dict>(<xref:str:str>)

Um dicionário de nomes e valores secretos a serem adicionados.

Tipo de retorno

<xref:None>