Keyvault Classe

Gestisce i segreti archiviati nell'Key Vault di Azure associato a un'area di lavoro di Azure Machine Learning.

Ogni area di lavoro di Azure Machine Learning ha un Key Vault di Azure associato. La classe Keyvault è un wrapper semplificato della Key Vault di Azure che consente di gestire i segreti nell'insieme di credenziali delle chiavi, inclusi l'impostazione, il recupero, l'eliminazione e l'inserimento di segreti. Usare la classe Keyvault per passare i segreti alle esecuzioni remote in modo sicuro senza esporre le informazioni sensibili in formato cleartext.

Per altre informazioni, vedere Uso dei segreti nelle esecuzioni di training.

Costruttore Keyvault della classe.

Ereditarietà

builtins.object

Keyvault

Costruttore

Keyvault(workspace)

Parametri

Nome	Descrizione
workspace Necessario	Workspace Area di lavoro di Azure Machine Learning associata a questo insieme di credenziali delle chiavi.
workspace Necessario	Workspace Area di lavoro di Azure Machine Learning associata a questo insieme di credenziali delle chiavi.

Commenti

Nelle esecuzioni inviate in calcolo locale e remoto è possibile usare il get_secret metodo dell'istanza di Run per ottenere il valore segreto da Key Vault. Per ottenere più segreti, usare il get_secrets metodo dell'istanza di Run.

Questi metodi Run offrono un collegamento semplice perché l'istanza di Run è a conoscenza della relativa area di lavoro e keyvault e può ottenere direttamente il segreto senza la necessità di creare un'istanza dell'area di lavoro e di Keyvault all'interno dell'esecuzione remota.

Nell'esempio seguente viene illustrato come accedere all'insieme di credenziali delle chiavi predefinito associato a un'area di lavoro e impostare un segreto.

   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)

L'esempio completo è disponibile da https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Metodi

delete_secret	Eliminare il segreto con il nome specificato.
delete_secrets	Eliminare un elenco di segreti dall'Key Vault di Azure associato all'area di lavoro.
get_secret	Restituisce il valore segreto per un determinato nome segreto.
get_secret_content_type	Restituisce il tipo di contenuto del segreto per un determinato nome segreto.
get_secrets	Restituisce i valori segreti per un elenco specificato di nomi segreti.
list_secrets	Restituisce l'elenco dei nomi segreti del Key Vault di Azure associato all'area di lavoro. Questo metodo non restituisce i valori segreti.
set_secret	Aggiungere un segreto all'Key Vault di Azure associato all'area di lavoro.
set_secrets	Aggiungere il dizionario dei segreti all'Key Vault di Azure associato all'area di lavoro.

delete_secret

Eliminare il segreto con il nome specificato.

delete_secret(name)

Parametri

Nome	Descrizione
name Necessario	str Nome del segreto da eliminare.

Restituisce

Tipo	Descrizione
None

delete_secrets

Eliminare un elenco di segreti dall'Key Vault di Azure associato all'area di lavoro.

delete_secrets(secrets)

Parametri

Nome	Descrizione
secrets_batch Necessario	list[str] Elenco dei segreti da eliminare.
secrets Necessario

Restituisce

Tipo	Descrizione
None

get_secret

Restituisce il valore segreto per un determinato nome segreto.

get_secret(name)

Parametri

Nome	Descrizione
name Necessario	str Nome segreto per restituire il valore per.

Restituisce

Tipo	Descrizione
str	Valore segreto per un nome segreto specificato.

get_secret_content_type

Restituisce il tipo di contenuto del segreto per un determinato nome segreto.

get_secret_content_type(name)

Parametri

Nome	Descrizione
name Necessario	str Nome segreto per restituire il tipo di contenuto per.

Restituisce

Tipo	Descrizione
str	Tipo di contenuto segreto per un nome segreto specificato.

get_secrets

Restituisce i valori segreti per un elenco specificato di nomi segreti.

get_secrets(secrets)

Parametri

Nome	Descrizione
secrets Necessario	list[str] Elenco dei nomi segreti per recuperare i valori.

Restituisce

Tipo	Descrizione
dict(str: str)	Dizionario di segreti trovati e non trovati.

list_secrets

Restituisce l'elenco dei nomi segreti del Key Vault di Azure associato all'area di lavoro.

Questo metodo non restituisce i valori segreti.

list_secrets()

Restituisce

Tipo	Descrizione
dict(str:str)	Elenco di dizionario dei nomi segreti con formato {name : "secretName"}

set_secret

Aggiungere un segreto all'Key Vault di Azure associato all'area di lavoro.

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

Parametri

Nome	Descrizione
name Necessario	str Nome del segreto da aggiungere.
value Necessario	<xref:azureml.core.azureml._restclient.models.KeyVaultContentType> Valore del segreto da aggiungere.
value Necessario	Tipo di contenuto del segreto da aggiungere.
content_type	Valore predefinito: KeyVaultContentType.not_provided

Restituisce

Tipo	Descrizione
None

set_secrets

Aggiungere il dizionario dei segreti all'Key Vault di Azure associato all'area di lavoro.

set_secrets(secrets_batch)

Parametri

Nome	Descrizione
secrets_batch Necessario	dict(<xref:str:str>) Dizionario di nomi e valori segreti da aggiungere.

Restituisce

Tipo	Descrizione
None