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

Device Management - List Device Classes

根据设备更新 PnP 接口中报告的模型 ID 和兼容性属性,获取所有设备类的列表, (设备组与相同更新兼容的设备,这些属性适用于IoT 中心设备更新IoT 中心) 。

GET https://{endpoint}/deviceUpdate/{instanceId}/management/deviceClasses?api-version=2022-10-01
GET https://{endpoint}/deviceUpdate/{instanceId}/management/deviceClasses?api-version=2022-10-01&filter={filter}

URI 参数

名称 必需 类型 说明
endpoint
path True

string

url

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

instanceId
path True

string

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

api-version
query True

string

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

filter
query

string

限制返回的设备类集。 可以根据易记名称进行筛选。

响应

名称 类型 说明
200 OK

DeviceClassesList

所有设备类。

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_ListDeviceClasses

示例请求

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/deviceClasses?api-version=2022-10-01

示例响应

{
  "value": [
    {
      "deviceClassId": "deviceClassId",
      "friendlyName": "DeviceClass2020-04-22T12:12:12.0000000+00:00",
      "deviceClassProperties": {
        "contractModel": {
          "id": "dtmi:azure:iot:deviceUpdateContractModel;2",
          "name": "Device Update Model V2"
        },
        "compatProperties": {
          "manufacturer": "manufacturer1",
          "model": "model1"
        }
      },
      "bestCompatibleUpdate": {
        "updateId": {
          "provider": "provider",
          "name": "name",
          "version": "1.0.0.0"
        },
        "friendlyName": "July 2022 Update"
      }
    },
    {
      "deviceClassId": "deviceClassId2",
      "friendlyName": "DeviceClass2020-04-23T12:12:12.0000000+00:00",
      "deviceClassProperties": {
        "contractModel": {
          "id": "dtmi:azure:iot:deviceUpdateContractModel;2",
          "name": "Device Update Model V2"
        },
        "compatProperties": {
          "osArch": "osArch2"
        }
      }
    }
  ]
}

定义

名称 说明
ContractModel

设备更新代理协定模型。

DeviceClass

设备类元数据。

DeviceClassesList

设备类的列表。

DeviceClassProperties

用于计算设备类 ID 的设备类属性

Error

错误详细信息。

ErrorResponse

常见错误响应。

InnerError

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

UpdateId

更新标识符。

UpdateInfo

更新信息。

ContractModel

设备更新代理协定模型。

名称 类型 说明
id

string

设备类的设备更新代理协定模型 ID。 这还用于计算设备类 ID。

name

string

设备类的设备更新代理协定模型名称。 旨在成为更易读的协定模型 ID 形式。

DeviceClass

设备类元数据。

名称 类型 说明
bestCompatibleUpdate

UpdateInfo

与此设备类兼容的最高版本更新。

deviceClassId

string

设备类标识符。 这是从IoT 中心设备更新 PnP 接口中的设备更新代理报告的模型 ID 和兼容性属性生成的。 它是十六进制编码的 SHA1 哈希。

deviceClassProperties

DeviceClassProperties

用于计算设备类 ID 的设备类属性

friendlyName

string

设备类友好名称。 自动创建设备类后,调用方可以更新此值。

DeviceClassesList

设备类的列表。

名称 类型 说明
nextLink

string

指向下一页项的链接。

value

DeviceClass[]

可分页项的集合。

DeviceClassProperties

用于计算设备类 ID 的设备类属性

名称 类型 说明
compatProperties

object

设备类的兼容性属性。 可以将此对象视为一组键值对,其中键是兼容性属性的名称,值是兼容性属性的值。 始终至少有 1 个 compat 属性

contractModel

ContractModel

设备更新代理协定模型。

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

更新标识符。