az quantum
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 command. Learn more about extensions.
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage Azure Quantum Workspaces and submit jobs to Azure Quantum Providers.
Commands
Name | Description | Type | Status |
---|---|---|---|
az quantum execute |
Submit a job to run on Azure Quantum, and waits for the result. |
Extension | Preview |
az quantum job |
Manage jobs for Azure Quantum. |
Extension | Preview |
az quantum job cancel |
Request to cancel a job on Azure Quantum if it hasn't completed. |
Extension | Preview |
az quantum job list |
Get the list of jobs in a Quantum Workspace. |
Extension | Preview |
az quantum job output |
Get the results of running a job. |
Extension | Preview |
az quantum job show |
Get the job's status and details. |
Extension | Preview |
az quantum job submit |
Submit a program or circuit to run on Azure Quantum. |
Extension | Preview |
az quantum job wait |
Place the CLI in a waiting state until the job finishes running. |
Extension | Preview |
az quantum offerings |
Manage provider offerings for Azure Quantum. |
Extension | Preview |
az quantum offerings accept-terms |
Accept the terms of a provider and SKU combination to enable it for workspace creation. |
Extension | Preview |
az quantum offerings list |
Get the list of all provider offerings available on the given location. |
Extension | Preview |
az quantum offerings show-terms |
Show the terms of a provider and SKU combination including license URL and acceptance status. |
Extension | Preview |
az quantum run |
Equivalent to |
Extension | Preview |
az quantum target |
Manage targets for Azure Quantum workspaces. |
Extension | Preview |
az quantum target clear |
Clear the default target-id. |
Extension | Preview |
az quantum target list |
Get the list of providers and their targets in an Azure Quantum workspace. |
Extension | Preview |
az quantum target set |
Select the default target to use when submitting jobs to Azure Quantum. |
Extension | Preview |
az quantum target show |
Get the Target ID of the current default target to use when submitting jobs to Azure Quantum. |
Extension | Preview |
az quantum workspace |
Manage Azure Quantum workspaces. |
Extension | Preview |
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 execute
Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Submit a job to run on Azure Quantum, and waits for the result.
az quantum execute --location
--resource-group
--target-id
--workspace-name
[--entry-point]
[--job-input-file]
[--job-input-format]
[--job-name]
[--job-output-format]
[--job-params]
[--no-build]
[--project]
[--shots]
[--storage]
[--target-capability]
[<PROGRAM_ARGS>]
Examples
Submit a Q# program from the current folder and wait for the result.
az quantum execute -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget
Submit and wait for a Q# program from the current folder with job and program parameters.
az quantum execute -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget \
--job-params key1=value1 key2=value2 -- --n-qubits=3
Submit and wait for a Q# program from the current folder with a target-capability parameter.
az quantum execute -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget \
--target-capability MyTargetCapability
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Execution engine for quantum computing jobs. When a workspace is configured with a set of providers, they each enable one or more targets. You can configure the default target using az quantum target set
.
Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set
.
Optional Parameters
The entry point for the QIR program or circuit. Required for QIR. Ignored on Q# jobs.
The location of the input file to submit. Required for QIR, QIO, and pass-through jobs. Ignored on Q# jobs.
The format of the file to submit. Omit this parameter on Q# jobs.
A friendly name to give to this run of the program.
The expected job output format. Ignored on Q# jobs.
Job parameters passed to the target as a list of key=value pairs, json string, or @{file}
with json content.
[Deprecated] If specified, the Q# program is not built before submitting.
[Deprecated] The location of the Q# project to submit. Defaults to current folder.
The number of times to run the Q# program on the given target.
If specified, the ConnectionString of an Azure Storage is used to store job data and results.
Target-capability parameter passed to the compiler.
List of arguments expected by the Q# operation specified as --name=value after --
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az quantum run
Command group 'quantum' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Equivalent to az quantum execute
.
az quantum run --location
--resource-group
--target-id
--workspace-name
[--entry-point]
[--job-input-file]
[--job-input-format]
[--job-name]
[--job-output-format]
[--job-params]
[--no-build]
[--project]
[--shots]
[--storage]
[--target-capability]
[<PROGRAM_ARGS>]
Examples
Submit a Q# program from the current folder and wait for the result.
az quantum run -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget
Submit and wait for a Q# program from the current folder with job and program parameters.
az quantum run -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget \
--job-params key1=value1 key2=value2 -- --n-qubits=3
Submit and wait for a Q# program from the current folder with a target-capability parameter.
az quantum run -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget \
--target-capability MyTargetCapability
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Execution engine for quantum computing jobs. When a workspace is configured with a set of providers, they each enable one or more targets. You can configure the default target using az quantum target set
.
Name of the Quantum Workspace. You can configure the default workspace using az quantum workspace set
.
Optional Parameters
The entry point for the QIR program or circuit. Required for QIR. Ignored on Q# jobs.
The location of the input file to submit. Required for QIR, QIO, and pass-through jobs. Ignored on Q# jobs.
The format of the file to submit. Omit this parameter on Q# jobs.
A friendly name to give to this run of the program.
The expected job output format. Ignored on Q# jobs.
Job parameters passed to the target as a list of key=value pairs, json string, or @{file}
with json content.
[Deprecated] If specified, the Q# program is not built before submitting.
[Deprecated] The location of the Q# project to submit. Defaults to current folder.
The number of times to run the Q# program on the given target.
If specified, the ConnectionString of an Azure Storage is used to store job data and results.
Target-capability parameter passed to the compiler.
List of arguments expected by the Q# operation specified as --name=value after --
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.