DeviceManagementClient.GetUpdateComplianceForGroup Method

Definition

Namespace:

Azure.IoT.DeviceUpdate

Assembly:

Azure.IoT.DeviceUpdate.dll

Package:

Azure.IoT.DeviceUpdate v1.0.0

Source:

DeviceManagementClient.cs

Get device group update compliance information such as how many devices are on their latest update, how many need new updates, and how many are in progress on receiving a new update.

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

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

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

Parameters

groupId

String

Group 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 is null.

ArgumentException

groupId 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 GetUpdateComplianceForGroup 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.GetUpdateComplianceForGroup("<groupId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("totalDeviceCount").ToString());
Console.WriteLine(result.GetProperty("onLatestUpdateDeviceCount").ToString());
Console.WriteLine(result.GetProperty("newUpdatesAvailableDeviceCount").ToString());
Console.WriteLine(result.GetProperty("updatesInProgressDeviceCount").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for UpdateCompliance:

{
              totalDeviceCount: number, # Required. Total number of devices.
              onLatestUpdateDeviceCount: number, # Required. Number of devices on the latest update.
              newUpdatesAvailableDeviceCount: number, # Required. Number of devices with a newer update available.
              updatesInProgressDeviceCount: number, # Required. Number of devices with update in-progress.
            }