你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Jobs - Cancel

服务:: Azure Quantum

API 版本:: 2025-12-01-preview

请求取消现有作业。

POST {endpoint}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}/jobs/{jobId}:cancel?api-version=2025-12-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	Azure Quantum 服务的端点。例如，https://{region}.quantum.azure.com
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。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[a-zA-Z][a-zA-Z0-9\-_\.]*$	Azure 资源组的名称。
subscriptionId	path	True	string minLength: 36 maxLength: 36 pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$	Azure 订阅 ID。
workspaceName	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]*$	Azure Quantum 工作区的名称。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	JobDetails	请求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

JobDetails

请求已成功。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外错误响应。

标头

x-ms-error-code: string

安全性

AzureEntraAuth

Azure Entra OAuth2 身份验证

类型: oauth2
流向: application
令牌 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

作用域

名称	说明
https://quantum.microsoft.com/.default

x-ms-quantum-api-key

Azure Api-Key 身份验证

类型: apiKey
在: header

示例

Cancels a job.

示例请求

HTTP

POST {endpoint}/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Quantum/workspaces/my-workspace/jobs/00000000-0000-0000-0000-000000000002:cancel?api-version=2025-12-01-preview

示例响应

状态代码:: 200

{
  "name": "my-job",
  "id": "00000000-0000-0000-0000-000000000002",
  "itemType": "Job",
  "jobType": "QuantumComputing",
  "beginExecutionTime": "2020-09-30T23:59:02.3737928+00:00",
  "cancellationTime": "2020-10-01T00:00:00.0000000+00:00",
  "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",
  "createdBy": "user1@example.com",
  "createdByType": "User",
  "lastModifiedTime": "2020-10-01T00:10:00.0000000+00:00",
  "lastModifiedBy": "user2@example.com",
  "lastModifiedByType": "User",
  "lastUpdatedTime": "2020-10-01T00:15:00.0000000+00:00",
  "endExecutionTime": "2020-10-01T00:00:00.0000000+00:00",
  "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": "Cancelled",
  "target": "microsoft.estimator",
  "tags": [
    "tag1",
    "tag_2"
  ],
  "priority": "Standard",
  "usage": {
    "standardMinutes": 7
  }
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
CostEstimate	提供商计费的作业成本。由于附加税费和货币兑换率，账单上的最终费用可能略有不同。
CreatedByType	创造该物品的身份类型。
Errors.WorkspaceItemError	错误对象。
ItemType	工作区项的类型。
JobDetails	要在工作区中运行的作业。
JobStatus	作业的状态。
JobType	作业的类型。
Priority	作业优先级。
QuantumComputingData	量子计算数据。
UsageEvent	使用事件详细信息。

Azure.Core.Foundations.Error

对象

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

对象

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

对象

包含有关错误的更具体信息的对象。根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

CostEstimate

对象

提供商计费的作业成本。由于附加税费和货币兑换率，账单上的最终费用可能略有不同。

名称	类型	说明
currencyCode	string	货币代码。
estimatedTotal	number (float)	估计总数。
events	UsageEvent[]	使用事件列表。

CreatedByType

枚举

创造该物品的身份类型。

值	说明
User	该物品由用户创建
Application	该项目由应用创建
ManagedIdentity	该项目是通过托管身份创建的
Key	该物品是用密钥创建的

Errors.WorkspaceItemError

对象

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ItemType

枚举

工作区项的类型。

值	说明
Job	提交处理的程序、问题或应用程序。
Session	作业的逻辑分组。

JobDetails

对象

要在工作区中运行的作业。

名称	类型	说明
beginExecutionTime	string (date-time)	项目开始执行的时间。
cancellationTime	string (date-time)	作业成功取消的时间。
containerUri	string	Blob 容器 SAS uri，该容器用于托管作业数据。
costEstimate	CostEstimate	成本估算。
createdBy	string	创造这个物品的身份。
createdByType	CreatedByType	创造该物品的身份类型。
creationTime	string (date-time)	项的创建时间。
endExecutionTime	string (date-time)	项目完成执行的时间。
errorData	Errors.WorkspaceItemError	错误信息。
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。
inputDataFormat	string	输入数据的格式。
inputDataUri	string	输入 blob URI（如果指定），它将替代容器中的默认输入 blob。
inputParams	object	作业的输入参数。目标求解器使用的 JSON 对象。预计该对象的大小较小，仅用于指定执行目标的参数，而不是输入数据。
itemType	string: Job	Quantum Workspace 项的类型
jobType	JobType	作业类型。
lastModifiedBy	string	最后修改该物品的身份。
lastModifiedByType	CreatedByType	最后修改该物品的身份类型。
lastModifiedTime	string (date-time)	客户发起的商品最后修改的时间戳。
lastUpdatedTime	string (date-time)	系统最后一次更新该物品的时间。
metadata	object	作业元数据。元数据使客户端能够存储特定于客户端的信息
name	string	物料的名称。名称不需要是唯一的，它仅用于显示目的。
outputDataFormat	string	输出数据的格式。
outputDataUri	string	输出 blob uri。作业成功完成后，结果将上传到此 blob。
priority	Priority	作业或会话的优先级。
providerId	string	提供程序的唯一标识符。
quantumComputingData	QuantumComputingData	量子计算数据。
sessionId	string	作业所属的会话的 ID。
status	JobStatus	作业的状态。
tags	string[]	与作业关联的用户提供的标记列表。
target	string	运行作业的目标标识符。
usage	object	资源消耗指标包含特定于提供商的使用数据，例如执行时间、消耗的量子镜头等。

JobStatus

枚举

作业的状态。

值	说明
Queued	任务已经排队了。
Waiting	作业正在队列中等待执行。
Executing	作业正在执行中。
CancellationRequested	已申请取消该工作。
Cancelling	这份工作正在被取消。
Finishing	这项工作正在完成中。
Completed	作业已完成。
Succeeded	工作成功完成。
Failed	作业完成但失败。
Cancelled	作业已取消。

JobType

枚举

作业的类型。

值	说明
Unknown	未知作业类型。
QuantumComputing	量子计算作业类型。
Optimization	优化作业类型。

Priority

枚举

作业优先级。

值	说明
Standard	作业的基本优先级。
High	作业的优先级被提升。

QuantumComputingData

对象

量子计算数据。

名称	类型	说明
count	integer (int64)	作业中的量子计算项数。

UsageEvent

对象

使用事件详细信息。

名称	类型	说明
amountBilled	number (float)	计费金额。
amountConsumed	number (float)	消耗的量。
dimensionId	string	维度 ID。
dimensionName	string	维度名称。
measureUnit	string	度量单位。
unitPrice	number (float)	单价。

通过

Jobs - Cancel

URI 参数

响应

安全性

AzureEntraAuth

作用域

x-ms-quantum-api-key

示例

Cancels a job.

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CostEstimate

CreatedByType

Errors.WorkspaceItemError

ItemType

JobDetails

JobStatus

JobType

Priority

QuantumComputingData

UsageEvent