Keyvault Classe

  • Référence

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

Chaque espace de travail Azure Machine Learning est associé à un coffre Azure Key Vault. La classe Keyvault est un wrapper simplifié du coffre Azure Key Vault qui vous permet de gérer les secrets du coffre de clés, notamment la définition, la récupération, la suppression et la création de listes de secrets. Utilisez la classe Keyvault pour transmettre des secrets aux exécutions distantes en toute sécurité sans exposer les informations sensibles en texte clair.

Pour plus d’informations, consultez Utiliser les secrets dans les exécutions d’apprentissage.

Constructeur de keyvault de classe.

Héritage
builtins.object
Keyvault

Constructeur

Keyvault(workspace)

Paramètres

Nom Description
workspace
Obligatoire
Workspace

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

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

Remarques

Dans les exécutions soumises sur un ordinateur local et distant, vous pouvez utiliser la méthode get_secret de l’instance d’exécution pour récupérer la valeur du secret à partir de Key Vault. Pour recevoir plusieurs secrets, utilisez la méthode get_secrets de l’instance d’exécution.

Ces méthodes d’exécution vous offrent un raccourci simple, car l’instance d’exécution est consciente de son espace de travail et de 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 distante.

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 sur 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

Supprime le secret portant le nom indiqué.
delete_secrets

Supprime une liste de secrets du coffre Azure Key Vault associé à l’espace de travail.
get_secret

Retourne la valeur du secret pour un nom de secret donné.
get_secret_content_type

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

Retourne les valeurs de secrets pour une liste donnée de noms de secrets.
list_secrets

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

Cette méthode ne retourne pas les valeurs de secrets.
set_secret

Ajoute un secret au coffre Azure Key Vault associé à l’espace de travail.
set_secrets

Ajoute un secret au coffre Azure Key Vault associé à l’espace de travail.

delete_secret

Supprime le secret portant le nom indiqué.

delete_secret(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom du secret à supprimer.

Retours

Type Description
None

delete_secrets

Supprime une liste de secrets du coffre Azure Key Vault associé à l’espace de travail.

delete_secrets(secrets)

Paramètres

Nom Description
secrets_batch
Obligatoire
list[str]

Liste des secrets à supprimer.
secrets
Obligatoire

Retours

Type Description
None

get_secret

Retourne la valeur du secret pour un nom de secret donné.

get_secret(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom du secret pour lequel la valeur doit être retournée.

Retours

Type Description
str

Valeur du secret pour un nom de secret indiqué.

get_secret_content_type

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

get_secret_content_type(name)

Paramètres

Nom Description
name
Obligatoire
str

Nom de 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

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

get_secrets(secrets)

Paramètres

Nom Description
secrets
Obligatoire
list[str]

Liste des noms de secrets pour lesquels récupérer les valeurs.

Retours

Type Description
dict(str: str)

Dictionnaire des secrets trouvés et introuvables.

list_secrets

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

Cette méthode ne retourne pas les valeurs de secrets.

list_secrets()

Retours

Type Description
dict(str:str)

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

set_secret

Ajoute un secret au coffre 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
None

set_secrets

Ajoute un secret au coffre Azure Key Vault associé à l’espace de travail.

set_secrets(secrets_batch)

Paramètres

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

Dictionnaire des noms et valeurs de secrets à ajouter.

Retours

Type Description
None