CLI-arbetsytans YAML-schema (v2)

Artikel
11/23/2024

GÄLLER FÖR: Azure CLI ml-tillägget v2 (aktuellt)

JSON-källschemat finns på https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Kommentar

YAML-syntaxen som beskrivs i det här dokumentet baseras på JSON-schemat för den senaste versionen av ML CLI v2-tillägget. Den här syntaxen är garanterad att endast fungera med den senaste versionen av ML CLI v2-tillägget. Du hittar scheman för äldre tilläggsversioner på https://azuremlschemasprod.azureedge.net/.

YAML-syntax

Nyckel	Typ	Beskrivning	Tillåtna värden	Standardvärde
`$schema`	sträng	YAML-schemat. Om du använder Azure Machine Learning VS Code-tillägget för att skapa YAML-filen, inklusive `$schema` längst upp i filen, kan du anropa schema- och resursavslutningar.
`name`	sträng	Obligatoriskt. Namnet på arbetsytan.
`display_name`	sträng	Visningsnamn för arbetsytan i studiogränssnittet. Kan vara icke-unikt i resursgruppen.
`description`	sträng	Beskrivning av arbetsytan.
`tags`	objekt	Ordlista med taggar för arbetsytan.
`location`	sträng	Arbetsytans plats. Om det utelämnas är standardplatsen för resursgruppen.
`resource_group`	sträng	Obligatoriskt. Resursgruppen som innehåller arbetsytan. Om resursgruppen inte finns skapas en ny.
`hbi_workspace`	boolean	Om kunddata har stor inverkan på verksamheten (HBI) som innehåller känslig affärsinformation. Mer information finns i Datakryptering i vila.		`false`
`storage_account`	sträng	Det fullständigt kvalificerade resurs-ID för ett befintligt Azure-lagringskonto som ska användas som standardlagringskonto för arbetsytan. Ett lagringskonto med premiumlagring eller hierarkiskt namnområde kan inte användas som standardlagringskonto. Om det utelämnas skapas ett nytt lagringskonto.
`container_registry`	sträng	Det fullständigt kvalificerade resurs-ID:t för ett befintligt Azure-containerregister som ska användas som standardcontainerregister för arbetsytan. Azure Machine Learning använder Azure Container Registry (ACR) för att hantera containeravbildningar som används för träning och distribution. Om det utelämnas skapas ett nytt containerregister. Det går inte att läsa in skapande, så containerregistret skapas första gången det behövs för en åtgärd för träning eller distribution.
`key_vault`	sträng	Det fullständigt kvalificerade resurs-ID:t för ett befintligt Azure-nyckelvalv som ska användas som standardnyckelvalv för arbetsytan. Om det utelämnas skapas ett nytt nyckelvalv.
`application_insights`	sträng	Det fullständigt kvalificerade resurs-ID:t för en befintlig Azure Application Insights som ska användas som standardinsikter för program för arbetsytan. Om det utelämnas skapas en ny application insights.
`customer_managed_key`	objekt	Azure Machine Learning lagrar metadata i en Azure Cosmos DB-instans. Som standard krypteras data i vila med Microsoft-hanterade nycklar. Om du vill använda din egen kundhanterade nyckel för kryptering anger du den kundhanterade nyckelinformationen i det här avsnittet. Mer information finns i Datakryptering för Azure Cosmos DB.
`customer_managed_key.key_vault`	sträng	Det fullständigt kvalificerade resurs-ID:t för nyckelvalvet som innehåller den kundhanterade nyckeln. Det här nyckelvalvet kan skilja sig från standardnyckelvalvet för arbetsytan som anges i `key_vault`.
`customer_managed_key.key_uri`	sträng	Nyckel-URI för den kundhanterade nyckeln för att kryptera vilande data. URI-formatet är `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`.
`image_build_compute`	sträng	Namnet på beräkningsmålet som ska användas för att skapa Docker-avbildningar i miljön när containerregistret ligger bakom ett virtuellt nätverk. Mer information finns i Skydda arbetsyteresurser bakom virtuella nätverk.
`public_network_access`	sträng	Om offentlig slutpunktsåtkomst tillåts om arbetsytan ska använda Private Link. Mer information finns i Aktivera offentlig åtkomst bakom virtuella nätverk.	`enabled`, `disabled`	`disabled`
`managed_network`	objekt	Azure Machine Learning-arbetsyta hanterad nätverksisolering. Mer information finns i Hanterad nätverksisolering för arbetsyta.

Kommentarer

Kommandot az ml workspace kan användas för att hantera Azure Machine Learning-arbetsytor.

Exempel

Exempel är tillgängliga i GitHub-exempellagringsplatsen. Flera visas nedan.

YAML: basic

$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: med befintliga resurser

$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: kundhanterad nyckel

$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: privat länk

$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: hög affärspåverkan

$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: hanterat nätverk med tillåten utgående 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: hanterat nätverk med tillåt endast godkänd utgående trafik

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'

Nästa steg

Installera och använda CLI (v2)

Dela via