YAML-schema voor CLI-werkruimte (v2)

Artikel
09/01/2024

VAN TOEPASSING OP: Azure CLI ml-extensie v2 (huidige)

Het JSON-bronschema vindt u op https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Notitie

De YAML-syntaxis die in dit document wordt beschreven, is gebaseerd op het JSON-schema voor de nieuwste versie van de ML CLI v2-extensie. Deze syntaxis werkt gegarandeerd alleen met de nieuwste versie van de ML CLI v2-extensie. U vindt de schema's voor oudere extensieversies op https://azuremlschemasprod.azureedge.net/.

YAML-syntaxis

Sleutel	Type	Description	Toegestane waarden	Default value
`$schema`	tekenreeks	Het YAML-schema. Als u de Azure Machine Learning VS Code-extensie gebruikt om het YAML-bestand te ontwerpen, inclusief `$schema` bovenaan het bestand, kunt u schema- en resourcevoltooiingen aanroepen.
`name`	tekenreeks	Vereist. Naam van de werkruimte.
`display_name`	tekenreeks	Weergavenaam van de werkruimte in de gebruikersinterface van studio. Kan niet uniek zijn binnen de resourcegroep.
`description`	tekenreeks	Beschrijving van de werkruimte.
`tags`	object	Woordenlijst met tags voor de werkruimte.
`location`	tekenreeks	De locatie van de werkruimte. Als u dit weglaat, wordt standaard de locatie van de resourcegroep gebruikt.
`resource_group`	tekenreeks	Vereist. De resourcegroep met de werkruimte. Als de resourcegroep niet bestaat, wordt er een nieuwe gemaakt.
`hbi_workspace`	boolean	Of de klantgegevens een hoge impact hebben op het bedrijf (HBI), met gevoelige bedrijfsgegevens. Zie Data Encryption at rest voor meer informatie.		`false`
`storage_account`	tekenreeks	De volledig gekwalificeerde resource-id van een bestaand Azure-opslagaccount dat moet worden gebruikt als het standaardopslagaccount voor de werkruimte. Een opslagaccount met Premium Storage of hiërarchische naamruimte kan niet worden gebruikt als het standaardopslagaccount. Als u dit weglaat, wordt er een nieuw opslagaccount gemaakt.
`container_registry`	tekenreeks	De volledig gekwalificeerde resource-id van een bestaand Azure-containerregister dat moet worden gebruikt als het standaardcontainerregister voor de werkruimte. Azure Machine Learning maakt gebruik van Azure Container Registry (ACR) voor het beheren van containerinstallatiekopieën die worden gebruikt voor training en implementatie. Als u dit weglaat, wordt er een nieuw containerregister gemaakt. Het maken wordt vertraagd geladen, dus het containerregister wordt gemaakt wanneer het voor het eerst nodig is voor een bewerking voor training of implementatie.
`key_vault`	tekenreeks	De volledig gekwalificeerde resource-id van een bestaande Azure-sleutelkluis die moet worden gebruikt als de standaardsleutelkluis voor de werkruimte. Als u dit weglaat, wordt er een nieuwe sleutelkluis gemaakt.
`application_insights`	tekenreeks	De volledig gekwalificeerde resource-id van een bestaande Azure Application Insights die moet worden gebruikt als de standaardtoepassingsinzichten voor de werkruimte. Als u dit weglaat, wordt er een nieuwe Application Insights gemaakt.
`customer_managed_key`	object	Azure Machine Learning slaat metagegevens op in een Azure Cosmos DB-exemplaar. Standaard worden de gegevens in rust versleuteld met door Microsoft beheerde sleutels. Als u uw eigen door de klant beheerde sleutel wilt gebruiken voor versleuteling, geeft u de door de klant beheerde sleutelgegevens op in deze sectie. Zie Gegevensversleuteling voor Azure Cosmos DB voor meer informatie.
`customer_managed_key.key_vault`	tekenreeks	De volledig gekwalificeerde resource-id van de sleutelkluis met de door de klant beheerde sleutel. Deze sleutelkluis kan afwijken van de standaardsleutelkluis van de werkruimte die is opgegeven in `key_vault`.
`customer_managed_key.key_uri`	tekenreeks	De sleutel-URI van de door de klant beheerde sleutel voor het versleutelen van data-at-rest. De URI-indeling is `https://<keyvault-dns-name>/keys/<key-name>/<key-version>`.
`image_build_compute`	tekenreeks	De naam van het rekendoel dat moet worden gebruikt voor het bouwen van Docker-installatiekopieën wanneer het containerregister zich achter een VNet bevindt. Zie Beveiligde werkruimteresources achter VNets voor meer informatie.
`public_network_access`	tekenreeks	Of openbare eindpunttoegang is toegestaan als de werkruimte gebruikmaakt van Private Link. Zie Openbare toegang inschakelen achter VNets voor meer informatie.	`enabled`, `disabled`	`disabled`
`managed_network`	object	Azure Machine Learning Workspace beheerd netwerkisolatie. Zie Werkruimte-beheerd netwerkisolatie voor meer informatie.

Opmerkingen

De az ml workspace opdracht kan worden gebruikt voor het beheren van Azure Machine Learning-werkruimten.

Voorbeelden

Voorbeelden zijn beschikbaar in de GitHub-voorbeeldenopslagplaats. Hieronder ziet u een aantal.

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: met bestaande resources

$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: door de klant beheerde sleutel

$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: hoge bedrijfsimpact

$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: beheerd netwerk met uitgaand internet toestaan

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: beheerd netwerk met alleen goedgekeurde uitgaande verbindingen toestaan

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'

Volgende stappen

De CLI (v2) installeren en gebruiken

Delen via