az ml environment

Note

This reference is part of the azure-cli-ml extension for the Azure CLI (version 2.0.28 or higher). The extension will automatically install the first time you run an az ml environment command. Learn more about extensions.

Commands to manage environments.

Commands

Name	Description	Type	Status
az ml environment download	Download an environment definition to a specified directory.	Extension	GA
az ml environment list	List environments in a workspace.	Extension	GA
az ml environment register	Register an environment definition from a specified directory.	Extension	GA
az ml environment scaffold	Scaffold the files for a default environment definition in the specified directory.	Extension	GA
az ml environment show	Show an environment by name and optionally version.	Extension	GA

az ml environment download

Download an environment definition to a specified directory.

az ml environment download --directory
                           --name
                           [--output-metadata-file]
                           [--overwrite]
                           [--path]
                           [--resource-group]
                           [--subscription-id]
                           [--version]
                           [--workspace-name]

Required Parameters

--directory -d

Directory for the environment.

--name -n

Name of the environment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--overwrite

Overwrite any existing destination folder.

Property	Value
Default value:	False

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--version -v

Version of the environment.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ml environment list

List environments in a workspace.

az ml environment list [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ml environment register

Register an environment definition from a specified directory.

az ml environment register --directory
                           [--output-metadata-file]
                           [--path]
                           [--resource-group]
                           [--subscription-id]
                           [--workspace-name]

Required Parameters

--directory -d

Directory for the environment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ml environment scaffold

Scaffold the files for a default environment definition in the specified directory.

az ml environment scaffold --directory
                           --name
                           [--output-metadata-file]
                           [--path]
                           [--resource-group]
                           [--subscription-id]
                           [--workspace-name]

Required Parameters

--directory -d

Directory for the environment.

--name -n

Name of the environment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az ml environment show

Show an environment by name and optionally version.

az ml environment show --name
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--subscription-id]
                       [--version]
                       [--workspace-name]

Required Parameters

--name -n

Name of the environment.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

Property	Value
Default value:	.

--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--version -v

Version of the environment.

--workspace-name -w

Workspace name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False