Język

DeviceUpdateClient.GetVersionsAsync Method

Definition

Namespace:
Azure.IoT.DeviceUpdate
Assembly:
Azure.IoT.DeviceUpdate.dll
Package:
Azure.IoT.DeviceUpdate v1.1.0
Source:
DeviceUpdateClient.cs

[Protocol Method] Get a list of all update versions that match the specified provider and name.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. 
public virtual Azure.AsyncPageable<BinaryData> GetVersionsAsync(string provider, string name, string filter = default, Azure.RequestContext context = default);
abstract member GetVersionsAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetVersionsAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
Public Overridable Function GetVersionsAsync (provider As String, name As String, Optional filter As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

Parameters

provider
String

Update provider.

name
String

Update name.

filter
String

Optional to filter updates by isDeployable property.

context
RequestContext

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

Returns

AsyncPageable<BinaryData>

The response returned from the service.

Exceptions

ArgumentNullException

provider or name is null.

ArgumentException

provider or name 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 GetVersionsAsync 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.GetVersionsAsync("<provider>", "<name>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetVersionsAsync with all parameters, and how to 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.GetVersionsAsync("<provider>", "<name>", "<filter>"))
{
    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)
              }
            }

Applies to