Schéma YAML de l’espace de travail CLI (v2)

Article
09/01/2024

S’APPLIQUE À : Extension ml Azure CLI v2 (actuelle)

Le schéma JSON source se trouve à l’adresse https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Notes

La syntaxe YAML détaillée dans ce document est basée sur le schéma JSON pour la dernière version de l’extension ML CLI v2. Le fonctionnement de cette syntaxe est garanti uniquement avec la dernière version de l’extension ML CLI v2. Vous trouverez les schémas des versions d’extension plus anciennes sur https://azuremlschemasprod.azureedge.net/.

Syntaxe YAML

Clé	Type	Description	Valeurs autorisées	Valeur par défaut
`$schema`	string	Schéma YAML. Si vous utilisez l’extension VS Code d’Azure Machine Learning pour créer le fichier YAML, en incluant `$schema` en haut de votre fichier, vous pouvez appeler des complétions de schémas et de ressources.
`name`	string	Obligatoire. Nom de l’espace de travail.
`display_name`	string	Nom complet de l’espace de travail dans l’interface utilisateur du studio. Peut être non unique au sein du groupe de ressources.
`description`	string	Description de l’espace de travail.
`tags`	object	Dictionnaire d’étiquettes pour l’espace de travail.
`location`	string	Emplacement de l’espace de travail. En cas d’omission, la valeur par défaut est l’emplacement du groupe de ressources.
`resource_group`	string	Obligatoire. Groupe de ressources contenant l’espace de travail. Si le groupe de ressources n’existe pas, un groupe est créé.
`hbi_workspace`	boolean	Si les données client ont un impact élevé sur l’activité parce qu’elles contiennent des informations professionnelles sensibles. Pour plus d’informations, consultez les Chiffrement de données au repos.		`false`
`storage_account`	string	ID de ressource complet d’un compte de stockage Azure existant à utiliser comme compte de stockage par défaut pour l’espace de travail. Un compte de stockage avec un stockage Premium ou un espace de noms hiérarchique ne peut pas être utilisé comme compte de stockage par défaut. En cas d’omission, un nouveau compte de stockage est créé.
`container_registry`	string	ID de ressource complet d’un registre de conteneurs Azure existant à utiliser comme registre de conteneurs par défaut pour l’espace de travail. Azure Machine Learning utilise Azure Container Registry (ACR) pour la gestion des images de conteneur utilisées pour l’apprentissage et le déploiement. En cas d’omission, un nouveau registre de conteneurs est créé. La création étant chargée en différé, le registre de conteneurs est créé la première fois qu’il est nécessaire pour une opération d’apprentissage ou de déploiement.
`key_vault`	string	ID de ressource complet d’un coffre de clés Azure existant à utiliser comme coffre de clés par défaut pour l’espace de travail. En cas d’omission, un coffre de clés est créé.
`application_insights`	string	ID de ressource complet d’une fonctionnalité Azure Application Insights existante à utiliser comme fonctionnalité Application Insights par défaut pour l’espace de travail. En cas d’omission, une nouvelle fonctionnalité Application Insights est créée.
`customer_managed_key`	object	Azure Machine Learning stocke les métadonnées dans une instance d’Azure Cosmos DB. Par défaut, les données sont chiffrées au repos avec des clés gérées par Microsoft. Pour utiliser votre propre clé gérée par le client pour le chiffrement, spécifiez les informations de clé gérée par le client dans cette section. Pour plus d’informations, consultez Chiffrement de données pour Azure Cosmos DB.
`customer_managed_key.key_vault`	string	ID de ressource complet du coffre de clés contenant la clé gérée par le client. Ce coffre de clés peut être différent du coffre de clés par défaut de l’espace de travail spécifié dans `key_vault`.
`customer_managed_key.key_uri`	string	URI de clé de la clé gérée par le client pour chiffrer les données au repos. Le format d’URI est `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`.
`image_build_compute`	string	Nom de la cible de calcul à utiliser pour la génération d’images Docker d’environnement lorsque le registre de conteneurs se trouve derrière un réseau virtuel. Pour plus d’informations, consultez Sécuriser des ressources d’espace de travail derrière des réseaux virtuels.
`public_network_access`	string	Indique si l’accès au point de terminaison public est autorisé quand l’espace de travail utilise Private Link. Pour plus d’informations, consultez Activer l’accès public derrière des réseaux virtuels.	`enabled`, `disabled`	`disabled`
`managed_network`	object	Isolation de réseau gérée de l’espace de travail Azure Machine Learning. Pour plus d’informations, consultez Isolement réseau managé d’espace de travail.

Remarques

La commande az ml workspace peut être utilisée pour gérer les espaces de travail Azure Machine Learning.

Exemples

Des exemples sont disponibles dans le référentiel d’exemples GitHub. Vous en trouverez plusieurs ci-dessous.

YAML : de base

$schema: https://azuremlschemas.azureedge.net/latest/workspace.schema.json
name: mlw-basic-prod
location: eastus
display_name: Basic workspace-example
description: This example shows a YML configuration for a basic workspace. In case you use this configuration to deploy a new workspace, since no existing dependent resources are specified, these will be automatically created.
hbi_workspace: false
tags:
  purpose: demonstration

YAML : avec des ressources existantes

$schema: https://azuremlschemas.azureedge.net/latest/workspace.schema.json
name: mlw-basicex-prod
location: eastus
display_name: Bring your own dependent resources-example
description: This configuration specifies a workspace configuration with existing dependent resources
storage_account: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.Storage/storageAccounts/<STORAGE_ACCOUNT>
container_registry: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.ContainerRegistry/registries/<CONTAINER_REGISTRY>
key_vault: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.KeyVault/vaults/<KEY_VAULT>
application_insights: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.insights/components/<APP_INSIGHTS>
tags:
  purpose: demonstration

YAML : clé gérée par le client

$schema: https://azuremlschemas.azureedge.net/latest/workspace.schema.json
name: mlw-cmkexample-prod
location: eastus
display_name: Customer managed key encryption-example
description: This configurations shows how to create a workspace that uses customer-managed keys for encryption.
customer_managed_key: 
  key_vault: /subscriptions/<SUBSCRIPTION_ID>/resourceGroups/<RESOURCE_GROUP>/providers/Microsoft.KeyVault/vaults/<KEY_VAULT>
  key_uri: https://<KEY_VAULT>.vault.azure.net/keys/<KEY_NAME>/<KEY_VERSION>
tags:
  purpose: demonstration

YAML : liaison privée

$schema: https://azuremlschemas.azureedge.net/latest/workspace.schema.json
name: mlw-privatelink-prod
location: eastus
display_name: Private Link endpoint workspace-example
description: When using private link, you must set the image_build_compute property to a cluster name to use for Docker image environment building. You can also specify whether the workspace should be accessible over the internet.
image_build_compute: cpu-compute
public_network_access: Disabled
tags:
  purpose: demonstration

YAML : impact élevé sur l’activité

$schema: https://azuremlschemas.azureedge.net/latest/workspace.schema.json
name: mlw-hbiexample-prod
location: eastus
display_name: High business impact-example
description: This configuration shows how to configure a workspace with the hbi flag enabled. This flag specifies whether to reduce telemetry collection and enable additional encryption when high-business-impact data is used.
hbi_workspace: true
tags:
  purpose: demonstration

YAML : réseau managé avec autoriser le trafic sortant Internet

name: myworkspace_aio
managed_network:
  isolation_mode: allow_internet_outbound
  outbound_rules:
  - name: added-perule
    type: private_endpoint
    destination:
      service_resource_id: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/MyAccount1
      spark_enabled: true
      subresource_target: blob
  - name: added-perule2
    type: private_endpoint
    destination:
      service_resource_id: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/MyAccount2
      spark_enabled: true
      subresource_target: file

YAML : réseau managé avec autoriser uniquement le trafic approuvé sortant

name: myworkspace_dep
managed_network:
  isolation_mode: allow_only_approved_outbound
  outbound_rules:
  - name: added-servicetagrule
    type: service_tag
    destination:
      port_ranges: 80, 8080
      protocol: TCP
      service_tag: DataFactory
  - name: added-perule
    type: private_endpoint
    destination:
      service_resource_id: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/MyAccount2
      spark_enabled: true
      subresource_target: blob
  - name: added-fqdnrule
    type: fqdn
    destination: 'test2.com'

Étapes suivantes

Installer et utiliser l’interface CLI (v2)

Partage via