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

2025/10/08 • 1 updated methods

Jobs_Update (updated)
Description :  OLD METHOD: Update job properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_Update",
  "Description": {
    "new": "OLD METHOD: Update job properties.",
    "old": "Update job properties."
  }
}

⚼ Request

PATCH:  /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 ,
}
{
op:
{
Description: The operation to be performed. ,
Enum:
{
add: Add value operation. ,
remove: Remove value operation. ,
replace: Replace value operation. ,
move: Move value operation. ,
copy: Copy value operation. ,
test: Test value operation. ,
}
,
Required: True ,
}
enum ,
path:
{
Description: A JSON-Pointer. ,
Required: True ,
}
string ,
value:
{
Description: A value to be used in the operation on the path. ,
Required: False ,
}
object ,
from:
{
Description: Optional field used in copy and move operations. ,
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 ,
tags:
{
Description: List of user-supplied tags associated with the job. ,
Required: False ,
}
[
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 ,
}
,
}
,
}
,
}