Keyvault Classe

Gere segredos armazenados no Cofre da Chave Azure associado a um espaço de trabalho de Aprendizagem de Máquinas Azure.

Cada espaço de trabalho Azure Machine Learning tem um cofre de chaves Azureassociado. A classe Keyvault é um invólucro simplificado do Cofre da Chave Azure que lhe permite gerir segredos no cofre chave, incluindo configuração, recuperação, eliminação e listagem de segredos. Utilize a classe Keyvault para passar segredos para correr remotamente sem expor informações sensíveis em texto claro.

Para mais informações, consulte Usando segredos em treinos.

Herança
builtins.object
Keyvault

Construtor

Keyvault(workspace)

Parâmetros

workspace
Workspace

O espaço de trabalho de aprendizagem da máquina Azure associado a este cofre chave.

Observações

Em execuções submetidas em computação local e remota, pode utilizar o get_secret método da instância Run para obter o valor secreto do Key Vault. Para obter vários segredos, use o get_secrets método da instância Run.

Estes métodos de Execução dão-lhe um simples atalho porque a instância Run está ciente do seu espaço de trabalho e keyvault, e pode obter diretamente o segredo sem a necessidade de instantaneaizar o Espaço de Trabalho e o Keyvault dentro do percurso remoto.

O exemplo a seguir mostra como aceder ao 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)

A amostra completa 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 Cofre da Chave Azure associado ao espaço de trabalho.

get_secret

Devolva o valor secreto para um nome secreto.

get_secrets

Devolva os valores secretos para uma dada lista de nomes secretos.

list_secrets

Devolva a lista de nomes secretos do Cofre da Chave Azure associado ao espaço de trabalho.

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

set_secret

Adicione um segredo ao Cofre da Chave Azure associado ao espaço de trabalho.

set_secrets

Adicione o dicionário de segredos ao Cofre da Chave Azure associado ao espaço de trabalho.

delete_secret

Elimine o segredo com o nome especificado.

delete_secret(name)

Parâmetros

name
<xref:str>

O nome do segredo para apagar.

Tipo de retorno

<xref:None>

delete_secrets

Elimine uma lista de segredos do Cofre da Chave Azure associado ao espaço de trabalho.

delete_secrets(secrets)

Parâmetros

secrets_batch
list[<xref:str>]

A lista de segredos para apagar.

Tipo de retorno

<xref:None>

get_secret

Devolva o valor secreto para um nome secreto.

get_secret(name)

Parâmetros

name
<xref:str>

O nome secreto para devolver o valor.

Devoluções

O valor secreto para um nome secreto especificado.

Tipo de retorno

<xref:str>

get_secrets

Devolva os valores secretos para uma dada lista de nomes secretos.

get_secrets(secrets)

Parâmetros

secrets
list[<xref:str>]

A lista de nomes secretos para recuperar valores.

Devoluções

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

Tipo de retorno

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

list_secrets

Devolva a lista de nomes secretos do Cofre da Chave Azure associado ao espaço de trabalho.

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

list_secrets()

Devoluções

Uma lista de nomes secretos com formato {nome : "Nome secreto"}

Tipo de retorno

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

set_secret

Adicione um segredo ao Cofre da Chave Azure associado ao espaço de trabalho.

set_secret(name, value)

Parâmetros

name
<xref:str>

O nome do segredo a acrescentar.

value
<xref:str>

O valor do segredo a acrescentar.

Tipo de retorno

<xref:None>

set_secrets

Adicione o dicionário de segredos ao Cofre da Chave Azure 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 adicionar.

Tipo de retorno

<xref:None>