ConfigurationsClient.GetAsync Method

Definition

Namespace:

Microsoft.Azure.Devices

Assembly:

Microsoft.Azure.Devices.dll

Package:

Microsoft.Azure.Devices v2.0.0-preview002

Overloads

GetAsync(Int32, CancellationToken)	Retrieves specified number of configuration from every IoT hub partition. Results are not ordered.
GetAsync(String, CancellationToken)	Retrieves the specified configuration object.

GetAsync(Int32, CancellationToken)

Retrieves specified number of configuration from every IoT hub partition. Results are not ordered.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Devices.Configuration>> GetAsync (int maxCount, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Devices.Configuration>>
override this.GetAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Devices.Configuration>>

Public Overridable Function GetAsync (maxCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of Configuration))

Parameters

maxCount

Int32

cancellationToken

CancellationToken

Returns

Task<IEnumerable<Configuration>>

The list of configuration.

Exceptions

ArgumentException

Thrown if the maxCount value less than zero.

IotHubServiceException

Thrown if IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellationToken has requested cancellation.

GetAsync(String, CancellationToken)

Retrieves the specified configuration object.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration> GetAsync (string configurationId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration>

Public Overridable Function GetAsync (configurationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Configuration)

Parameters

configurationId

String

The id of the configuration being retrieved.

cancellationToken

CancellationToken

The token which allows the operation to be canceled.

Returns

Task<Configuration>

The configuration object.

Exceptions

ArgumentNullException

Thrown when the provided configurationId is null.

ArgumentException

Thrown if the configurationId is empty or whitespace.

IotHubServiceException

Thrown if IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

HttpRequestException

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

OperationCanceledException

If the provided cancellationToken has requested cancellation.