Esquema YAML del área de trabajo de la CLI (v2)

Artículo
07/06/2023

SE APLICA A:Extensión de ML de la CLI de Azure v2 (actual)

El esquema JSON de origen se puede encontrar en https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Nota

La sintaxis de YAML que se detalla en este documento se basa en el esquema JSON de la versión más reciente de la extensión ML de la CLI v2. Se garantiza que esta sintaxis solo funciona con la versión más reciente de la extensión ML de la CLI v2. Dispone de los esquemas de las versiones de anteriores de la extensión en https://azuremlschemasprod.azureedge.net/.

Sintaxis de YAML

Clave	Tipo	Descripción	Valores permitidos	Valor predeterminado
`$schema`	string	Esquema de YAML. Si usa la extensión VS Code de Azure Machine Learning para crear el archivo YAML, la inclusión de `$schema` en la parte superior del archivo le permite invocar las finalizaciones del esquema y los recursos.
`name`	string	Necesario. Nombre del área de trabajo.
`display_name`	string	Nombre para mostrar del área de trabajo en la interfaz de usuario de Studio. Puede no ser único dentro del grupo de recursos.
`description`	string	Descripción del área de trabajo.
`tags`	object	Diccionario de etiquetas del área de trabajo.
`location`	string	Ubicación del área de trabajo. Si se omite, el valor predeterminado es la ubicación del grupo de recursos.
`resource_group`	string	Necesario. Grupo de recursos que contiene el área de trabajo. Si el grupo de recursos no existe, se crea uno nuevo.
`hbi_workspace`	boolean	Si los datos del cliente son de alto impacto empresarial (HBI), con información empresarial confidencial. Para obtener más información, vea Cifrado en reposo de datos.		`false`
`storage_account`	string	Identificador de recurso completo de una cuenta de almacenamiento de Azure existente que se va a usar como cuenta de almacenamiento predeterminada del área de trabajo. Una cuenta de almacenamiento con almacenamiento premium o espacio de nombres jerárquico no se puede usar como cuenta de almacenamiento predeterminada. Si se omite, se crea una nueva cuenta de almacenamiento.
`container_registry`	string	Identificador de recurso completo de un registro de contenedor de Azure existente que se va a usar como registro de contenedor predeterminado del área de trabajo. Azure Machine Learning usa Azure Container Registry (ACR) para administrar las imágenes de contenedor que se usan para el entrenamiento y la implementación. Si se omite, se crea un nuevo registro de contenedor. La creación se carga de forma diferida, por lo que el registro de contenedor se crea la primera vez que se necesita para una operación de entrenamiento o implementación.
`key_vault`	string	Identificador de recurso completo de un almacén de claves de Azure existente que se va a usar como almacén de claves predeterminado del área de trabajo. Si se omite, se crea un nuevo almacén de claves.
`application_insights`	string	Identificador de recurso completo de una instancia de Azure Application Insights existente que se va a usar como instancia predeterminada de Application Insights del área de trabajo. Si se omite, se crea una nueva instancia de Application Insights.
`customer_managed_key`	object	Azure Machine Learning almacena metadatos en una instancia de Azure Cosmos DB. De manera predeterminada, los datos se cifran en reposo con claves administradas por Microsoft. Para usar una clave administrada por el cliente para el cifrado, especifique la información de la clave administrada por el cliente en esta sección. Para obtener más información, vea Cifrado de datos de Azure Cosmos DB.
`customer_managed_key.key_vault`	string	Identificador de recurso completo del almacén de claves que contiene la clave administrada por el cliente. Este almacén de claves puede ser diferente al almacén de claves del área de trabajo predeterminado especificado en `key_vault`.
`customer_managed_key.key_uri`	string	URI de clave de la clave administrada por el cliente para cifrar datos en reposo. El formato URI es `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`.
`image_build_compute`	string	Nombre del destino de proceso que se va a usar para compilar imágenes de Docker del entorno cuando el registro de contenedor está detrás de una red virtual. Para obtener más información, vea Protección de los recursos del área de trabajo con redes virtuales (VNet).
`public_network_access`	string	Si se permite el acceso al punto de conexión público si el área de trabajo va a usar Private Link. Para obtener más información, vea Habilitación del acceso público cuando se está detrás de redes virtuales.	`enabled`, `disabled`	`disabled`
`managed_network`	object	Aislamiento de red gestionada por el área de trabajo de Azure Machine Learning. Para más información, consulte Aislamiento de red gestionada del área de trabajo.

Comentarios

El comando az ml workspace se puede usar para administrar las áreas de trabajo de Azure Machine Learning.

Ejemplos

Hay ejemplos disponibles en el repositorio de GitHub de ejemplos. A continuación, se muestran varios.

YAML: básico

$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: con recursos existentes

$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: clave administrada por el cliente

$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: vínculo privado

$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: alto impacto para la empresa

$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: red gestionada con salida a Internet permitida

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: red gestionada que solo permite salidas aprobadas

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'

Pasos siguientes

Instalación y uso de la CLI (v2)

Share via