Device Management - List Device Class Subgroups For Group

Dienst:

Device Update

API-Version:

2022-10-01

Rufen Sie die Geräteklassenuntergruppen für die Gruppe ab. Eine Untergruppe der Geräteklasse ist die Gruppe von Geräten innerhalb der Gruppe, die dieselbe Geräteklasse verwenden. Alle Geräte innerhalb derselben Geräteklasse sind mit den gleichen Updates kompatibel.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (url)	Geräteupdate für IoT Hub-Kontoendpunkt (nur Hostname, kein Protokoll).
groupId	path	True	string	Gruppenbezeichner.
instanceId	path	True	string	Der Geräteupdate für IoT Hub-Kontoinstanzbezeichner.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.
filter	query		string	Schränkt die zurückgegebenen Untergruppen der Geräteklasse ein. Sie können nach Compat-Eigenschaften nach Name und Wert filtern. (d. h. filter=compatProperties/propertyName1 eq 'value1' and compatProperties/propertyName2 eq 'value2')

Antworten

Name	Typ	Beschreibung
200 OK	DeviceClassSubgroupsList	Details zur Untergruppe der Geräteklasse.
Other Status Codes	ErrorResponse	Standardantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://api.adu.microsoft.com/.default	Standardautorisierungsbereich.

Beispiele

DeviceManagement_ListDeviceClassSubgroupsForGroup

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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"
    }
  ]
}

Definitionen

Name	Beschreibung
DeviceClassSubgroup	Details zur Untergruppe der Geräteklasse. Eine Geräteklassenuntergruppe ist eine Teilmenge von Geräten in einer Gruppe, die dieselbe Geräteklassen-ID gemeinsam verwenden.
DeviceClassSubgroupsList	Die Liste der Geräteklassenuntergruppen innerhalb einer Gruppe.
Error	Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort.
InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

DeviceClassSubgroup

Objekt

Details zur Untergruppe der Geräteklasse. Eine Geräteklassenuntergruppe ist eine Teilmenge von Geräten in einer Gruppe, die dieselbe Geräteklassen-ID gemeinsam verwenden.

Name	Typ	Beschreibung
createdDateTime	string	Datum und Uhrzeit der Erstellung der Untergruppe der Geräteklasse.
deploymentId	string	Die aktive Bereitstellungs-ID für die Untergruppe der Geräteklasse.
deviceClassId	string	Geräteklassenuntergruppenidentität. Dies wird aus der Modell-ID und den compat-Eigenschaften generiert, die vom Geräteupdate-Agent in der Device Update PnP-Schnittstelle im IoT Hub gemeldet werden. Es handelt sich um einen hexcodierten SHA1-Hash.
deviceCount	integer	Die Anzahl der Geräte in der Untergruppe der Geräteklasse.
groupId	string	Gruppenidentität.

DeviceClassSubgroupsList

Objekt

Die Liste der Geräteklassenuntergruppen innerhalb einer Gruppe.

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite von Elementen.
value	DeviceClassSubgroup[]	Die Sammlung der ausgelagerten Elemente.

Error

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Serverdefinierter Fehlercode.
details	Error[]	Ein Array von Fehlern, die zu dem gemeldeten Fehler geführt haben.
innererror	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
occurredDateTime	string (date-time)	Datum und Uhrzeit in UTC, wenn der Fehler aufgetreten ist.
target	string	Das Ziel des Fehlers.

ErrorResponse

Objekt

Häufige Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Die Fehlerdetails.

InnerError

Objekt

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als das, was vom enthaltenden Fehler bereitgestellt wurde.
errorDetail	string	Die interne Fehlermeldung oder Ausnahmemeldung.
innerError	InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.