az quantum workspace

  • Preview
  • Reference

Note

This reference is part of the quantum extension for the Azure CLI (version 2.41.0 or higher). The extension will automatically install the first time you run an az quantum workspace command. Learn more about extensions.

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Quantum workspaces.

Commands

Name Description Type Status
az quantum workspace clear

Clear the default Azure Quantum workspace.

 Extension Preview
az quantum workspace create

Create a new Azure Quantum workspace.

 Extension Preview
az quantum workspace delete

Delete the given (or current) Azure Quantum workspace.

 Extension Preview
az quantum workspace keys

Manage Azure Quantum Workspace api keys.

 Extension Preview
az quantum workspace keys list

List api keys for the given (or current) Azure Quantum workspace.

 Extension Preview
az quantum workspace keys regenerate

Regenerate api key for the given (or current) Azure Quantum workspace.

 Extension Preview
az quantum workspace list

Get the list of Azure Quantum workspaces available.

 Extension Preview
az quantum workspace quotas

List the quotas for the given (or current) Azure Quantum workspace.

 Extension Preview
az quantum workspace set

Select a default Azure Quantum workspace for future commands.

 Extension Preview
az quantum workspace show

Get the details of the given (or current) Azure Quantum workspace.

 Extension Preview
az quantum workspace update

Update the given (or current) Azure Quantum workspace.

 Extension Preview

az quantum workspace clear

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Clear the default Azure Quantum workspace.

az quantum workspace clear

Examples

Clear the default Azure Quantum workspace if previously set.

az quantum workspace clear
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 quantum workspace create

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new Azure Quantum workspace.

az quantum workspace create --location
                            --resource-group
                            --storage-account
                            --workspace-name
                            [--auto-accept]
                            [--provider-sku-list]
                            [--skip-autoadd]
                            [--skip-role-assignment]

Examples

Create a new Azure Quantum workspace with the providers that offer free credit.

az quantum workspace create -g MyResourceGroup -w MyWorkspace -l MyLocation \
    -a MyStorageAccountName

Create a new Azure Quantum workspace with a specific list of providers.

az quantum workspace create -g MyResourceGroup -w MyWorkspace -l MyLocation \
    -r "MyProvider1 / MySKU1, MyProvider2 / MySKU2" --skip-autoadd -a MyStorageAccountName

To display a list of available providers and their SKUs, use the following command:
    az quantum offerings list -l MyLocation -o table

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

--storage-account -a

Name of the storage account to be used by a quantum workspace.

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

Optional Parameters

--auto-accept

If specified, provider terms are accepted without an interactive Y/N prompt.

default value: False
--provider-sku-list -r

Comma separated list of Provider/SKU pairs. Separate the Provider and SKU with a slash. Enclose the entire list in quotes. Values from az quantum offerings list -l <location> -o table.

--skip-autoadd

If specified, the plans that offer free credits will not automatically be added.

default value: False
--skip-role-assignment

Skip the role assignment step for the quantum workspace in the storage account.

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

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the given (or current) Azure Quantum workspace.

az quantum workspace delete --resource-group
                            --workspace-name

Examples

Delete an Azure Quantum workspace by resource group and workspace name. If a default workspace has been set, the -g and -w parameters are not required.

az quantum workspace delete -g MyResourceGroup -w MyWorkspace

Required Parameters

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the list of Azure Quantum workspaces available.

az quantum workspace list [--location]
                          [--resource-group]
                          [--tag]

Examples

Get the list of all Azure Quantum workspaces available.

az quantum workspace list

Get the list Azure Quantum workspaces available in a location.

az quantum workspace list -l MyLocation

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

--tag

Show only quantum workspaces that have associated the specified tag.

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 quantum workspace quotas

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the quotas for the given (or current) Azure Quantum workspace.

az quantum workspace quotas --location
                            --resource-group
                            --workspace-name

Examples

List the quota information of a specified Azure Quantum workspace. If a default workspace has been set, the -g, -w, and -l parameters are not required.

az quantum workspace quotas -g MyResourceGroup -w MyWorkspace -l MyLocation

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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 quantum workspace set

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Select a default Azure Quantum workspace for future commands.

az quantum workspace set --location
                         --resource-group
                         --workspace-name

Examples

Set the default Azure Quantum workspace.

az quantum workspace set -g MyResourceGroup -w MyWorkspace -l MyLocation

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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 quantum workspace show

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of the given (or current) Azure Quantum workspace.

az quantum workspace show [--resource-group]
                          [--workspace-name]

Examples

Show the currently selected default Azure Quantum workspace.

az quantum workspace show

Show the details of a provided Azure Quantum workspace.

az quantum workspace show -g MyResourceGroup -w MyWorkspace

Optional Parameters

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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 quantum workspace update

Preview

Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the given (or current) Azure Quantum workspace.

az quantum workspace update [--enable-api-key]
                            [--resource-group]
                            [--workspace-name]

Examples

Enable a provided Azure Quantum workspace api keys.

az quantum workspace update --enable-api-key True

Disable a provided Azure Quantum workspace api keys.

az quantum workspace update --enable-api-key False

Optional Parameters

--enable-api-key

Enable or disable api key authentication.

--resource-group -g

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

--workspace-name -w

Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set.

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.