Partilhar via

Keyvault Classe

Gerencia segredos armazenados no Cofre da Chave do Azure associado a um espaço de trabalho do Azure Machine Learning.

Cada espaço de trabalho do Azure Machine Learning tem um Cofre da Chave do Azure associado. A classe Keyvault é um wrapper simplificado do Azure Key Vault que permite 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 Usando segredos em execuções de treinamento.

Construtor Class Keyvault.

Construtor

Keyvault(workspace)

Parâmetros

Name Description
workspace
Necessário
Workspace

O Espaço de Trabalho do Azure Machine Learning associado a este cofre de chaves.
workspace
Necessário
Workspace

O Espaço de Trabalho do Azure Machine Learning associado a este cofre de chaves.

Observações

Em execuções enviadas em computação local e remota, você pode usar 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.

Esses métodos Run fornecem um atalho simples porque a instância Run está ciente de seu Workspace e Keyvault e pode obter diretamente o segredo sem a necessidade de instanciar o Workspace e o Keyvault dentro da 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)

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

Retornar o valor secreto para um determinado nome secreto.
get_secret_content_type

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

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

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

Este método não retorna os valores secretos.
set_secret

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

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

delete_secret

Exclua o segredo com o nome especificado.

delete_secret(name)

Parâmetros

Name Description
name
Necessário
str

O nome do segredo a ser excluído.

Devoluções

Tipo Description
None

delete_secrets

Exclua uma lista de segredos do Cofre da Chave do Azure associado ao espaço 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

Retornar o valor secreto para um determinado nome secreto.

get_secret(name)

Parâmetros

Name Description
name
Necessário
str

O nome secreto para o qual retornar o valor.

Devoluções

Tipo Description
str

O valor secreto para um nome secreto 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

Name Description
name
Necessário
str

O nome secreto para o qual retornar o tipo de conteúdo.

Devoluções

Tipo Description
str

O tipo de conteúdo secreto para um nome secreto especificado.

get_secrets

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

get_secrets(secrets)

Parâmetros

Name Description
secrets
Necessário
list[str]

A lista de nomes secretos para os quais recuperar valores.

Devoluções

Tipo Description
dict(str: str)

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

list_secrets

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

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

list_secrets()

Devoluções

Tipo Description
dict(str:str)

Uma lista de dicionário de nomes secretos com formato {name : "secretName"}

set_secret

Adicione um segredo ao Cofre da Chave do Azure associado ao espaço 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 acrescentar.
value
Necessário

O tipo de conteúdo do segredo a ser adicionado.
content_type
Default value: KeyVaultContentType.not_provided

Devoluções

Tipo Description
None

set_secrets

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

Devoluções

Tipo Description
None