DeviceManagementClient.GetUpdateComplianceAsync(RequestContext) Method

Definition

Namespace:

Azure.IoT.DeviceUpdate

Assembly:

Azure.IoT.DeviceUpdate.dll

Package:

Azure.IoT.DeviceUpdate v1.0.0

Source:

DeviceManagementClient.cs

Gets the breakdown of how many devices are on their latest update, have new updates available, or are in progress receiving new updates.

public virtual System.Threading.Tasks.Task<Azure.Response> GetUpdateComplianceAsync (Azure.RequestContext context = default);

abstract member GetUpdateComplianceAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetUpdateComplianceAsync : Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetUpdateComplianceAsync (Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

context

RequestContext

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

Returns

Task<Response>

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

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetUpdateComplianceAsync 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 = await client.GetUpdateComplianceAsync();

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.
            }