Partager via


Keyvault Classe

Gère les secrets stockés dans Azure Key Vault associé à un espace de travail Azure Machine Learning.

Chaque espace de travail Azure Machine Learning a un coffre de clés Azure associé. La classe KeyVault est un wrapper simplifié d’Azure Key Vault qui vous permet de gérer les secrets dans le coffre de clés, notamment le paramètre, la récupération, la suppression et la description des secrets. Utilisez la classe Keyvault pour transmettre des secrets à des exécutions à distance en toute sécurité sans exposer des informations sensibles en clair.

Pour plus d’informations, consultez Utilisation des secrets dans les exécutions d’entraînement.

Constructeur Keyvault de classe.

Constructeur

Keyvault(workspace)

Paramètres

Nom Description
workspace
Obligatoire

Espace de travail Azure Machine Learning associé à ce coffre de clés.

workspace
Obligatoire

Espace de travail Azure Machine Learning associé à ce coffre de clés.

Remarques

Dans les exécutions envoyées sur le calcul local et distant, vous pouvez utiliser la get_secret méthode de l’instance d’exécution pour obtenir la valeur secrète à partir de Key Vault. Pour obtenir plusieurs secrets, utilisez la get_secrets méthode de l’instance Run.

Ces méthodes d’exécution vous donnent un raccourci simple, car l’instance d’exécution connaît son espace de travail et son coffre de clés et peut obtenir directement le secret sans avoir à instancier l’espace de travail et le coffre de clés au sein de l’exécution à distance.

L’exemple suivant montre comment accéder au coffre de clés par défaut associé à un espace de travail et définir un secret.


   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’exemple complet est disponible à partir de https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/manage-azureml-service/authentication-in-azureml/authentication-in-azureml.ipynb

Méthodes

delete_secret

Supprimez le secret avec le nom spécifié.

delete_secrets

Supprimez la liste des secrets du coffre de clés Azure associé à l’espace de travail.

get_secret

Retourne la valeur secrète d’un nom de secret donné.

get_secret_content_type

Retourne le type de contenu du secret pour un nom de secret donné.

get_secrets

Retournez les valeurs de secret pour une liste donnée de noms de secrets.

list_secrets

Retourne la liste des noms de secrets du coffre de clés Azure associé à l’espace de travail.

Cette méthode ne retourne pas les valeurs secrètes.

set_secret

Ajoutez un secret à Azure Key Vault associé à l’espace de travail.

set_secrets

Ajoutez le dictionnaire de secrets au coffre de clés Azure associé à l’espace de travail.

delete_secret

Supprimez le secret avec le nom spécifié.

delete_secret(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom du secret à supprimer.

Retours

Type Description

delete_secrets

Supprimez la liste des secrets du coffre de clés Azure associé à l’espace de travail.

delete_secrets(secrets)

Paramètres

Nom Description
secrets_batch
Obligatoire

Liste des secrets à supprimer.

secrets
Obligatoire

Retours

Type Description

get_secret

Retourne la valeur secrète d’un nom de secret donné.

get_secret(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom du secret pour lequel retourner la valeur.

Retours

Type Description
str

Valeur secrète d’un nom de secret spécifié.

get_secret_content_type

Retourne le type de contenu du secret pour un nom de secret donné.

get_secret_content_type(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom du secret pour lequel retourner le type de contenu.

Retours

Type Description
str

Type de contenu secret pour un nom de secret spécifié.

get_secrets

Retournez les valeurs de secret pour une liste donnée de noms de secrets.

get_secrets(secrets)

Paramètres

Nom Description
secrets
Obligatoire

Liste des noms de secrets pour utilisant des valeurs.

Retours

Type Description

Dictionnaire des secrets trouvés et introuvables.

list_secrets

Retourne la liste des noms de secrets du coffre de clés Azure associé à l’espace de travail.

Cette méthode ne retourne pas les valeurs secrètes.

list_secrets()

Retours

Type Description

Liste des dictionnaires de noms de secrets au format {name : « secretName"}

set_secret

Ajoutez un secret à Azure Key Vault associé à l’espace de travail.

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

Paramètres

Nom Description
name
Obligatoire
str

Nom du secret à ajouter.

value
Obligatoire
<xref:azureml.core.azureml._restclient.models.KeyVaultContentType>

Valeur du secret à ajouter.

value
Obligatoire

Type de contenu du secret à ajouter.

content_type
Valeur par défaut: KeyVaultContentType.not_provided

Retours

Type Description

set_secrets

Ajoutez le dictionnaire de secrets au coffre de clés Azure associé à l’espace de travail.

set_secrets(secrets_batch)

Paramètres

Nom Description
secrets_batch
Obligatoire
dict(<xref:str:str>)

Dictionnaire de noms et de valeurs de secrets à ajouter.

Retours

Type Description