DeviceManagementClient.GetInstallableUpdatesForDeviceClasses Method

Reference

Definition

Namespace:: Azure.IoT.DeviceUpdate

Assembly:: Azure.IoT.DeviceUpdate.dll

Package:: Azure.IoT.DeviceUpdate v1.0.0

Source:: DeviceManagementClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a list of installable updates for a device class.

public virtual Azure.Pageable<BinaryData> GetInstallableUpdatesForDeviceClasses (string deviceClassId, Azure.RequestContext context = default);

abstract member GetInstallableUpdatesForDeviceClasses : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetInstallableUpdatesForDeviceClasses : string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetInstallableUpdatesForDeviceClasses (deviceClassId As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

Parameters

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

Pageable<BinaryData>

The Pageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

ArgumentNullException

deviceClassId is null.

ArgumentException

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 GetInstallableUpdatesForDeviceClasses 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);

foreach (var data in client.GetInstallableUpdatesForDeviceClasses("<deviceClassId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("updateId").GetProperty("provider").ToString());
    Console.WriteLine(result.GetProperty("updateId").GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("updateId").GetProperty("version").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("friendlyName").ToString());
}

Remarks

Below is the JSON schema for one item in the pageable response.

Response Body:

Schema for UpdateInfoListValue:

{
              updateId: {
                provider: string, # Required. Update provider.
                name: string, # Required. Update name.
                version: string, # Required. Update version.
              }, # Required. Update identifier.
              description: string, # Optional. Update description.
              friendlyName: string, # Optional. Friendly update name.
            }

Applies to

Share via