Microsoft.Quantum (preview:2024-10-01)

2025/03/06 • 14 new methods

Jobs_List (new)
Description List all jobs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
filter: string ,
skip: integer ,
top: integer ,
orderby: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
jobId: string ,
}

⚐ Response (200)

{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
jobId: string ,
resource:
{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}
,
}

⚐ Response (200)

{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}

⚐ Response (201)

{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
Jobs_Update (new)
Description Update job properties.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
jobId: string ,
resource:
{
op: enum ,
path: string ,
value: object ,
from: string ,
}
,
}

⚐ Response (200)

{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
jobId: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
currentAvailability: enum ,
targets:
[
{
id: string ,
currentAvailability: enum ,
averageQueueTime: integer ,
statusPage: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
}

⚐ Response (200)

{
value:
[
{
dimension: string ,
scope: enum ,
providerId: string ,
utilization: number ,
holds: number ,
limit: number ,
period: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
Sessions_Listv2 (new)
Description List all Sessions.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/sessions
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
filter: string ,
skip: integer ,
top: integer ,
orderby: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
jobFailurePolicy: enum ,
status: enum ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
sessionId: string ,
}

⚐ Response (200)

{
id: string ,
jobFailurePolicy: enum ,
status: enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
sessionId: string ,
resource:
{
id: string ,
jobFailurePolicy: enum ,
status: enum ,
}
,
}

⚐ Response (200)

{
id: string ,
jobFailurePolicy: enum ,
status: enum ,
}

⚐ Response (201)

{
id: string ,
jobFailurePolicy: enum ,
status: enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
sessionId: string ,
}

⚐ Response (200)

{
id: string ,
jobFailurePolicy: enum ,
status: enum ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
sessionId: string ,
filter: string ,
skip: integer ,
top: integer ,
orderby: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
jobType: enum ,
sessionId: string ,
containerUri: string ,
inputDataUri: string ,
inputDataFormat: string ,
status: enum ,
metadata: object ,
cancellationTime: string ,
tags:
[
string ,
]
,
quantumComputingData:
{
count: integer ,
}
,
inputParams: object ,
outputDataUri: string ,
outputDataFormat: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
blobDetails:
{
containerName: string ,
blobName: string ,
}
,
}

⚐ Response (200)

{
sasUri: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: 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: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
filter: string ,
skip: integer ,
top: integer ,
orderby: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
providerId: string ,
target: string ,
itemType: enum ,
creationTime: string ,
beginExecutionTime: string ,
endExecutionTime: string ,
costEstimate:
{
currencyCode: string ,
events:
[
{
dimensionId: string ,
dimensionName: string ,
measureUnit: string ,
amountBilled: number ,
amountConsumed: number ,
unitPrice: number ,
}
,
]
,
estimatedTotal: number ,
}
,
errorData:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}