Share via

az ml pipeline

  • Reference

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 pipeline command. Learn more about extensions.

Pipeline subgroup commands.

Commands

Name Description Type Status
az ml pipeline clone

Generate yml definition describing the pipeline run, supported only for ModuleStep for now.

 Extension GA
az ml pipeline clone-draft

Create a pipeline draft from an existing pipeline.

 Extension GA
az ml pipeline create

Create a pipeline from a yaml definition.

 Extension GA
az ml pipeline create-draft

Create a pipeline draft from a yml definition.

 Extension GA
az ml pipeline create-schedule

Create a schedule.

 Extension GA
az ml pipeline delete-draft

Delete a pipeline draft.

 Extension GA
az ml pipeline disable

Disable a pipeline from running.

 Extension GA
az ml pipeline disable-schedule

Disable a schedule from running.

 Extension GA
az ml pipeline enable

Enable a pipeline and allow it to run.

 Extension GA
az ml pipeline enable-schedule

Enable a schedule and allow it to run.

 Extension GA
az ml pipeline get

Generate yml definition describing the pipeline.

 Extension GA
az ml pipeline last-pipeline-run

Show last pipeline run for a schedule.

 Extension GA
az ml pipeline list

List all pipelines and respective schedules in the workspace.

 Extension GA
az ml pipeline list-drafts

List pipeline drafts in the workspace.

 Extension GA
az ml pipeline list-steps

List the step runs generated from a pipeline run.

 Extension GA
az ml pipeline pipeline-runs-list

List pipeline runs generated from a schedule.

 Extension GA
az ml pipeline publish-draft

Publish a pipeline draft as a published pipeline.

 Extension GA
az ml pipeline show

Show details of a pipeline and respective schedules.

 Extension GA
az ml pipeline show-draft

Show details of a pipeline draft.

 Extension GA
az ml pipeline show-schedule

Show details of a schedule.

 Extension GA
az ml pipeline submit-draft

Submit a run from the pipeline draft.

 Extension GA
az ml pipeline update-draft

Update a pipeline draft.

 Extension GA
az ml pipeline update-schedule

Update a schedule.

 Extension GA

az ml pipeline clone

Generate yml definition describing the pipeline run, supported only for ModuleStep for now.

az ml pipeline clone --path
                     --pipeline-run-id
                     [--output-file]
                     [--resource-group]
                     [--workspace-name]

Required Parameters

--path -p

File path to save pipeline yaml to.

--pipeline-run-id -i

ID of the PipelineRun to clone (guid).

Optional Parameters

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline clone-draft

Create a pipeline draft from an existing pipeline.

az ml pipeline clone-draft [--experiment-name]
                           [--pipeline-draft-id]
                           [--pipeline-id]
                           [--pipeline-run-id]
                           [--resource-group]
                           [--workspace-name]

Optional Parameters

--experiment-name -e

Experiment name of the specified PipelineRun.

--pipeline-draft-id -i

ID of the PipelineDraft to create PipelineDraft from.

--pipeline-id -p

ID of the PublishedPipeline to create PipelineDraft from.

--pipeline-run-id -r

ID of the PipelineRun to create PipelineDraft from.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline create

Create a pipeline from a yaml definition.

az ml pipeline create --name
                      --pipeline-yaml
                      [--continue]
                      [--description]
                      [--output-file]
                      [--resource-group]
                      [--version]
                      [--workspace-name]

Required Parameters

--name -n

Name to assign to the pipeline.

--pipeline-yaml -y

YAML file which defines a pipeline.

Optional Parameters

--continue -c

Boolean flag to allow a pipeline to continue executing after a step fails.

--description -d

Description text of the pipeline.

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--version -v

Version string of the pipeline.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline create-draft

Create a pipeline draft from a yml definition.

az ml pipeline create-draft --experiment_name
                            --name
                            --pipeline-yaml
                            [--continue]
                            [--description]
                            [--parameters]
                            [--properties]
                            [--resource-group]
                            [--tags]
                            [--workspace-name]

Required Parameters

--experiment_name -e

Experiment name for the pipeline draft.

--name -n

Name to assign to the pipeline draft.

--pipeline-yaml -y

YAML file which defines the pipeline draft.

Optional Parameters

--continue -c

Boolean flag to allow a pipeline to continue executing after a step fails.

--description -d

Description text of the pipeline draft.

--parameters

PipelineParameters for the draft with 'key=value' syntax.

--properties -p

Properties for the draft with 'key=value' syntax.

--resource-group -g

Resource group name.

--tags -t

Tags for the draft with 'key=value' syntax.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline create-schedule

Create a schedule.

az ml pipeline create-schedule --experiment-name
                               --name
                               --pipeline-id
                               [--resource-group]
                               [--schedule-yaml]
                               [--workspace-name]

Required Parameters

--experiment-name -e

Name of experiment.

--name -n

Name of schedule.

--pipeline-id -i

ID of the pipeline to create schedule (guid).

Optional Parameters

--resource-group -g

Resource group name.

--schedule-yaml -y

Schedule YAML input.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline delete-draft

Delete a pipeline draft.

az ml pipeline delete-draft --pipeline-draft-id
                            [--resource-group]
                            [--workspace-name]

Required Parameters

--pipeline-draft-id -i

ID of the PipelineDraft to delete (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline disable

Disable a pipeline from running.

az ml pipeline disable --pipeline-id
                       [--output-file]
                       [--resource-group]
                       [--workspace-name]

Required Parameters

--pipeline-id -i

ID of the pipeline to disable (guid).

Optional Parameters

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline disable-schedule

Disable a schedule from running.

az ml pipeline disable-schedule --schedule-id
                                [--resource-group]
                                [--workspace-name]

Required Parameters

--schedule-id -s

ID of the schedule to show (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline enable

Enable a pipeline and allow it to run.

az ml pipeline enable --pipeline-id
                      [--output-file]
                      [--resource-group]
                      [--workspace-name]

Required Parameters

--pipeline-id -i

ID of the pipeline to enable (guid).

Optional Parameters

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline enable-schedule

Enable a schedule and allow it to run.

az ml pipeline enable-schedule --schedule-id
                               [--resource-group]
                               [--workspace-name]

Required Parameters

--schedule-id -s

ID of the schedule to show (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline get

Generate yml definition describing the pipeline.

az ml pipeline get --path
                   [--pipeline-draft-id]
                   [--pipeline-id]
                   [--resource-group]
                   [--workspace-name]

Required Parameters

--path -p

File path to save Pipeline yaml to.

Optional Parameters

--pipeline-draft-id -d

ID of the PipelineDraft to get (guid).

--pipeline-id -i

ID of the Pipeline to get (guid).

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline last-pipeline-run

Show last pipeline run for a schedule.

az ml pipeline last-pipeline-run --schedule-id
                                 [--resource-group]
                                 [--workspace-name]

Required Parameters

--schedule-id -s

ID of the schedule to show (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline list

List all pipelines and respective schedules in the workspace.

az ml pipeline list [--output-file]
                    [--resource-group]
                    [--workspace-name]

Optional Parameters

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline list-drafts

List pipeline drafts in the workspace.

az ml pipeline list-drafts [--resource-group]
                           [--tags]
                           [--workspace-name]

Optional Parameters

--resource-group -g

Resource group name.

--tags -t

Tags for a draft with 'key=value' syntax.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline list-steps

List the step runs generated from a pipeline run.

az ml pipeline list-steps --run
                          [--output-file]
                          [--resource-group]
                          [--workspace-name]

Required Parameters

--run -r

The runId of an experiment run.

Optional Parameters

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline pipeline-runs-list

List pipeline runs generated from a schedule.

az ml pipeline pipeline-runs-list --schedule-id
                                  [--resource-group]
                                  [--workspace-name]

Required Parameters

--schedule-id -s

ID of the schedule to show (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline publish-draft

Publish a pipeline draft as a published pipeline.

az ml pipeline publish-draft --pipeline-draft-id
                             [--resource-group]
                             [--workspace-name]

Required Parameters

--pipeline-draft-id -i

ID of the PipelineDraft to publish.

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline show

Show details of a pipeline and respective schedules.

az ml pipeline show --pipeline-id
                    [--output-file]
                    [--resource-group]
                    [--workspace-name]

Required Parameters

--pipeline-id -i

ID of the pipeline to show (guid).

Optional Parameters

--output-file -f

File to write output in JSON format.

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline show-draft

Show details of a pipeline draft.

az ml pipeline show-draft --pipeline-draft-id
                          [--resource-group]
                          [--workspace-name]

Required Parameters

--pipeline-draft-id -i

ID of the PipelineDraft to show (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline show-schedule

Show details of a schedule.

az ml pipeline show-schedule --schedule-id
                             [--resource-group]
                             [--workspace-name]

Required Parameters

--schedule-id -s

ID of the schedule to show (guid).

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline submit-draft

Submit a run from the pipeline draft.

az ml pipeline submit-draft --pipeline-draft-id
                            [--resource-group]
                            [--workspace-name]

Required Parameters

--pipeline-draft-id -i

ID of the PipelineDraft to use to submit run.

Optional Parameters

--resource-group -g

Resource group name.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline update-draft

Update a pipeline draft.

az ml pipeline update-draft [--continue]
                            [--description]
                            [--experiment_name]
                            [--name]
                            [--parameters]
                            [--pipeline-draft-id]
                            [--pipeline-yaml]
                            [--resource-group]
                            [--tags]
                            [--workspace-name]

Optional Parameters

--continue -c

Boolean flag to allow a pipeline to continue executing after a step fails.

--description -d

Description text of the pipeline draft.

--experiment_name -e

Experiment name for the pipeline draft.

--name -n

Name to assign to the pipeline draft.

--parameters

PipelineParameters for the draft with 'key=value' syntax.

--pipeline-draft-id -i

ID of the PipelineDraft to update.

--pipeline-yaml -y

YAML file which defines the pipeline draft.

--resource-group -g

Resource group name.

--tags -t

Tags for the draft with 'key=value' syntax.

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az ml pipeline update-schedule

Update a schedule.

az ml pipeline update-schedule --schedule-id
                               [--name]
                               [--resource-group]
                               [--schedule-yaml]
                               [--status]
                               [--workspace-name]

Required Parameters

--schedule-id -s

ID of the schedule to show (guid).

Optional Parameters

--name -n

Name of the schedule to show (guid).

--resource-group -g

Resource group name.

--schedule-yaml -y

Schedule YAML input.

--status -t

Status of the schedule to show (guid).

--workspace-name -w

Workspace name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.