ConfigurationsClient.GetAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices

アセンブリ:

Microsoft.Azure.Devices.dll

パッケージ:

Microsoft.Azure.Devices v2.0.0-preview002

オーバーロード

GetAsync(Int32, CancellationToken)	すべての IoT ハブ パーティションから、指定した数の構成を取得します。 結果は順序付けされません。
GetAsync(String, CancellationToken)	指定した構成オブジェクトを取得します。

GetAsync(Int32, CancellationToken)

すべての IoT ハブ パーティションから、指定した数の構成を取得します。 結果は順序付けされません。

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))

パラメーター

maxCount

Int32

cancellationToken

CancellationToken

戻り値

Task<IEnumerable<Configuration>>

構成の一覧。

例外

ArgumentException

値が 0 未満の場合に maxCount スローされます。

IotHubServiceException

IoT ハブが失敗した状態コードで要求に応答した場合にスローされます。 たとえば、指定された要求が調整された場合、 IotHubServiceException が ThrottlingException スローされます。 考えられるエラー ケースの完全な一覧については、「」を参照してください IotHubServiceErrorCode。

HttpRequestException

ネットワーク接続、DNS エラー、サーバー証明書の検証などの根本的な問題が原因で HTTP 要求が失敗した場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。

GetAsync(String, CancellationToken)

指定した構成オブジェクトを取得します。

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)

パラメーター

configurationId

String

取得する構成の ID。

cancellationToken

CancellationToken

操作を取り消すトークン。

戻り値

Task<Configuration>

構成オブジェクト。

例外

ArgumentNullException

指定 configurationId された が null の場合にスローされます。

ArgumentException

が空または空白の場合に configurationId スローされます。

IotHubServiceException

IoT ハブが失敗した状態コードで要求に応答した場合にスローされます。 たとえば、指定された要求が調整された場合、 IotHubServiceException が ThrottlingException スローされます。 考えられるエラー ケースの完全な一覧については、「」を参照してください IotHubServiceErrorCode。

HttpRequestException

ネットワーク接続、DNS エラー、サーバー証明書の検証などの根本的な問題が原因で HTTP 要求が失敗した場合。

OperationCanceledException

指定 cancellationToken された がキャンセルを要求した場合。