Microsoft.Quantum (preview:2025-09-01)

2025/10/08 • 14 new methods

Jobs_Update (new)
Description :  Update job properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobUpdateOptions/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
priority:
{
Description: Priority of job. ,
Enum:
{
Standard: The job's base priority. ,
High: The job's priority is elevated. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the job. ,
Required: False ,
}
string ,
tags:
{
Description: List of user-supplied tags associated with the job. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
priority:
{
Description: Priority of job. ,
Enum:
{
Standard: The job's base priority. ,
High: The job's priority is elevated. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the job. ,
Required: False ,
}
string ,
tags:
{
Description: List of user-supplied tags associated with the job. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Jobs_List (new)
Description :  List all jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of jobs taken. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The order of returned items. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The JobDetails items on this page ,
Required: True ,
}
[
{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
jobType:
{
Description: The type of job. ,
Enum:
{
Unknown: Unknown job type. ,
QuantumComputing: Quantum Computing job type. ,
Optimization: Optimization job type. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: The ID of the session that the job is part of. ,
Required: False ,
}
string ,
containerUri:
{
Description: The blob container SAS uri, the container is used to host job data. ,
Required: True ,
}
string ,
inputDataUri:
{
Description: The input blob URI, if specified, it will override the default input blob in the container. ,
Required: False ,
}
string ,
inputDataFormat:
{
Description: The format of the input data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The job metadata. Metadata provides client the ability to store client-specific information ,
Required: False ,
}
object ,
cancellationTime:
{
Description: The time when a job was successfully cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
quantumComputingData:
{
Description: Quantum computing data. ,
Required: False ,
}
{
count:
{
Description: The number of quantum computing items in the job. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
inputParams:
{
Description: 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. ,
Required: False ,
}
object ,
outputDataUri:
{
Description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. ,
Required: False ,
}
string ,
outputDataFormat:
{
Description: The format of the output data. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Jobs_Get (new)
Description :  Get job by its id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
jobType:
{
Description: The type of job. ,
Enum:
{
Unknown: Unknown job type. ,
QuantumComputing: Quantum Computing job type. ,
Optimization: Optimization job type. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: The ID of the session that the job is part of. ,
Required: False ,
}
string ,
containerUri:
{
Description: The blob container SAS uri, the container is used to host job data. ,
Required: True ,
}
string ,
inputDataUri:
{
Description: The input blob URI, if specified, it will override the default input blob in the container. ,
Required: False ,
}
string ,
inputDataFormat:
{
Description: The format of the input data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The job metadata. Metadata provides client the ability to store client-specific information ,
Required: False ,
}
object ,
cancellationTime:
{
Description: The time when a job was successfully cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
quantumComputingData:
{
Description: Quantum computing data. ,
Required: False ,
}
{
count:
{
Description: The number of quantum computing items in the job. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
inputParams:
{
Description: 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. ,
Required: False ,
}
object ,
outputDataUri:
{
Description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. ,
Required: False ,
}
string ,
outputDataFormat:
{
Description: The format of the output data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Jobs_Create (new)
Description :  Create a new job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
jobType:
{
Description: The type of job. ,
Enum:
{
Unknown: Unknown job type. ,
QuantumComputing: Quantum Computing job type. ,
Optimization: Optimization job type. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: The ID of the session that the job is part of. ,
Required: False ,
}
string ,
containerUri:
{
Description: The blob container SAS uri, the container is used to host job data. ,
Required: True ,
}
string ,
inputDataUri:
{
Description: The input blob URI, if specified, it will override the default input blob in the container. ,
Required: False ,
}
string ,
inputDataFormat:
{
Description: The format of the input data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The job metadata. Metadata provides client the ability to store client-specific information ,
Required: False ,
}
object ,
cancellationTime:
{
Description: The time when a job was successfully cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
quantumComputingData:
{
Description: Quantum computing data. ,
Required: False ,
}
{
count:
{
Description: The number of quantum computing items in the job. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
inputParams:
{
Description: 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. ,
Required: False ,
}
object ,
outputDataUri:
{
Description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. ,
Required: False ,
}
string ,
outputDataFormat:
{
Description: The format of the output data. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
jobType:
{
Description: The type of job. ,
Enum:
{
Unknown: Unknown job type. ,
QuantumComputing: Quantum Computing job type. ,
Optimization: Optimization job type. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: The ID of the session that the job is part of. ,
Required: False ,
}
string ,
containerUri:
{
Description: The blob container SAS uri, the container is used to host job data. ,
Required: True ,
}
string ,
inputDataUri:
{
Description: The input blob URI, if specified, it will override the default input blob in the container. ,
Required: False ,
}
string ,
inputDataFormat:
{
Description: The format of the input data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The job metadata. Metadata provides client the ability to store client-specific information ,
Required: False ,
}
object ,
cancellationTime:
{
Description: The time when a job was successfully cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
quantumComputingData:
{
Description: Quantum computing data. ,
Required: False ,
}
{
count:
{
Description: The number of quantum computing items in the job. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
inputParams:
{
Description: 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. ,
Required: False ,
}
object ,
outputDataUri:
{
Description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. ,
Required: False ,
}
string ,
outputDataFormat:
{
Description: The format of the output data. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
jobType:
{
Description: The type of job. ,
Enum:
{
Unknown: Unknown job type. ,
QuantumComputing: Quantum Computing job type. ,
Optimization: Optimization job type. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: The ID of the session that the job is part of. ,
Required: False ,
}
string ,
containerUri:
{
Description: The blob container SAS uri, the container is used to host job data. ,
Required: True ,
}
string ,
inputDataUri:
{
Description: The input blob URI, if specified, it will override the default input blob in the container. ,
Required: False ,
}
string ,
inputDataFormat:
{
Description: The format of the input data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The job metadata. Metadata provides client the ability to store client-specific information ,
Required: False ,
}
object ,
cancellationTime:
{
Description: The time when a job was successfully cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
quantumComputingData:
{
Description: Quantum computing data. ,
Required: False ,
}
{
count:
{
Description: The number of quantum computing items in the job. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
inputParams:
{
Description: 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. ,
Required: False ,
}
object ,
outputDataUri:
{
Description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. ,
Required: False ,
}
string ,
outputDataFormat:
{
Description: The format of the output data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Jobs_Cancel (new)
Description :  Request the cancellation of an existing job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
jobId:
{
Description: Id of the job. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Providers_List (new)
Description :  List all providers in the workspace with their respective status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/providerStatus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ProviderStatus items on this page ,
Required: True ,
}
[
{
id:
{
Description: Provider id. ,
Required: True ,
}
string ,
currentAvailability:
{
Description: Current provider availability. ,
Enum:
{
Available: Provider is available. ,
Degraded: Provider is available with degraded experience. ,
Unavailable: Provider is unavailable. ,
}
,
Required: True ,
}
enum ,
targets:
{
Description: Current target statuses. ,
Required: True ,
}
[
{
id:
{
Description: Target id. ,
Required: True ,
}
string ,
currentAvailability:
{
Description: Current target availability. ,
Enum:
{
Available: Target is available. ,
Degraded: Target is available with degraded experience. ,
Unavailable: Target is unavailable. ,
}
,
Required: True ,
}
enum ,
averageQueueTime:
{
Description: Average queue time in seconds. ,
Format: int64 ,
Required: True ,
}
integer ,
statusPage:
{
Description: A page with detailed status of the provider. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Quotas_List (new)
Description :  List quotas for the given workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/quotas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Quota items on this page ,
Required: True ,
}
[
{
dimension:
{
Description: The name of the dimension associated with the quota. ,
Required: True ,
}
string ,
scope:
{
Description: The scope at which the quota is applied. ,
Enum:
{
Workspace: The quota is applied to the Quantum Workspace. ,
Subscription: The quota is applied to the Azure Subscription. ,
}
,
Required: True ,
}
enum ,
providerId:
{
Description: The unique identifier for the provider. ,
Required: True ,
}
string ,
utilization:
{
Description: The amount of the usage that has been applied for the current period. ,
Format: float ,
Required: True ,
}
number ,
holds:
{
Description: The amount of the usage that has been reserved but not applied for the current period. ,
Format: float ,
Required: True ,
}
number ,
limit:
{
Description: The maximum amount of usage allowed for the current period. ,
Format: float ,
Required: True ,
}
number ,
period:
{
Description: The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas. ,
Enum:
{
None: The meter period is instantaneous. Used for concurrent quotas. ,
Monthly: The meter period is per month. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sessions_Listv2 (new)
Description :  List all Sessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of jobs taken. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The order of returned items. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SessionDetails items on this page ,
Required: True ,
}
[
{
id:
{
Description: Id of the session. ,
Required: True ,
}
string ,
jobFailurePolicy:
{
Description: Policy controlling the behavior of the Session when a job in the session fails. ,
Enum:
{
Abort: New jobs submitted after a job fails will be rejected. ,
Continue: New jobs submitted after a job fails will be accepted. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the session. ,
Enum:
{
Waiting: The session is waiting in the queue to be executed. ,
Executing: The session is being executed. ,
Succeeded: The session completed with success. ,
Failed: The session completed with failure. ,
Failure(s): The session completed with some failures. ,
TimedOut: The session timed out. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sessions_Get (new)
Description :  Get Session by its id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
sessionId:
{
Description: Id of the session. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the session. ,
Required: True ,
}
string ,
jobFailurePolicy:
{
Description: Policy controlling the behavior of the Session when a job in the session fails. ,
Enum:
{
Abort: New jobs submitted after a job fails will be rejected. ,
Continue: New jobs submitted after a job fails will be accepted. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the session. ,
Enum:
{
Waiting: The session is waiting in the queue to be executed. ,
Executing: The session is being executed. ,
Succeeded: The session completed with success. ,
Failed: The session completed with failure. ,
Failure(s): The session completed with some failures. ,
TimedOut: The session timed out. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sessions_Open (new)
Description :  Open a new session.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
sessionId:
{
Description: Id of the session. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: Id of the session. ,
Required: True ,
}
string ,
jobFailurePolicy:
{
Description: Policy controlling the behavior of the Session when a job in the session fails. ,
Enum:
{
Abort: New jobs submitted after a job fails will be rejected. ,
Continue: New jobs submitted after a job fails will be accepted. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the session. ,
Enum:
{
Waiting: The session is waiting in the queue to be executed. ,
Executing: The session is being executed. ,
Succeeded: The session completed with success. ,
Failed: The session completed with failure. ,
Failure(s): The session completed with some failures. ,
TimedOut: The session timed out. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Id of the session. ,
Required: True ,
}
string ,
jobFailurePolicy:
{
Description: Policy controlling the behavior of the Session when a job in the session fails. ,
Enum:
{
Abort: New jobs submitted after a job fails will be rejected. ,
Continue: New jobs submitted after a job fails will be accepted. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the session. ,
Enum:
{
Waiting: The session is waiting in the queue to be executed. ,
Executing: The session is being executed. ,
Succeeded: The session completed with success. ,
Failed: The session completed with failure. ,
Failure(s): The session completed with some failures. ,
TimedOut: The session timed out. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
id:
{
Description: Id of the session. ,
Required: True ,
}
string ,
jobFailurePolicy:
{
Description: Policy controlling the behavior of the Session when a job in the session fails. ,
Enum:
{
Abort: New jobs submitted after a job fails will be rejected. ,
Continue: New jobs submitted after a job fails will be accepted. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the session. ,
Enum:
{
Waiting: The session is waiting in the queue to be executed. ,
Executing: The session is being executed. ,
Succeeded: The session completed with success. ,
Failed: The session completed with failure. ,
Failure(s): The session completed with some failures. ,
TimedOut: The session timed out. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Sessions_Close (new)
Description :  Close an existing session.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}:close
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
sessionId:
{
Description: Id of the session. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id of the session. ,
Required: True ,
}
string ,
jobFailurePolicy:
{
Description: Policy controlling the behavior of the Session when a job in the session fails. ,
Enum:
{
Abort: New jobs submitted after a job fails will be rejected. ,
Continue: New jobs submitted after a job fails will be accepted. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the session. ,
Enum:
{
Waiting: The session is waiting in the queue to be executed. ,
Executing: The session is being executed. ,
Succeeded: The session completed with success. ,
Failed: The session completed with failure. ,
Failure(s): The session completed with some failures. ,
TimedOut: The session timed out. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
SessionsJobs_List (new)
Description :  List jobs in a session.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions/{sessionId}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
sessionId:
{
Description: Id of the session to list jobs from. ,
Required: True ,
}
string ,
filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of jobs taken. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The order of returned items. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The JobDetails items on this page ,
Required: True ,
}
[
{
id:
{
Description: Id of the job. ,
Required: True ,
}
string ,
jobType:
{
Description: The type of job. ,
Enum:
{
Unknown: Unknown job type. ,
QuantumComputing: Quantum Computing job type. ,
Optimization: Optimization job type. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: The ID of the session that the job is part of. ,
Required: False ,
}
string ,
containerUri:
{
Description: The blob container SAS uri, the container is used to host job data. ,
Required: True ,
}
string ,
inputDataUri:
{
Description: The input blob URI, if specified, it will override the default input blob in the container. ,
Required: False ,
}
string ,
inputDataFormat:
{
Description: The format of the input data. ,
Required: False ,
}
string ,
status:
{
Description: The status of the job. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The job metadata. Metadata provides client the ability to store client-specific information ,
Required: False ,
}
object ,
cancellationTime:
{
Description: The time when a job was successfully cancelled. ,
Format: date-time ,
Required: False ,
}
string ,
quantumComputingData:
{
Description: Quantum computing data. ,
Required: False ,
}
{
count:
{
Description: The number of quantum computing items in the job. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
inputParams:
{
Description: 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. ,
Required: False ,
}
object ,
outputDataUri:
{
Description: The output blob uri. When a job finishes successfully, results will be uploaded to this blob. ,
Required: False ,
}
string ,
outputDataFormat:
{
Description: The format of the output data. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Storage_GetSasUri (new)
Description :  Gets a URL with SAS token for a container/blob in the storage account associated with the workspace. The SAS URL can be used to upload job input and/or download job output.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/storage/sasUri
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
blobDetails:
{
Description: The details (name and container) of the blob. ,
Required: True ,
}
{
containerName:
{
Description: The container name. ,
Required: True ,
}
string ,
blobName:
{
Description: The blob name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
sasUri:
{
Description: A URL with a SAS token to upload a blob for execution in the given workspace. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TopLevelItems_Listv2 (new)
Description :  List top-level items.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/topLevelItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Azure resource group. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Name of the Azure Quantum workspace. ,
Required: True ,
}
string ,
filter:
{
Description: Filter the result list using the given expression ,
Required: False ,
}
string ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of jobs taken. ,
Format: int32 ,
Required: False ,
}
integer ,
orderby:
{
Description: The order of returned items. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ItemDetails items on this page ,
Required: True ,
}
[
{
id:
{
Description: Id of the item. ,
Required: True ,
}
string ,
name:
{
Description: The name of the item. It is not required for the name to be unique and it's only used for display purposes. ,
Required: True ,
}
string ,
providerId:
{
Description: The unique identifier for the provider. ,
Required: True ,
}
string ,
target:
{
Description: The target identifier to run the job. ,
Required: True ,
}
string ,
itemType:
{
Description: Type of the Quantum Workspace item ,
Enum:
{
Job: A program, problem, or application submitted for processing. ,
Session: A logical grouping of jobs. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The creation time of the item. ,
Format: date-time ,
Required: False ,
}
string ,
beginExecutionTime:
{
Description: The time when the item began execution. ,
Format: date-time ,
Required: False ,
}
string ,
endExecutionTime:
{
Description: The time when the item finished execution. ,
Format: date-time ,
Required: False ,
}
string ,
costEstimate:
{
Description: Cost estimate. ,
Required: False ,
}
{
currencyCode:
{
Description: The currency code. ,
Required: True ,
}
string ,
events:
{
Description: List of usage events. ,
Required: False ,
}
[
{
dimensionId:
{
Description: The dimension id. ,
Required: True ,
}
string ,
dimensionName:
{
Description: The dimension name. ,
Required: True ,
}
string ,
measureUnit:
{
Description: The unit of measure. ,
Required: True ,
}
string ,
amountBilled:
{
Description: The amount billed. ,
Format: float ,
Required: True ,
}
number ,
amountConsumed:
{
Description: The amount consumed. ,
Format: float ,
Required: True ,
}
number ,
unitPrice:
{
Description: The unit price. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
estimatedTotal:
{
Description: The estimated total. ,
Format: float ,
Required: True ,
}
number ,
}
,
errorData:
{
Description: Error information. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
priority:
{
Description: Priority of job or session. ,
Enum:
{
Standard: The job's base priority. ,
High: The job's priority is elevated. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: List of user-supplied tags associated with the job. ,
Required: False ,
}
[
string ,
]
,
usage:
{
Description: Resource consumption metrics containing provider-specific usage data such as execution time, quantum shots consumed etc. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}