Keyvault Classe
Gestisce i segreti archiviati nel 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 del Key Vault di Azure che consente di gestire i segreti nell'insieme di credenziali delle chiavi, tra cui l'impostazione, il recupero, l'eliminazione e l'elenco dei segreti. Usare la classe Keyvault per passare i segreti alle esecuzioni remote in modo sicuro senza esporre informazioni riservate in testo non crittografato.
Per altre informazioni, vedere Uso dei segreti nelle esecuzioni di training.
Costruttore Keyvault della classe.
- Ereditarietà
-
builtins.objectKeyvault
Costruttore
Keyvault(workspace)
Parametri
Nome | Descrizione |
---|---|
workspace
Necessario
|
Area di lavoro di Azure Machine Learning associata a questo insieme di credenziali delle chiavi. |
workspace
Necessario
|
Area di lavoro di Azure Machine Learning associata a questo insieme di credenziali delle chiavi. |
Commenti
Nelle esecuzioni inviate in ambiente di calcolo locale e remoto è possibile usare il get_secret metodo dell'istanza Run per ottenere il valore del segreto da Key Vault. Per ottenere più segreti, usare il get_secrets metodo dell'istanza Run.
Questi metodi Run offrono un semplice collegamento perché l'istanza Run riconosce l'area di lavoro e l'insieme di credenziali delle chiavi e può ottenere direttamente il segreto senza la necessità di creare un'istanza dell'area di lavoro e dell'insieme di credenziali delle chiavi all'interno dell'esecuzione remota.
L'esempio seguente illustra 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 dal Key Vault di Azure associato all'area di lavoro. |
get_secret |
Restituisce il valore del segreto per un determinato nome di segreto. |
get_secret_content_type |
Restituisce il tipo di contenuto del segreto per un determinato nome segreto. |
get_secrets |
Restituisce i valori dei segreti per un determinato elenco di nomi segreti. |
list_secrets |
Restituire l'elenco dei nomi dei segreti dal Key Vault di Azure associato all'area di lavoro. Questo metodo non restituisce i valori del segreto. |
set_secret |
Aggiungere un segreto all'Key Vault di Azure associato all'area di lavoro. |
set_secrets |
Aggiungere il dizionario dei segreti al 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
|
Nome del segreto da eliminare. |
Restituisce
Tipo | Descrizione |
---|---|
delete_secrets
Eliminare un elenco di segreti dal Key Vault di Azure associato all'area di lavoro.
delete_secrets(secrets)
Parametri
Nome | Descrizione |
---|---|
secrets_batch
Necessario
|
Elenco di segreti da eliminare. |
secrets
Necessario
|
|
Restituisce
Tipo | Descrizione |
---|---|
get_secret
Restituisce il valore del segreto per un determinato nome di segreto.
get_secret(name)
Parametri
Nome | Descrizione |
---|---|
name
Necessario
|
Nome del segreto per cui restituire il valore. |
Restituisce
Tipo | Descrizione |
---|---|
Valore del segreto per un nome di 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
|
Nome del segreto per cui restituire il tipo di contenuto. |
Restituisce
Tipo | Descrizione |
---|---|
Tipo di contenuto segreto per un nome di segreto specificato. |
get_secrets
Restituisce i valori dei segreti per un determinato elenco di nomi segreti.
get_secrets(secrets)
Parametri
Nome | Descrizione |
---|---|
secrets
Necessario
|
Elenco di nomi segreti per cui recuperare i valori. |
Restituisce
Tipo | Descrizione |
---|---|
Dizionario di segreti trovati e non trovati. |
list_secrets
Restituire l'elenco dei nomi dei segreti dal Key Vault di Azure associato all'area di lavoro.
Questo metodo non restituisce i valori del segreto.
list_secrets()
Restituisce
Tipo | Descrizione |
---|---|
Elenco di dizionario di 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
|
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 |
---|---|
set_secrets
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per