CLI-Arbeitsbereich (v2): YAML-Schema

Artikel
09/01/2024

GILT FÜR Azure CLI-ML-Erweiterung v2 (aktuell)

Das JSON-Quellschema finden Sie unter https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Hinweis

Die in diesem Dokument beschriebene YAML-Syntax basiert auf dem JSON-Schema für die neueste Version der ML CLI v2-Erweiterung. Die Funktion dieser Syntax wird nur mit der neuesten Version der ML CLI v2-Erweiterung garantiert. Die Schemas für ältere Erweiterungsversionen finden Sie unter https://azuremlschemasprod.azureedge.net/.

YAML-Syntax

Schlüssel	type	BESCHREIBUNG	Zulässige Werte	Standardwert
`$schema`	Zeichenfolge	Das YAML-Schema. Wenn Sie die VS Code-Erweiterung für Azure Machine Learning zum Erstellen einer YAML-Datei verwenden, können Sie durch das Einfügen von `$schema` am Anfang der Datei Schema- und Ressourcenvervollständigungen aufrufen.
`name`	Zeichenfolge	Erforderlich. Name des Arbeitsbereichs
`display_name`	Zeichenfolge	Anzeigename des Arbeitsbereichs auf der Studio-Benutzeroberfläche. Kann innerhalb der Ressourcengruppe uneindeutig sein.
`description`	Zeichenfolge	Beschreibung des Arbeitsbereichs
`tags`	Objekt (object)	Wörterbuch der Tags für den Arbeitsbereich
`location`	Zeichenfolge	Standort des Arbeitsbereichs. Wenn keine Angabe erfolgt, wird standardmäßig der Standort der Ressourcengruppe verwendet.
`resource_group`	Zeichenfolge	Erforderlich. Die Ressourcengruppe mit dem Arbeitsbereich. Wenn die Ressourcengruppe nicht vorhanden ist, wird eine neue erstellt.
`hbi_workspace`	boolean	Gibt an, ob die Kundendaten erhebliche Geschäftsauswirkungen (High Business Impact, HBI) haben und vertrauliche Geschäftsinformationen enthalten. Weitere Informationen finden Sie unter Datenverschlüsselung ruhender Daten.		`false`
`storage_account`	Zeichenfolge	Die vollqualifizierte Ressourcen-ID eines vorhandenen Azure Storage-Kontos, das als Standardspeicherkonto für den Arbeitsbereich verwendet werden soll. Ein Speicherkonto mit Storage Premium oder hierarchischem Namespace kann nicht als Standardspeicherkonto verwendet werden. Wenn keine Angabe erfolgt, wird ein neues Speicherkonto erstellt.
`container_registry`	Zeichenfolge	Die vollqualifizierte Ressourcen-ID einer vorhandenen Azure-Containerregistrierung, die als Standardcontainerregistrierung für den Arbeitsbereich verwendet werden soll. Azure Machine Learning verwendet Azure Container Registry (ACR) zum Verwalten von Containerimages, die für Training und Bereitstellung verwendet werden. Wenn keine Angabe erfolgt, wird eine neue Containerregistrierung erstellt. Da die Erstellung verzögert geladen wird, wird die Containerregistrierung erst erstellt, wenn sie zum ersten Mal für einen Trainings- oder Bereitstellungsvorgang benötigt wird.
`key_vault`	Zeichenfolge	Die vollqualifizierte Ressourcen-ID eines vorhandenen Azure-Schlüsseltresors, der als Standardschlüsseltresor für den Arbeitsbereich verwendet werden soll. Wenn keine Angabe erfolgt, wird ein neuer Schlüsseltresor erstellt.
`application_insights`	Zeichenfolge	Die vollqualifizierte Ressourcen-ID einer vorhandenen Azure Application Insights-Instanz, die als Standardinstanz für den Arbeitsbereich verwendet werden soll. Wenn keine Angabe erfolgt, wird eine neue Application Insights-Instanz erstellt.
`customer_managed_key`	Objekt (object)	Azure Machine Learning speichert Metadaten in einer Azure Cosmos DB-Instanz. Standardmäßig werden ruhende Daten mit von Microsoft verwalteten Schlüsseln verschlüsselt. Wenn Sie Ihren eigenen kundenseitig verwalteten Schlüssel für die Verschlüsselung verwenden möchten, geben Sie in diesem Abschnitt die Informationen zum kundenseitig verwalteten Schlüssel an. Weitere Informationen finden Sie unter Datenverschlüsselung für Azure Cosmos DB.
`customer_managed_key.key_vault`	Zeichenfolge	Die vollqualifizierte Ressourcen-ID des Schlüsseltresors mit dem kundenseitig verwalteten Schlüssel. Dieser Schlüsseltresor kann sich von dem in `key_vault` angegebenen Standardschlüsseltresor für den Arbeitsbereich unterscheiden.
`customer_managed_key.key_uri`	Zeichenfolge	Der Schlüssel-URI des kundenseitig verwalteten Schlüssels zum Verschlüsseln ruhender Daten. Das URI-Format lautet `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`.
`image_build_compute`	Zeichenfolge	Der Name des Computeziels, das zum Erstellen von Docker-Umgebungsimages verwendet werden soll, wenn sich die Containerregistrierung hinter einem VNet befindet. Weitere Informationen finden Sie unter Schützen von Arbeitsbereichsressourcen hinter VNets.
`public_network_access`	Zeichenfolge	Gibt an, ob der Zugriff auf öffentliche Endpunkte zulässig ist, wenn der Arbeitsbereich Private Link verwendet. Weitere Informationen finden Sie unter Aktivieren des öffentlichen Zugriffs in VNets.	`enabled`, `disabled`	`disabled`
`managed_network`	Objekt (object)	Vom Azure Machine Learning-Arbeitsbereich verwaltete Netzwerkisolation. Weitere Informationen finden Sie unter Verwaltete Netzwerkisolation auf Arbeitsbereichsebene (Vorschau).

Hinweise

Mit dem Befehl az ml workspace können Sie Azure Machine Learning-Arbeitsbereiche verwalten.

Beispiele

Beispiele finden Sie im GitHub-Beispielrepository. Im Folgenden sind mehrere aufgeführt.

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: mit vorhandenen Ressourcen

$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: kundenseitig verwalteter Schlüssel

$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: Private Link

$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: erhebliche Geschäftsauswirkungen

$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: Verwaltetes Netzwerk mit ausgehendem Internet zulassen

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: Verwaltetes Netzwerk mit nur genehmigtem ausgehendem Internet zulassen

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ächste Schritte

Installieren und Verwenden der CLI (V2)

Freigeben über