az ml environment

Commands to manage environments.

Commands

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

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--overwrite

Overwrite any existing destination folder.

--path

Path to a root directory for run configuration files.

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.

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

default value: .
--resource-group -g

Resource group name.

--subscription-id

Specifies the subscription Id.

--workspace-name -w

Workspace name.

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

--output-metadata-file -t

Provide an optional output file location for structured object output.

--path

Path to a root directory for run configuration files.

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.