ConfigurationsClient.GetAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
The list of configuration.
Exceptions
Thrown if the maxCount value less than zero.
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.
If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.
If the provided cancellationToken has requested cancellation.
Applies to
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
The configuration object.
Exceptions
Thrown when the provided configurationId is null.
Thrown if the configurationId is empty or whitespace.
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.
If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.
If the provided cancellationToken has requested cancellation.
