DeviceUpdateClient.GetFilesAsync 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 file identifiers for the specified version.

public virtual Azure.AsyncPageable<BinaryData> GetFilesAsync (string provider, string name, string version, Azure.RequestContext context = default);

abstract member GetFilesAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetFilesAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetFilesAsync (provider As String, name As String, version As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

provider

String

Update provider.

name

String

Update name.

version

String

Update version.

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

ArgumentNullException

provider, name or version is null.

ArgumentException

provider, name or version 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 GetFilesAsync with required parameters 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.GetFilesAsync("<provider>", "<name>", "<version>"))
{
    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)
              }
            }