Share via

az ml dataset

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

Commands for managing datasets in Azure Machine Learning Workspace.

Commands

Name Description Type Status
az ml dataset archive

Archive an active or deprecated dataset.

 Extension GA
az ml dataset deprecate

Deprecate an active dataset in a workspace by another dataset.

 Extension GA
az ml dataset list

List all datasets in the workspace.

 Extension GA
az ml dataset reactivate

Reactivate an archived or deprecated dataset.

 Extension GA
az ml dataset register

Register a new dataset from the specified file.

 Extension GA
az ml dataset show

Get details of a dataset by its id or registration name.

 Extension GA
az ml dataset unregister

Unregister all versions under the specified registration name.

 Extension GA

az ml dataset archive

Archive an active or deprecated dataset.

az ml dataset archive [--id]
                      [--name]
                      [--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.

--id -i

Dataset ID (guid).

--name -n

Registration name of the dataset.

--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 dataset deprecate

Deprecate an active dataset in a workspace by another dataset.

az ml dataset deprecate --deprecate-by-id
                        [--id]
                        [--name]
                        [--output-metadata-file]
                        [--path]
                        [--resource-group]
                        [--subscription-id]
                        [--workspace-name]

Required Parameters

--deprecate-by-id -d

Dataset ID (guid) which is the intended replacement for this Dataset.

Optional Parameters

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

--id -i

Dataset ID (guid).

--name -n

Registration name of the dataset.

--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 dataset list

List all datasets in the workspace.

az ml dataset 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 dataset reactivate

Reactivate an archived or deprecated dataset.

az ml dataset reactivate [--id]
                         [--name]
                         [--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.

--id -i

Dataset ID (guid).

--name -n

Registration name of the dataset.

--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 dataset register

Register a new dataset from the specified file.

az ml dataset register [--file]
                       [--output-metadata-file]
                       [--path]
                       [--resource-group]
                       [--show-template]
                       [--skip-validation]
                       [--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.

--file -f

Specification file for dataset.

--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.

--show-template

Show template of dataset specification file.

Property Value
Default value: False
--skip-validation

Skip validation that ensures data can be loaded from the dataset before registration.

Property Value
Default value: False
--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 dataset show

Get details of a dataset by its id or registration name.

az ml dataset show [--id]
                   [--name]
                   [--output-metadata-file]
                   [--path]
                   [--resource-group]
                   [--subscription-id]
                   [--version]
                   [--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.

--id -i

ID of the dataset saved to workspace.

--name -n

Registration name of the dataset.

--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

Registration version of the dataset.

Property Value
Default value: latest
--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 dataset unregister

Unregister all versions under the specified registration name.

az ml dataset unregister [--name]
                         [--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.

--name -n

Registration name of the dataset.

--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