Device Management - List Device Class Subgroups For Group

Szolgáltatás:

Device Update

API-verzió:

2022-10-01

Szerezze be a csoport eszközosztály-alcsoportjait. Az eszközosztály-alcsoport az ugyanazon eszközosztályt használó csoporton belüli eszközök csoportja. Az ugyanabban az eszközosztályban lévő összes eszköz kompatibilis ugyanazokkal a frissítésekkel.

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

Opcionális paraméterekkel:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (url)	Az IoT Hub-fiók végpontjának eszközfrissítése (csak gazdagépnév, protokoll nélkül).
groupId	path	True	string	Csoportazonosító.
instanceId	path	True	string	Az IoT Hub-fiókpéldány-azonosító eszközfrissítése.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója.
filter	query		string	Korlátozza a visszaadott eszközosztály-alcsoportok készletét. A compat tulajdonságokra név és érték alapján is szűrhet. (azaz filter=compatProperties/propertyName1 eq "value1" és compatProperties/propertyName2 eq 'value2'

Válaszok

Name	Típus	Description
200 OK	DeviceClassSubgroupsList	Az eszközosztály alcsoportjának részletei.
Other Status Codes	ErrorResponse	Alapértelmezett válasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://api.adu.microsoft.com/.default	Alapértelmezett engedélyezési hatókör.

Példák

DeviceManagement_ListDeviceClassSubgroupsForGroup

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "deviceClassId": "DeviceClassId",
      "groupId": "group1",
      "createdDateTime": "2020-07-01T12:13:14.0000000Z",
      "deviceCount": 149,
      "deploymentId": "MyDeployment"
    },
    {
      "deviceClassId": "DeviceClassId2",
      "groupId": "group1",
      "createdDateTime": "2020-07-01T12:13:14.0000000Z",
      "deviceCount": 35,
      "deploymentId": "MyDeployment2"
    }
  ]
}

Definíciók

Name	Description
DeviceClassSubgroup	Az eszközosztály alcsoportja részletei. Az eszközosztály-alcsoport az azonos eszközosztály-azonosítóval rendelkező csoportok eszközeinek egy részhalmaza.
DeviceClassSubgroupsList	A csoporton belüli eszközosztály-alcsoportok listája.
Error	Hiba részletei.
ErrorResponse	Gyakori hibaválasz.
InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

DeviceClassSubgroup

Objektum

Az eszközosztály alcsoportja részletei. Az eszközosztály-alcsoport az azonos eszközosztály-azonosítóval rendelkező csoportok eszközeinek egy részhalmaza.

Name	Típus	Description
createdDateTime	string	Az eszközosztály-alcsoport létrehozásának dátuma és időpontja.
deploymentId	string	Az eszközosztály alcsoportjának aktív üzembehelyezési azonosítója.
deviceClassId	string	Eszközosztály alcsoport-identitása. Ez a modellazonosítóból és az eszközfrissítési ügynök által jelentett kompatibilitási tulajdonságokból jön létre az IoT Hub eszközfrissítési PnP-felületén. Ez egy hexán kódolt SHA1 kivonat.
deviceCount	integer	Az eszközosztály alcsoportjában lévő eszközök száma.
groupId	string	Csoport identitása.

DeviceClassSubgroupsList

Objektum

A csoporton belüli eszközosztály-alcsoportok listája.

Name	Típus	Description
nextLink	string	Az elemek következő oldalára mutató hivatkozás.
value	DeviceClassSubgroup[]	A lapozható elemek gyűjteménye.

Error

Objektum

Hiba részletei.

Name	Típus	Description
code	string	Kiszolgáló által definiált hibakód.
details	Error[]	Hibatömb, amely a jelentett hibához vezetett.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
occurredDateTime	string (date-time)	A hiba bekövetkezésének dátuma és időpontja (UTC).
target	string	A hiba célja.

ErrorResponse

Objektum

Gyakori hibaválasz.

Name	Típus	Description
error	Error	A hiba részletei.

InnerError

Objektum

Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.

Name	Típus	Description
code	string	Pontosabb hibakód, mint amit a hiba tartalmazott.
errorDetail	string	A belső hiba vagy kivétel üzenete.
innerError	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.