通过

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

Device Update - Get Operation Status

服务:
Device Update
API 版本:
2022-10-01

检索作状态。

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?api-version=2022-10-01

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (url)

IoT 中心帐户终结点的设备更新（仅主机名，无协议）。
instanceId
 path True

string

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

string

minLength: 1
maxLength: 256

作标识符。
api-version
 query True

string

要用于客户端请求的 API 的版本。

请求头

名称 必需 类型 说明
If-None-Match

string

定义 If-None-Match 条件。 仅当服务器上的 ETag 与此值不匹配时，才会执行该作。

响应

名称 类型 说明
200 OK

UpdateOperation

作状态。

标头

Retry-After: string
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 默认授权范围。

示例

DeviceUpdate_GetOperationStatus

示例请求

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

示例响应

状态代码:
200 
{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

定义

名称 说明
Error

错误详细信息。
ErrorResponse

常见的错误响应。
InnerError

包含与当前对象有关错误的更具体信息的对象。
OperationStatus

作状态。
UpdateId

更新标识符。
UpdateInfo

更新信息。
UpdateOperation

作元数据。

Error

Object

错误详细信息。

名称 类型 说明
code

string

服务器定义的错误代码。
details

Error[]

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

InnerError

包含与当前对象有关错误的更具体信息的对象。
message

string

错误的人工可读表示形式。
occurredDateTime

string (date-time)

发生错误的日期和时间（UTC）。
target

string

错误的目标。

ErrorResponse

Object

常见的错误响应。

名称 类型 说明
error

Error

错误详细信息。

InnerError

Object

包含与当前对象有关错误的更具体信息的对象。

名称 类型 说明
code

string

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

string

内部错误或异常消息。
innerError

InnerError

包含与当前对象有关错误的更具体信息的对象。
message

string

错误的人工可读表示形式。

OperationStatus

枚举

作状态。

值 说明
NotStarted

已创建但尚未启动的后台作。
Running

后台作当前正在运行。
Succeeded

后台作成功完成。
Failed

后台作已完成，失败。

UpdateId

Object

更新标识符。

名称 类型 说明
name

string

更新名称。
provider

string

更新提供程序。
version

string

更新版本。

UpdateInfo

Object

更新信息。

名称 类型 说明
description

string

更新说明。
friendlyName

string

友好更新名称。
updateId

UpdateId

更新标识符。

UpdateOperation

Object

作元数据。

名称 类型 说明
createdDateTime

string (date-time)

创建作时的 UTC 日期和时间。
error

Error

遇到作错误（如果有）。
etag

string

作 ETag。
lastActionDateTime

string (date-time)

上次更新作状态的 UTC 日期和时间。
operationId

string

作 ID。
resourceLocation

string

作成功时导入的更新的位置。
status

OperationStatus

作状态。
traceId

string

Microsoft支持人员可用于故障排除的作关联标识。
update

UpdateInfo

正在导入或删除的更新。 对于导入，只有在成功处理导入清单后，才会填充此属性。