Esquema YAML da área de trabalho da CLI (v2)
APLICA-SE A:
Extensão v2 da CLI do Azure (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 baseia-se no esquema JSON para a versão mais recente da extensão da CLI V2 do ML. Esta sintaxe só é garantida para funcionar com a versão mais recente da extensão da CLI V2 do ML. Pode encontrar os esquemas para versões de extensão mais antigas em https://azuremlschemasprod.azureedge.net/.
Sintaxe YAML
| Chave | Tipo | Description | Valores permitidos | Valor predefinido |
|---|---|---|---|---|
$schema |
string | O esquema YAML. Se utilizar a extensão do VS Code do Azure Machine Learning para criar o ficheiro YAML, incluindo $schema na parte superior do ficheiro, poderá invocar as conclusões de esquemas e recursos. |
||
name |
string | Obrigatório. Nome da área de trabalho. | ||
display_name |
string | Nome a apresentar da área de trabalho na IU do estúdio. Pode não ser exclusivo no grupo de recursos. | ||
description |
string | Descrição da área de trabalho. | ||
tags |
objeto | Dicionário de etiquetas para a área de trabalho. | ||
location |
string | A localização da área de trabalho. Se omitido, a predefinição é a localização do grupo de recursos. | ||
resource_group |
string | Obrigatório. O grupo de recursos que contém a área de trabalho. Se o grupo de recursos não existir, será criado um novo. | ||
hbi_workspace |
boolean | Se os dados do cliente têm um elevado impacto comercial (HBI), que contém informações comerciais confidenciais. Para obter mais informações, veja Encriptação de dados inativa. | false |
|
storage_account |
string | O ID de recurso completamente qualificado de uma conta de armazenamento do Azure existente para utilizar como a conta de armazenamento predefinida da área de trabalho. Uma conta de armazenamento com armazenamento premium ou espaço de nomes hierárquico não pode ser utilizada como a conta de armazenamento predefinida. Se for omitido, será criada uma nova conta de armazenamento. | ||
container_registry |
string | O ID de recurso completamente qualificado de um registo de contentor do Azure existente para utilizar como registo de contentor predefinido para a área de trabalho. O Azure Machine Learning utiliza Azure Container Registry (ACR) para gerir imagens de contentor utilizadas para preparação e implementação. Se omitido, será criado um novo registo de contentor. A criação é carregada lentamente, pelo que o registo de contentor é criado da primeira vez que é necessário para uma operação de preparação ou implementação. | ||
key_vault |
string | O ID de recurso completamente qualificado de um cofre de chaves do Azure existente para utilizar como o cofre de chaves predefinido para a área de trabalho. Se for omitido, será criado um novo cofre de chaves. | ||
application_insights |
string | O ID de recurso completamente qualificado de um Azure Application Insights existente para utilizar como as informações de aplicação predefinidas para a área de trabalho. Se omitido, será criado um novo application insights. | ||
customer_managed_key |
objeto | O Azure Machine Learning armazena metadados numa instância do Azure Cosmos DB. Por predefinição, os dados são encriptados inativos com chaves geridas pela Microsoft. Para utilizar a sua própria chave gerida pelo cliente para encriptação, especifique as informações de chave geridas pelo cliente nesta secção. Para obter mais informações, veja Encriptação de dados para o Azure Cosmos DB. | ||
customer_managed_key.key_vault |
string | O ID de recurso completamente qualificado do cofre de chaves que contém a chave gerida pelo cliente. Este cofre de chaves pode ser diferente do cofre de chaves de área de trabalho predefinido especificado em key_vault. |
||
customer_managed_key.key_uri |
string | O URI chave da chave gerida pelo cliente para encriptar dados inativos. O formato URI é https://<keyvault-dns-name>/keys/<key-name>/<key-version>. |
||
image_build_compute |
string | Nome do destino de computação a utilizar para criar imagens do Docker de ambiente quando o registo de contentor está por trás de uma VNet. Para obter mais informações, veja Recursos de área de trabalho seguros por trás de VNets. | ||
public_network_access |
string | Se o acesso ao ponto final público é permitido se a área de trabalho estiver a utilizar Private Link. Para obter mais informações, veja Ativar o acesso público quando estiver atrás de VNets. | enabled, disabled |
disabled |
managed_network |
objeto | Área de Trabalho do Azure Machine Learning isolamento de rede com gerência. Para obter mais informações, veja Área de trabalho isolamento de rede com gerência. |
Observações
O az ml workspace comando pode ser utilizado para gerir áreas de trabalho do Azure Machine Learning.
Exemplos
Os exemplos estão disponíveis nos exemplos do repositório do GitHub. São apresentados vários 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 gerida 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
YAML: ligação privada
$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: elevado impacto comercial
$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 gerida com permitir saída da 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 gerida 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'