az quantum job

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

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

Manage jobs for Azure Quantum.

Commands

Name Description Type Status
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 job cancel

Preview

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

Request to cancel a job on Azure Quantum if it hasn't completed.

az quantum job cancel --job-id
                      --location
                      --resource-group
                      --workspace-name

Examples

Cancel an Azure Quantum job by id.

az quantum job cancel -g MyResourceGroup -w MyWorkspace -l MyLocation \
    -j yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy

Required Parameters

--job-id -j

Job unique identifier in GUID format.

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

Preview

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

Get the list of jobs in a Quantum Workspace.

az quantum job list --location
                    --resource-group
                    --workspace-name

Examples

Get the list of jobs from an Azure Quantum workspace.

az quantum job list -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 job output

Preview

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

Get the results of running a job.

az quantum job output --job-id
                      --location
                      --resource-group
                      --workspace-name
                      [--item]

Examples

Print the results of a successful Azure Quantum job.

az quantum job output -g MyResourceGroup -w MyWorkspace -l MyLocation \
    -j yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -o table

Required Parameters

--job-id -j

Job unique identifier in GUID format.

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

Optional Parameters

--item

The item index in a batching job.

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

Preview

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

Get the job's status and details.

az quantum job show --job-id
                    --location
                    --resource-group
                    --workspace-name

Examples

Get the status of an Azure Quantum job.

az quantum job show -g MyResourceGroup -w MyWorkspace -l MyLocation \
    -j yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy --query status

Required Parameters

--job-id -j

Job unique identifier in GUID format.

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

Preview

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

Submit a program or circuit to run on Azure Quantum.

az quantum job submit --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.

az quantum job submit -g MyResourceGroup -w MyWorkspace -l MyLocation \
   -t MyTarget --job-name MyJob

Submit a Q# program from the current folder with job parameters for a target.

az quantum job submit -g MyResourceGroup -w MyWorkspace -l MyLocation \
   -t MyTarget --job-name MyJob --job-params param1=value1 param2=value2

Submit a Q# program with program parameters (e.g. n-qubits = 2).

az quantum job submit -g MyResourceGroup -w MyWorkspace -l MyLocation \
   -t MyTarget --job-name MyJob -- --n-qubits=2

Submit a Q# program from the current folder with a target-capability parameter.

az quantum job submit -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget \
    --target-capability MyTargetCapability

Submit QIR bitcode or human-readable LLVM code from a file in the current folder.

az quantum job submit -g MyResourceGroup -w MyWorkspace -l MyLocation -t MyTarget \
    --job-name MyJob --job-input-format qir.v1 --job-input-file MyQirBitcode.bc \
    --entry-point MyQirEntryPoint

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

--target-id -t

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.

--workspace-name -w

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

Optional Parameters

--entry-point

The entry point for the QIR program or circuit. Required for QIR. Ignored on Q# jobs.

--job-input-file

The location of the input file to submit. Required for QIR, QIO, and pass-through jobs. Ignored on Q# jobs.

--job-input-format

The format of the file to submit. Omit this parameter on Q# jobs.

--job-name

A friendly name to give to this run of the program.

--job-output-format

The expected job output format. Ignored on Q# jobs.

--job-params

Job parameters passed to the target as a list of key=value pairs, json string, or @{file} with json content.

--no-build

[Deprecated] If specified, the Q# program is not built before submitting.

default value: False
--project

[Deprecated] The location of the Q# project to submit. Defaults to current folder.

--shots

The number of times to run the Q# program on the given target.

--storage

If specified, the ConnectionString of an Azure Storage is used to store job data and results.

--target-capability

Target-capability parameter passed to the compiler.

<PROGRAM_ARGS>

List of arguments expected by the Q# operation specified as --name=value after --.

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

Preview

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

Place the CLI in a waiting state until the job finishes running.

az quantum job wait --job-id
                    --location
                    --resource-group
                    --workspace-name
                    [--max-poll-wait-secs]

Examples

Wait for completion of a job, check at 60 second intervals.

az quantum job wait -g MyResourceGroup -w MyWorkspace -l MyLocation \
    -j yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy --max-poll-wait-secs 60 -o table

Required Parameters

--job-id -j

Job unique identifier in GUID format.

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

Optional Parameters

--max-poll-wait-secs

Poll time in seconds to query Azure Quantum for results of the corresponding job.

default value: 5
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.