Share via

az batchai experiment

  • Deprecated
  • Reference

This command group is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Commands to manage experiments.

Commands

Name Description Type Status
az batchai experiment create

Create an experiment.

 Core Deprecated
az batchai experiment delete

Delete an experiment.

 Core Deprecated
az batchai experiment list

List experiments.

 Core Deprecated
az batchai experiment show

Show information about an experiment.

 Core Deprecated

az batchai experiment create

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Create an experiment.

az batchai experiment create --name
                             --resource-group
                             --workspace

Examples

Create an experiment.

az batchai experiment create -g MyResourceGroup -w MyWorkspace -n MyExperiment

Required Parameters

--name -n

Name of experiment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace -w

Name of workspace.

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 batchai experiment delete

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Delete an experiment.

az batchai experiment delete [--ids]
                             [--name]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]
                             [--workspace]
                             [--yes]

Examples

Delete an experiment. All running jobs will be terminated.

az batchai experiment delete -g MyResourceGroup -w MyWorkspace -n MyExperiment

Delete an experiment without asking for confirmation (for non-interactive scenarios).

az batchai experiment delete -g MyResourceGroup -w MyWorkspace -n MyExperiment -y

Request an experiment deletion without waiting for job to be deleted.

az batchai experiment delete -g MyResourceGroup -w MyWorkspace -n MyExperiment --no-wait

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of experiment.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--workspace -w

Name of workspace.

--yes -y

Do not prompt for confirmation.

Default value: False
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 batchai experiment list

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

List experiments.

az batchai experiment list --resource-group
                           --workspace

Examples

List experiments.

az batchai experiment list -g MyResourceGroup -w MyWorkspace -o table

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace -w

Name of workspace.

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 batchai experiment show

Edit
Deprecated

This command is implicitly deprecated because command group 'batchai' is deprecated and will be removed in a future release.

Show information about an experiment.

az batchai experiment show [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]
                           [--workspace]

Examples

Show information about an experiment.

az batchai experiment show -g MyResourceGroup -w MyWorkspace -n MyExperiment -o table

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of experiment.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

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

--workspace -w

Name of workspace.

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.