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

Device Management - Get Group

获取设备组属性。

GET https://{endpoint}/deviceUpdate/{instanceId}/management/groups/{groupId}?api-version=2022-10-01

URI 参数

名称 必需 类型 说明
endpoint
path True

string

url

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

groupId
path True

string

组标识符。

instanceId
path True

string

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

api-version
query True

string

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

响应

名称 类型 说明
200 OK

Group

设备组属性。

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_GetGroup

示例请求

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

示例响应

{
  "groupId": "MyGroup",
  "groupType": "IoTHubTag",
  "createdDateTime": "2020-07-01T12:13:14.0000000Z",
  "deviceCount": 149,
  "subgroupsWithNewUpdatesAvailableCount": 3,
  "subgroupsWithUpdatesInProgressCount": 0,
  "subgroupsWithOnLatestUpdateCount": 1
}

定义

名称 说明
Error

错误详细信息。

ErrorResponse

常见错误响应。

Group

组详细信息。

GroupType

支持的组类型。

InnerError

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

Error

错误详细信息。

名称 类型 说明
code

string

服务器定义的错误代码。

details

Error[]

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

innererror

InnerError

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

message

string

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

occurredDateTime

string

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

target

string

错误的目标。

ErrorResponse

常见错误响应。

名称 类型 说明
error

Error

错误详细信息。

Group

组详细信息。

名称 类型 说明
createdDateTime

string

创建更新的日期和时间。

deployments

string[]

组的活动部署 ID

deviceCount

integer

组中的设备数。

groupId

string

组标识。 这是基于 Iot 中心的设备/模块孪生中的 ADUGroup 标记的值创建的,或者对于没有标记的设备$default。

groupType

GroupType

组类型。

subgroupsWithNewUpdatesAvailableCount

integer

包含可用新更新的子组计数。

subgroupsWithOnLatestUpdateCount

integer

具有最新更新上的设备的子组计数。

subgroupsWithUpdatesInProgressCount

integer

正在进行更新的子组计数。

GroupType

支持的组类型。

名称 类型 说明
DefaultNoTag

string

未标记设备的默认组。

IoTHubTag

string

IoT 中心基于标记的组,组中的所有设备共享 ADUGroup 标记值。

InnerError

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

名称 类型 说明
code

string

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

errorDetail

string

内部错误或异常消息。

innerError

InnerError

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

message

string

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