DeviceUpdateClient.GetProvidersAsync(RequestContext) Method

Definition

Namespace:

Azure.IoT.DeviceUpdate

Assembly:

Azure.IoT.DeviceUpdate.dll

Package:

Azure.IoT.DeviceUpdate v1.0.0

Source:

DeviceUpdateClient.cs

Get a list of all update providers that have been imported to Device Update for IoT Hub.

public virtual Azure.AsyncPageable<BinaryData> GetProvidersAsync (Azure.RequestContext context = default);

abstract member GetProvidersAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetProvidersAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetProvidersAsync (Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

context

RequestContext

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

Returns

AsyncPageable<BinaryData>

The AsyncPageable<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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetProvidersAsync and parse the result.

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

await foreach (var data in client.GetProvidersAsync())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

Remarks

Schema for Response Body:

{
              value: [string],
              nextLink: string
            }

Schema for Response Error:

{
              error: {
                code: string,
                message: string,
                target: string,
                details: [Error],
                innererror: {
                  code: string,
                  message: string,
                  errorDetail: string,
                  innerError: InnerError
                },
                occurredDateTime: string (ISO 8601 Format)
              }
            }