Partilhar via

Esquema YAML do espaço de trabalho CLI (v2)

  • Artigo

APLICA-SE A: Azure CLI ml extension v2 (atual)

O esquema JSON de origem pode ser encontrado em https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Nota

A sintaxe YAML detalhada neste documento é baseada no esquema JSON para a versão mais recente da extensão ML CLI v2. Esta sintaxe é garantida apenas para funcionar com a versão mais recente da extensão ML CLI v2. Você pode encontrar os esquemas para versões de extensão mais antigas em https://azuremlschemasprod.azureedge.net/.

Sintaxe YAML

Chave Tipo Description Valores permitidos Default value
$schema string O esquema YAML. Se você usar a extensão VS Code do Aprendizado de Máquina do Azure para criar o arquivo YAML, inclusive $schema na parte superior do arquivo permitirá que você invoque o esquema e as completações de recursos.
name string Obrigatório. Nome do espaço de trabalho.
display_name string Nome para exibição do espaço de trabalho na interface do usuário do estúdio. Pode não ser exclusivo dentro do grupo de recursos.
description string Descrição do espaço de trabalho.
tags objeto Dicionário de tags para o espaço de trabalho.
location string A localização do espaço de trabalho. Se omitido, o padrão será o local do grupo de recursos.
resource_group string Obrigatório. O grupo de recursos que contém o espaço de trabalho. Se o grupo de recursos não existir, um novo será criado.
hbi_workspace boolean Se os dados do cliente são de alto impacto nos negócios (HBI), contendo informações comerciais confidenciais. Para obter mais informações, consulte Criptografia de dados em repouso. false
storage_account string A ID de recurso totalmente qualificada de uma conta de armazenamento do Azure existente para usar como a conta de armazenamento padrão para o espaço de trabalho. Uma conta de armazenamento com armazenamento premium ou namespace hierárquico não pode ser usada como a conta de armazenamento padrão. Se omitida, uma nova conta de armazenamento será criada.
container_registry string A ID de recurso totalmente qualificada de um registro de contêiner do Azure existente para usar como o registro de contêiner padrão para o espaço de trabalho. O Azure Machine Learning usa o Azure Container Registry (ACR) para gerenciar imagens de contêiner usadas para treinamento e implantação. Se omitido, um novo registro de contêiner será criado. A criação é carregada com preguiça, de modo que o registro de contêiner é criado na primeira vez que é necessário para uma operação para treinamento ou implantação.
key_vault string A ID de recurso totalmente qualificada de um cofre de chaves do Azure existente para usar como o cofre de chaves padrão para o espaço de trabalho. Se omitido, um novo cofre de chaves será criado.
application_insights string A ID de recurso totalmente qualificada de um aplicativo existente do Azure insights para usar como os insights de aplicativo padrão para o espaço de trabalho. Se omitido, um novo aplicativo insights será criado.
customer_managed_key objeto O Azure Machine Learning armazena metadados em uma instância do Azure Cosmos DB. Por padrão, os dados são criptografados em repouso com chaves gerenciadas pela Microsoft. Para usar sua própria chave gerenciada pelo cliente para criptografia, especifique as informações de chave gerenciadas pelo cliente nesta seção. Para obter mais informações, consulte Criptografia de dados para o Azure Cosmos DB.
customer_managed_key.key_vault string O ID de recurso totalmente qualificado do cofre de chaves que contém a chave gerenciada pelo cliente. Esse cofre de chaves pode ser diferente do cofre de chaves do espaço de trabalho padrão especificado em key_vault.
customer_managed_key.key_uri string O URI de chave da chave gerenciada pelo cliente para criptografar dados em repouso. O formato URI é https://<keyvault-dns-name>/keys/<key-name>/<key-version>.
image_build_compute string Nome do destino de computação a ser usado para criar imagens do Docker do ambiente quando o registro do contêiner estiver atrás de uma VNet. Para obter mais informações, consulte Recursos de espaço de trabalho seguro por trás de redes virtuais.
public_network_access string Se o acesso ao ponto de extremidade público é permitido se o espaço de trabalho estiver usando o Link Privado. Para obter mais informações, consulte Habilitar acesso público quando estiver atrás de redes virtuais. enabled, disabled disabled
managed_network objeto Isolamento de rede gerenciado do Espaço de Trabalho do Azure Machine Learning. Para obter mais informações, consulte Isolamento de rede gerenciado pelo espaço de trabalho.

Observações

O az ml workspace comando pode ser usado para gerenciar espaços de trabalho do Azure Machine Learning.

Exemplos

Exemplos estão disponíveis no repositório GitHub de exemplos. Vários são mostrados abaixo.

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: com 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: chave gerenciada pelo 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

$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 nos negócios

$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: rede gerenciada com permissão de saída de 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: rede gerenciada com permissão apenas de saída aprovada

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'

Próximos passos