DeviceUpdateClient.GetNames(String, 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 names that match the specified provider.

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

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

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

Parameters

provider

String

Update provider.

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

provider is null.

ArgumentException

provider 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 GetNames 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);

foreach (var data in client.GetNames("<provider>"))
{
    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)
              }
            }