DeviceManagementClient.GetDeviceClassSubgroup Method

Definition

Namespace:

Azure.IoT.DeviceUpdate

Assembly:

Azure.IoT.DeviceUpdate.dll

Package:

Azure.IoT.DeviceUpdate v1.0.0

Source:

DeviceManagementClient.cs

Gets device class subgroup details. A device class subgroup is the set of devices within the group that share the same device class. All devices within the same device class are compatible with the same updates.

public virtual Azure.Response GetDeviceClassSubgroup (string groupId, string deviceClassId, Azure.RequestContext context = default);

abstract member GetDeviceClassSubgroup : string * string * Azure.RequestContext -> Azure.Response
override this.GetDeviceClassSubgroup : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetDeviceClassSubgroup (groupId As String, deviceClassId As String, Optional context As RequestContext = Nothing) As Response

Parameters

groupId

String

Group identifier.

deviceClassId

String

Device class identifier.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

ArgumentNullException

groupId or deviceClassId is null.

ArgumentException

groupId or deviceClassId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetDeviceClassSubgroup with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new DeviceManagementClient(endpoint, "<instanceId>", credential);

Response response = client.GetDeviceClassSubgroup("<groupId>", "<deviceClassId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("deviceClassId").ToString());
Console.WriteLine(result.GetProperty("groupId").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("deviceCount").ToString());
Console.WriteLine(result.GetProperty("deploymentId").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for DeviceClassSubgroup:

{
              deviceClassId: string, # Required. Device class subgroup identity. This is generated from the model Id and the compat properties reported by the device update agent in the Device Update PnP interface in IoT Hub. It is a hex-encoded SHA1 hash.
              groupId: string, # Required. Group identity.
              createdDateTime: string, # Required. Date and time when the device class subgroup was created.
              deviceCount: number, # Optional. The number of devices in the device class subgroup.
              deploymentId: string, # Optional. The active deployment Id for the device class subgroup.
            }