Jobs - Get

Service:: Azure Quantum

API Version:: 2024-10-01-preview

Get job by its id.

GET https://{region}.{serviceBaseUrl}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}?api-version=2024-10-01-preview

URI Parameters

Name	In	Required	Type	Description
jobId	path	True	string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	Id of the job.
region	path	True	string	The Azure region where the Azure Quantum Workspace is located.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$	Name of the Azure resource group.
serviceBaseUrl	path	True	string	The Azure Quantum service base url.
subscriptionId	path	True	string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$	The Azure subscription ID.
workspaceName	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$	Name of the Azure Quantum workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	JobDetails	The request has succeeded.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

JobDetails

The request has succeeded.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

AzureEntraAuth

Azure Entra OAuth2 Authentication

Type: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Scopes

Name	Description
https://quantum.microsoft.com/.default

x-ms-quantum-api-key

Azure Api-Key Authentication

Type: apiKey
In: header

Examples

Gets a job by its id.

Sample request

HTTP

GET https://{region}.{serviceBaseUrl}/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Quantum/workspaces/my-workspace/jobs/00000000-0000-0000-0000-000000000002?api-version=2024-10-01-preview

Sample response

Status code:: 200

{
  "name": "my-job",
  "id": "00000000-0000-0000-0000-000000000002",
  "itemType": "Job",
  "jobType": "QuantumComputing",
  "beginExecutionTime": null,
  "cancellationTime": null,
  "containerUri": "https://storage.blob.core.windows.net/job-00000000-0000-0000-0000-000000000002?sv=2019-02-02&sr=c&sig=SANITIZED&se=2020-10-01T11%3A57%3A01Z&sp=rcw",
  "creationTime": "2020-09-30T23:57:02.3737928+00:00",
  "endExecutionTime": null,
  "errorData": null,
  "inputDataFormat": "qir.v1",
  "inputDataUri": "https://storage.blob.core.windows.net/job-00000000-0000-0000-0000-000000000002/inputData?sv=2019-02-02&sr=b&sig=SANITIZED&se=2020-10-01T11%3A57%3A01Z&sp=rcw",
  "inputParams": {},
  "metadata": {},
  "outputDataFormat": "microsoft.resource-estimates.v1",
  "outputDataUri": "https://storage.blob.core.windows.net/job-00000000-0000-0000-0000-000000000002/rawOutputData?sv=2019-02-02&sr=c&sig=SANITIZED&se=2020-10-01T11%3A57%3A01Z&sp=rcw",
  "providerId": "microsoft-qc",
  "status": "Waiting",
  "target": "microsoft.estimator",
  "tags": [
    "tag1",
    "tag_2"
  ]
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
CostEstimate	The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.
Errors.WorkspaceItemError	The error object.
ItemType	The type of the workspace item.
JobDetails	A job to be run in the workspace.
JobStatus	The status of the job.
JobType	The type of the job.
QuantumComputingData	Quantum computing data.
UsageEvent	Usage event details.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

CostEstimate

Object

The job cost billed by the provider. The final cost on your bill might be slightly different due to added taxes and currency conversion rates.

Name	Type	Description
currencyCode	string	The currency code.
estimatedTotal	number (float)	The estimated total.
events	UsageEvent[]	List of usage events.

Errors.WorkspaceItemError

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ItemType

Enumeration

The type of the workspace item.

Value	Description
Job	A program, problem, or application submitted for processing.
Session	A logical grouping of jobs.

JobDetails

Object

A job to be run in the workspace.

Name	Type	Description
beginExecutionTime	string (date-time)	The time when the item began execution.
cancellationTime	string (date-time)	The time when a job was successfully cancelled.
containerUri	string	The blob container SAS uri, the container is used to host job data.
costEstimate	CostEstimate	Cost estimate.
creationTime	string (date-time)	The creation time of the item.
endExecutionTime	string (date-time)	The time when the item finished execution.
errorData	Errors.WorkspaceItemError	Error information.
id	string maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	Id of the job.
inputDataFormat	string	The format of the input data.
inputDataUri	string	The input blob URI, if specified, it will override the default input blob in the container.
inputParams	object	The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data.
itemType	string: Job	Type of the Quantum Workspace item
jobType	JobType	The type of job.
metadata	object	The job metadata. Metadata provides client the ability to store client-specific information
name	string	The name of the item. It is not required for the name to be unique and it's only used for display purposes.
outputDataFormat	string	The format of the output data.
outputDataUri	string	The output blob uri. When a job finishes successfully, results will be uploaded to this blob.
providerId	string	The unique identifier for the provider.
quantumComputingData	QuantumComputingData	Quantum computing data.
sessionId	string	The ID of the session that the job is part of.
status	JobStatus	The status of the job.
tags	string[]	List of user-supplied tags associated with the job.
target	string	The target identifier to run the job.

JobStatus

Enumeration

The status of the job.

Value	Description
Waiting	The job is waiting in the queue to be executed.
Executing	The job is being executed.
Succeeded	The job completed with success.
Failed	The job completed with failure.
Cancelled	The job was cancelled.

JobType

Enumeration

The type of the job.

Value	Description
Unknown	Unknown job type.
QuantumComputing	Quantum Computing job type.
Optimization	Optimization job type.

QuantumComputingData

Object

Quantum computing data.

Name	Type	Description
count	integer (int64)	The number of quantum computing items in the job.

UsageEvent

Object

Usage event details.

Name	Type	Description
amountBilled	number (float)	The amount billed.
amountConsumed	number (float)	The amount consumed.
dimensionId	string	The dimension id.
dimensionName	string	The dimension name.
measureUnit	string	The unit of measure.
unitPrice	number (float)	The unit price.

Share via

Jobs - Get

URI Parameters

Responses

Security

AzureEntraAuth

Scopes

x-ms-quantum-api-key

Examples

Gets a job by its id.

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CostEstimate

Errors.WorkspaceItemError

ItemType

JobDetails

JobStatus

JobType

QuantumComputingData

UsageEvent