Keyvault Classe
Gerencia 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 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 claro.
Para obter mais informações, consulte Como usar segredos em execuções de treinamento.
Construtor keyvault de classe.
Construtor
Keyvault(workspace)Parâmetros
| Nome | Description |
|---|---|
|
workspace
Obrigatório
|
O Workspace do Azure Machine Learning associado a esse cofre de chaves. |
|
workspace
Obrigatório
|
O Workspace do Azure Machine Learning associado a esse cofre de chaves. |
Comentários
Em execuções enviadas na computação local e remota, você pode usar o get_secret método da instância Executar para obter o valor secreto do Key Vault. Para obter vários segredos, use o get_secrets método da instância Executar.
Esses métodos De execução permitem um atalho simples porque a instância Executar 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 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 |
Retornar o valor do segredo para um determinado nome secreto. |
| get_secret_content_type |
Retorne o tipo de conteúdo do segredo para um determinado nome secreto. |
| get_secrets |
Retorne os valores secretos para uma determinada lista de nomes secretos. |
| list_secrets |
Retorne a lista de nomes secretos do Azure Key Vault associado ao workspace. Esse método não retorna os valores secretos. |
| set_secret |
Adicione um segredo ao Azure Key Vault associado ao workspace. |
| set_secrets |
Adicione o dicionário de segredos ao Azure Key Vault associado ao workspace. |
delete_secret
delete_secrets
get_secret
get_secret_content_type
Retorne o tipo de conteúdo do segredo para um determinado nome secreto.
get_secret_content_type(name)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
O nome do segredo para o qual retornar o tipo de conteúdo. |
Retornos
| Tipo | Description |
|---|---|
|
O tipo de conteúdo secreto para um nome de segredo especificado. |
get_secrets
Retorne os valores secretos para uma determinada lista de nomes secretos.
get_secrets(secrets)Parâmetros
| Nome | Description |
|---|---|
|
secrets
Obrigatório
|
A lista de nomes de segredo para os qual recuperar valores. |
Retornos
| Tipo | Description |
|---|---|
|
Um dicionário de segredos encontrados e não encontrados. |
list_secrets
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
|
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 |
|---|---|