Share via

az batchai workspace

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

Commands

Name Description Type Status
az batchai workspace create

Create a workspace.

 Core Deprecated
az batchai workspace delete

Delete a workspace.

 Core Deprecated
az batchai workspace list

List workspaces.

 Core Deprecated
az batchai workspace show

Show information about a workspace.

 Core Deprecated

az batchai workspace create

Edit
Deprecated

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

Create a workspace.

az batchai workspace create --resource-group
                            --workspace
                            [--location]

Examples

Create a workspace in East US region.

az batchai workspace create -g MyResourceGroup -n MyWorkspace -l eastus

Required Parameters

--resource-group -g

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

--workspace -n

Name of workspace.

Optional Parameters

--location -l

Location of the workspace. If omitted, the location of the resource group will be used.

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

Edit
Deprecated

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

Delete a workspace.

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

Examples

Delete a workspace.

az batchai workspace delete -g MyResourceGroup -n MyWorkspace

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.

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

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

Edit
Deprecated

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

List workspaces.

az batchai workspace list [--resource-group]

Examples

List all workspaces under the current subscription.

az batchai workspace list -o table

List workspaces in the given resource group.

az batchai workspace list -g MyResourceGroup -o table

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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 batchai workspace 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 a workspace.

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

Examples

Show information about a workspace.

az batchai workspace show -g MyResourceGroup -n MyWorkspace -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.

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

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.