Схема YAML рабочей области CLI (версия 2)

Статья
07/04/2023

Область применения:Расширение ML для Azure CLI версии 2 (текущая версия)

Исходную схему JSON можно найти по адресу https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Примечание

Синтаксис YAML, описанный в этом документе, основан на схеме JSON для последней версии расширения ML CLI (версия 2). Этот синтаксис гарантированно работает только с последней версией расширения ML CLI (версия 2). Схемы для старых версий расширений можно найти по адресу https://azuremlschemasprod.azureedge.net/.

Синтаксис YAML

Ключ	Тип	Описание	Допустимые значения	Значение по умолчанию
`$schema`	строка	Схема YAML. При создании файла YAML с помощью расширения VS Code службы машинного обучения Azure вы можете добавить `$schema` в верхней части файла, чтобы вызвать завершение схемы и ресурсов.
`name`	строка	Обязательный элемент. Имя рабочей области.
`display_name`	строка	Отображаемое имя рабочей области в пользовательском интерфейсе Studio. Может быть неуникальным в пределах группы ресурсов.
`description`	строка	Описание рабочей области.
`tags`	объект	Словарь тегов для рабочей области.
`location`	строка	Расположение рабочей области. Если этот параметр опущен, по умолчанию используется расположение группы ресурсов.
`resource_group`	строка	Обязательный элемент. Группа ресурсов, содержащая рабочую область. Если группа ресурсов не существует, будет создана новая группа ресурсов.
`hbi_workspace`	Логическое	Имеют ли данные клиента высокую степень влияния на бизнес (HBI) и содержат ли конфиденциальную коммерческую информацию. Дополнительные сведения см. в статье Шифрование неактивных данных.		`false`
`storage_account`	строка	Полный идентификатор ресурса существующей учетной записи хранения Azure для использования в качестве учетной записи хранения по умолчанию для рабочей области. Учетную запись хранения хранилища класса Premium или иерархическое пространство имен нельзя использовать в качестве учетной записи хранения по умолчанию. Если этот параметр опущен, создается новая учетная запись хранения.
`container_registry`	строка	Полный идентификатор ресурса существующего реестра контейнеров Azure для использования в качестве реестра контейнеров по умолчанию для рабочей области. Машинное обучение Azure использует Реестр контейнеров Azure (ACR) для управления образами контейнеров, используемыми для обучения и развертывания. Если этот параметр опущен, создается новый реестр контейнеров. Отложенная загрузка для создания реестра контейнеров, когда он требуется для обучения или развертывания.
`key_vault`	строка	Полный идентификатор ресурса существующего хранилища ключей Azure для использования в качестве хранилища ключей по умолчанию для рабочей области. Если этот параметр опущен, создается новое хранилище ключей.
`application_insights`	строка	Полный идентификатор ресурса существующего приложения Azure Application Insights для использования в качестве приложения Application Insights по умолчанию для рабочей области. Если этот параметр опущен, создается новое приложение Application Insights.
`customer_managed_key`	объект	Машинное обучение Azure хранит метаданные в экземпляре Azure Cosmos DB. По умолчанию неактивные данные шифруются с помощью ключей, управляемых корпорацией Майкрософт. Чтобы использовать для шифрования собственный ключ, управляемый клиентом, необходимо указать в этом разделе сведения об этом ключе, управляемом клиентом. Дополнительные сведения см. в статье Шифрование данных для базы данных Azure Cosmos.
`customer_managed_key.key_vault`	строка	Полный идентификатор ресурса хранилища ключей, содержащего ключ, управляемый клиентом. Это хранилище ключей может отличаться от хранилища ключей рабочей области по умолчанию, указанного в `key_vault`.
`customer_managed_key.key_uri`	строка	Универсальный код ресурса (URI) ключа, управляемого клиентом, для шифрования неактивных данных. Формат URI: `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`.
`image_build_compute`	строка	Имя целевого объекта вычислений, используемого для создания образов Docker в среде, в которой реестр контейнеров находится за пределами виртуальной сети. Дополнительные сведения см. в статье Защита ресурсов рабочей области за пределами виртуальных сетей.
`public_network_access`	строка	Разрешен ли доступ к частной конечной точке, если рабочая область будет использовать приватный канал. Дополнительные сведения см. в статье Включение общего доступа за пределами виртуальных сетей.	`enabled`, `disabled`	`disabled`
`managed_network`	object	Изоляция управляемой сети рабочей области Машинного обучения Azure. Дополнительные сведения см. в разделе Изоляция управляемой сети рабочей области.

Remarks

Команду az ml workspace можно использовать для управления рабочими областями Машинного обучения Azure.

Примеры

Примеры доступны в репозитории примеров GitHub. Ниже показаны некоторые из них.

YAML: базовый

$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: с существующими ресурсами

$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: ключ, управляемый клиентом

$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: приватный канал

$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: высокая степень влияния на бизнес

$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: управляемая сеть с разрешением исходящего трафика через Интернет

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: управляемая сеть с разрешенным только утвержденным исходящим трафиком

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'

Дальнейшие действия

Установка и использование интерфейса командной строки (версия 2)