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

Device Management - Stop Deployment

停止部署。

POST https://{endpoint}/deviceUpdate/{instanceId}/management/groups/{groupId}/deviceClassSubgroups/{deviceClassId}/deployments/{deploymentId}:cancel?api-version=2022-10-01

URI 参数

名称 必需 类型 说明
deploymentId
path True

string

部署标识符。

deviceClassId
path True

string

设备类标识符。

endpoint
path True

string

url

IoT 中心帐户终结点的设备更新仅 (主机名,不) 协议。

groupId
path True

string

组标识符。

instanceId
path True

string

IoT 中心帐户实例标识符的设备更新。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

响应

名称 类型 说明
200 OK

Deployment

部署属性。

Other Status Codes

ErrorResponse

默认响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://api.adu.microsoft.com/.default 默认授权范围。

示例

DeviceManagement_CancelOrRetryDeployment

示例请求

POST https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/groups/TestGroup/deviceClassSubgroups/deviceClassId/deployments/deploymentId:cancel?api-version=2022-10-01

示例响应

{
  "deploymentId": "deploymentId",
  "groupId": "TestGroup",
  "startDateTime": "2020-04-22T12:12:12.0000000+00:00",
  "update": {
    "updateId": {
      "provider": "provider",
      "name": "name",
      "version": "1.2.3.4"
    }
  },
  "isCanceled": true,
  "isRetried": false
}

定义

名称 说明
CloudInitiatedRollbackPolicy

用于部署的回滚策略

CloudInitiatedRollbackPolicyFailure

启动回滚策略的失败条件

Deployment

部署元数据。

Error

错误详细信息。

ErrorResponse

常见错误响应。

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

UpdateId

更新标识符。

UpdateInfo

更新信息。

CloudInitiatedRollbackPolicy

用于部署的回滚策略

名称 类型 说明
failure

CloudInitiatedRollbackPolicyFailure

启动回滚策略的失败条件。

update

UpdateInfo

要回滚到的更新。

CloudInitiatedRollbackPolicyFailure

启动回滚策略的失败条件

名称 类型 说明
devicesFailedCount

integer

失败的设备数。

devicesFailedPercentage

integer

失败设备的百分比。

Deployment

部署元数据。

名称 类型 说明
deploymentId

string

调用方提供的部署标识符。 长度不能超过 73 个字符,必须全部为小写,并且不能包含“&”、“^”、“[”、“]”、“{”、“}”、“|<”、“”、“>正斜杠”、“反斜杠”或双引号。 Azure 门户中的汇报视图IoT 中心资源在创建部署时为 deploymentId 生成 GUID。

deviceClassSubgroups

string[]

与部署兼容的设备类子组,以及已为其创建子组部署的设备类子组。 这在 CreateOrUpdateDeployment 期间不由调用方提供,但由设备更新自动确定

groupId

string

部署要更新的设备的组标识。

isCanceled

boolean

指示部署是否已取消的布尔标志。

isCloudInitiatedRollback

boolean

指示部署是否为回滚部署的布尔标志。

isRetried

boolean

指示是否已重试部署的布尔标志。

rollbackPolicy

CloudInitiatedRollbackPolicy

部署的回滚策略。

startDateTime

string

部署开始日期/时间。

update

UpdateInfo

部署中更新的更新信息。

Error

错误详细信息。

名称 类型 说明
code

string

服务器定义的错误代码。

details

Error[]

导致报告错误的错误的数组。

innererror

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

occurredDateTime

string

发生错误的日期和时间(UTC)。

target

string

错误的目标。

ErrorResponse

常见错误响应。

名称 类型 说明
error

Error

错误详细信息。

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

名称 类型 说明
code

string

比包含错误所提供的代码更具体的错误代码。

errorDetail

string

内部错误或异常消息。

innerError

InnerError

一个 对象,该对象包含比当前对象更具体的错误信息。

message

string

错误的用户可读表示形式。

UpdateId

更新标识符。

名称 类型 说明
name

string

更新名称。

provider

string

更新提供程序。

version

string

更新版本。

UpdateInfo

更新信息。

名称 类型 说明
description

string

更新说明。

friendlyName

string

友好的更新名称。

updateId

UpdateId

更新标识符。