IotHubBaseClient.SetDesiredPropertyUpdateCallbackAsync メソッド

定義

名前空間:

Microsoft.Azure.Devices.Client

アセンブリ:

Microsoft.Azure.Devices.Client.dll

パッケージ:

Microsoft.Azure.Devices.Client v2.0.0-preview002

クライアントがサービスから目的の状態更新を受信するたびに呼び出されるコールバックを設定します。 クライアント インスタンスは既に開かれている必要があります。

public System.Threading.Tasks.Task SetDesiredPropertyUpdateCallbackAsync (Func<Microsoft.Azure.Devices.Client.DesiredProperties,System.Threading.Tasks.Task> callback, System.Threading.CancellationToken cancellationToken = default);

member this.SetDesiredPropertyUpdateCallbackAsync : Func<Microsoft.Azure.Devices.Client.DesiredProperties, System.Threading.Tasks.Task> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SetDesiredPropertyUpdateCallbackAsync (callback As Func(Of DesiredProperties, Task), Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

callback

Func<DesiredProperties,Task>

目的のプロパティ更新がサービスから受信されたときに呼び出されるコールバック。

cancellationToken

CancellationToken

操作をキャンセルするキャンセル トークン。

戻り値

Task

例外

OperationCanceledException

操作が取り消されたときにスローされます。

注釈

この API を複数回呼び出すと、コールバック セットの最後に、以前に設定されたコールバックが上書きされます。 メソッド コールバックは、 を null に設定 callback することで設定を解除できます。

これには、サービスの PATCH トピックをサブスクライブする副作用があります。