Condividi tramite

Schema YAML dell'area di lavoro dell'interfaccia della riga di comando (v2)

  • Articolo

SI APPLICA A: estensione ML dell'interfaccia della riga di comando di Azure v2 (corrente)

Lo schema JSON di origine è disponibile in https://azuremlschemas.azureedge.net/latest/workspace.schema.json.

Nota

La sintassi YAML descritta in dettaglio in questo documento si basa sullo schema JSON per la versione più recente dell'estensione dell'interfaccia della riga di comando di Machine Learning v2. Il funzionamento di questa sintassi è garantito solo con la versione più recente dell'estensione dell'interfaccia della riga di comando di Machine Learning v2. È possibile trovare gli schemi per le versioni di estensione precedenti in https://azuremlschemasprod.azureedge.net/.

Sintassi YAML

Chiave Type Descrizione Valori consentiti Valore predefinito
$schema string Schema YAML. Se si usa l'estensione Azure Machine Learning per Visual Studio Code per creare il file YAML, l'inclusione di $schema nella parte superiore del file consente di richiamare i completamenti dello schema e delle risorse.
name string Obbligatorio. Nome dell'area di lavoro.
display_name string Nome visualizzato dell'area di lavoro nell'interfaccia utente di Studio. Può essere non univoco all'interno del gruppo di risorse.
description string Descrizione dell'area di lavoro.
tags oggetto Dizionario dei tag per l'area di lavoro.
location string Posizione dell'area di lavoro. Se omesso, per impostazione predefinita viene impostato il percorso del gruppo di risorse.
resource_group string Obbligatorio. Gruppo di risorse contenente l'area di lavoro. Se il gruppo di risorse non esiste, ne verrà creato uno nuovo.
hbi_workspace boolean Indica se i dati dei clienti hanno un impatto aziendale elevato (HBI), contenenti informazioni aziendali riservate. Per altre informazioni, vedere Crittografia dei dati inattivi. false
storage_account string ID risorsa completo di un account di archiviazione di Azure esistente da usare come account di archiviazione predefinito per l'area di lavoro. Un account di archiviazione con archiviazione Premium o spazio dei nomi gerarchico non può essere usato come account di archiviazione predefinito. Se omesso, verrà creato un nuovo account di archiviazione.
container_registry string ID risorsa completo di un registro Azure Container esistente da usare come registro contenitori predefinito per l'area di lavoro. Azure Machine Learning usa Registro Azure Container (ACR) per gestire le immagini del contenitore usate per il training e la distribuzione. Se omesso, verrà creato un nuovo registro contenitori. La creazione viene caricata in modo differito, quindi il registro contenitori viene creato la prima volta che è necessario per un'operazione per il training o la distribuzione.
key_vault string ID risorsa completo di un insieme di credenziali delle chiavi di Azure esistente da usare come insieme di credenziali delle chiavi predefinito per l'area di lavoro. Se omesso, verrà creato un nuovo insieme di credenziali delle chiavi.
application_insights string ID risorsa completo di un'applicazione di Azure esistente da usare come application insights predefinito per l'area di lavoro. Se omesso, verrà creato un nuovo application insights.
customer_managed_key oggetto Azure Machine Learning archivia i metadati in un'istanza di Azure Cosmos DB. Per impostazione predefinita, i dati vengono crittografati inattivi con chiavi gestite da Microsoft. Per usare la propria chiave gestita dal cliente per la crittografia, specificare le informazioni sulla chiave gestita dal cliente in questa sezione. Per altre informazioni, vedere Crittografia dei dati per Azure Cosmos DB.
customer_managed_key.key_vault string ID risorsa completo dell'insieme di credenziali delle chiavi contenente la chiave gestita dal cliente. Questo insieme di credenziali delle chiavi può essere diverso dall'insieme di credenziali delle chiavi dell'area di lavoro predefinito specificato in key_vault.
customer_managed_key.key_uri string URI della chiave gestita dal cliente per crittografare i dati inattivi. Il formato URI è https://<keyvault-dns-name>/keys/<key-name>/<key-version>.
image_build_compute string Nome della destinazione di calcolo da usare per la compilazione di immagini Docker dell'ambiente quando il registro contenitori si trova dietro una rete virtuale. Per altre informazioni, vedere Proteggere le risorse dell'area di lavoro dietro le reti virtuali.
public_network_access string Indica se l'accesso all'endpoint pubblico è consentito se l'area di lavoro usa collegamento privato. Per altre informazioni, vedere Abilitare l'accesso pubblico in caso di reti virtuali. enabled, disabled disabled
managed_network oggetto Isolamento network gestito dell'area di lavoro di Azure Machine Learning. Per altre informazioni vedere Isolamento rete gestito dall'area di lavoro.

Osservazioni:

Il az ml workspace comando può essere usato per la gestione delle aree di lavoro di Azure Machine Learning.

Esempi

Gli esempi sono disponibili nel repository GitHub di esempi. Di seguito sono riportati alcuni esempi.

YAML: di base

$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: con risorse esistenti

$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: chiave gestita dal 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: impatto aziendale elevato

$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: rete gestita con consenti internet in uscita

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: rete gestita con consenti solo l'approvazione in uscita

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'

Passaggi successivi