DeviceClient クラス

定義

名前空間:

Microsoft.Azure.Devices.Client

アセンブリ:

Microsoft.Azure.Devices.Client.dll, Microsoft.Azure.Devices.Client.PCL.dll

パッケージ:

Microsoft.Azure.Devices.Client v1.41.2, Microsoft.Azure.Devices.Client.PCL v1.0.16

デバイスがサービスとの間でメッセージを送受信するために使用できるメソッドを含みます。

public class DeviceClient : IDisposable

type DeviceClient = class
    interface IDisposable

Public Class DeviceClient
Implements IDisposable

継承

Object

DeviceClient

フィールド

DefaultOperationTimeoutInMilliseconds

既定の操作のタイムアウト。

プロパティ

DiagnosticSamplingPercentage	診断サンプリングのパーセンテージ値[0-100];0 は、メッセージが診断情報を引き継がないことを意味します
OperationTimeoutInMilliseconds	操作の再試行で使用されるタイムアウトを格納します。 キャンセル トークンが指定されている操作では、この値は無視されることに注意してください。 たとえば、 SendEventAsync(Message) はこのタイムアウトを使用しますが SendEventAsync(Message, CancellationToken) 、使用しません。 後者の操作は、指定されたキャンセル トークンによってのみ取り消されます。
ProductInfo	IoT ハブに送信されるユーザー エージェント文字列に追加されるカスタム製品情報を格納します。
RetryPolicy	古い. 操作の再試行で使用される再試行戦略を格納します。

メソッド

AbandonAsync(Message)	受信したメッセージをデバイス キューに戻します。
AbandonAsync(Message, CancellationToken)	受信したメッセージをデバイス キューに戻します。
AbandonAsync(String)	受信したメッセージをデバイス キューに戻します。
AbandonAsync(String, CancellationToken)	受信したメッセージをデバイス キューに戻します。
CloseAsync()	DeviceClient インスタンスを閉じます。
CloseAsync(CancellationToken)	DeviceClient インスタンスを閉じます。
CompleteAsync(Message)	受信したメッセージをデバイス キューから削除します。
CompleteAsync(Message, CancellationToken)	受信したメッセージをデバイス キューから削除します。
CompleteAsync(String)	受信したメッセージをデバイス キューから削除します。
CompleteAsync(String, CancellationToken)	受信したメッセージをデバイス キューから削除します。
CompleteFileUploadAsync(FileUploadCompletionNotification, CancellationToken)	デバイスのファイルのアップロードが完了したことを IoT ハブに通知します。 詳細については 、こちらのドキュメントを参照してください。
Create(String, IAuthenticationMethod)	指定したパラメーターから使い捨て可能な Amqp DeviceClient を作成します
Create(String, IAuthenticationMethod, ClientOptions)	AMQP トランスポート プロトコルを使用する、指定したパラメーターから破棄可能な DeviceClient を作成します。
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	指定したパラメーターから破棄可能な DeviceClient を作成します
Create(String, IAuthenticationMethod, TransportType)	指定したパラメーターから破棄可能な DeviceClient を作成します
Create(String, IAuthenticationMethod, TransportType, ClientOptions)	指定したパラメーターから破棄可能な DeviceClient を作成します
Create(String, String, IAuthenticationMethod, ClientOptions)	指定したパラメーターから破棄可能な AMQP DeviceClient を作成する
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	指定したパラメーターから破棄可能な DeviceClient を作成します
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)	指定したパラメーターから破棄可能な DeviceClient を作成する
CreateFromConnectionString(String)	指定した接続文字列から Amqp トランスポートを使用して破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, ClientOptions)	指定した接続文字列から AMQP トランスポートを使用して破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)	トランスポートの優先順位付けされた一覧を使用して、指定した接続文字列から破棄可能な DeviceClient を作成する
CreateFromConnectionString(String, String)	指定した接続文字列から Amqp トランスポートを使用して破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, String, ClientOptions)	指定した接続文字列から AMQP トランスポートを使用して破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, String, ITransportSettings[], ClientOptions)	トランスポートの優先順位付けされた一覧を使用して、指定した接続文字列から破棄可能な DeviceClient を作成します。
CreateFromConnectionString(String, String, TransportType)	指定したトランスポートの種類を使用して、指定した接続文字列から破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, String, TransportType, ClientOptions)	指定したトランスポートの種類を使用して、指定した接続文字列から破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, TransportType)	指定したトランスポートの種類を使用して、指定した接続文字列から破棄可能な DeviceClient を作成します
CreateFromConnectionString(String, TransportType, ClientOptions)	指定したトランスポートの種類を使用して、指定した接続文字列から破棄可能な DeviceClient を作成します
Dispose()	DeviceClient によって使用されるアンマネージド リソースを解放し、必要に応じてマネージド リソースを破棄します。
Dispose(Boolean)	DeviceClient によって使用されるアンマネージド リソースを解放し、派生クラスがカスタム実装をオーバーライドして提供できるようにします。
GetFileUploadSasUriAsync(FileUploadSasUriRequest, CancellationToken)	Azure Storage SDK でこのデバイスの BLOB にファイルをアップロードするために使用できるファイル アップロード SAS URI を取得する 詳細については 、こちらのドキュメントを参照してください。
GetTwinAsync()	現在のデバイスのデバイス ツイン プロパティを取得します。 完全なデバイス ツイン オブジェクトについては、Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId) を使用します。
GetTwinAsync(CancellationToken)	現在のデバイスのデバイス ツイン プロパティを取得します。 完全なデバイス ツイン オブジェクトについては、Microsoft.Azure.Devices.RegistryManager.GetTwinAsync(string deviceId) を使用します。
OpenAsync()	DeviceClient インスタンスを明示的に開きます。
OpenAsync(CancellationToken)	DeviceClient インスタンスを明示的に開きます。
ReceiveAsync()	既定のタイムアウトを使用して、デバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message)をAbandonAsync(Message)呼び出CompleteAsync(Message)し、メッセージを破棄する必要があります。
ReceiveAsync(CancellationToken)	キャンセル トークンを使用して、デバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。
ReceiveAsync(TimeSpan)	タイムアウトを使用してデバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。
RejectAsync(Message)	受信したメッセージをデバイス キューから削除し、メッセージを処理できなかったことをサーバーに示します。
RejectAsync(Message, CancellationToken)	受信したメッセージをデバイス キューから削除し、メッセージを処理できなかったことをサーバーに示します。
RejectAsync(String)	受信したメッセージをデバイス キューから削除し、メッセージを処理できなかったことをサーバーに示します。
RejectAsync(String, CancellationToken)	受信したメッセージをデバイス キューから削除し、メッセージを処理できなかったことをサーバーに示します。
SendEventAsync(Message)	ハブにイベントを送信する
SendEventAsync(Message, CancellationToken)	ハブにイベントを送信する
SendEventBatchAsync(IEnumerable<Message>)	イベントのバッチを IoT ハブに送信します。 真のバッチ操作には AMQP または HTTP を使用します。 MQTT はメッセージを 1 つずつ送信するだけです。
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)	イベントのバッチを IoT ハブに送信します。 真のバッチ操作には AMQP または HTTP を使用します。 MQTT はメッセージを 1 つずつ送信するだけです。
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)	接続状態変更コールバックの新しいデリゲートを設定します。 デリゲートが既に関連付けられている場合は、新しいデリゲートに置き換えられます。 クライアントが HTTP を使用するように構成されている場合、そのプロトコルはステートレスであるため、このコールバックは呼び出されません。
SetDesiredPropertyUpdateCallback(DesiredPropertyUpdateCallback, Object)	古い. クライアントがサービスから状態更新 (必要または報告) を受信するたびに呼び出されるコールバックを設定します。 これには、サービスの PATCH トピックをサブスクライブする副作用があります。
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	クライアントがサービスから状態更新 (必要または報告) を受信するたびに呼び出されるコールバックを設定します。 コールバック値を null に設定してクリアします。
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	クライアントがサービスから状態更新 (必要または報告) を受信するたびに呼び出されるコールバックを設定します。 コールバック値を null に設定してクリアします。
SetMethodDefaultHandlerAsync(MethodCallback, Object)	名前に登録されたデリゲートがないメソッドに対して呼び出される新しいデリゲートを設定します。 既定のデリゲートが既に登録されている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことによって設定を解除できます。
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)	名前に登録されたデリゲートがないメソッドに対して呼び出される新しいデリゲートを設定します。 既定のデリゲートが既に登録されている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことによって設定を解除できます。
SetMethodHandler(String, MethodCallback, Object)	古い. 名前付きメソッドの新しいデリゲートを設定します。 デリゲートが既に名前付きメソッドに関連付けられている場合は、新しいデリゲートに置き換えられます。
SetMethodHandlerAsync(String, MethodCallback, Object)	名前付きメソッドの新しいデリゲートを設定します。 デリゲートが既に名前付きメソッドに関連付けられている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことによって設定を解除できます。
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)	名前付きメソッドの新しいデリゲートを設定します。 デリゲートが既に名前付きメソッドに関連付けられている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことによって設定を解除できます。
SetReceiveMessageHandlerAsync(ReceiveMessageCallback, Object, CancellationToken)	キャンセル トークンを使用してデバイス キューからメッセージを受信するための新しいデリゲートを設定します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。 null デリゲートが渡された場合、サービスからのメッセージの受信時にトリガーされるコールバックが無効になります。
SetRetryPolicy(IRetryPolicy)	操作の再試行で使用される再試行ポリシーを設定します。 変更は、進行中の操作の後に有効になります。
UpdateReportedPropertiesAsync(TwinCollection)	報告されたプロパティの変更をサービスにプッシュします。
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)	報告されたプロパティの変更をサービスにプッシュします。
UploadToBlobAsync(String, Stream)	古い. そのデバイスの IoTHub に関連付けられているストレージ アカウント内のブロック BLOB にストリームをアップロードします。 BLOB が既に存在する場合は、上書きされます。
UploadToBlobAsync(String, Stream, CancellationToken)	古い. そのデバイスの IoTHub に関連付けられているストレージ アカウント内のブロック BLOB にストリームをアップロードします。 BLOB が既に存在する場合は、上書きされます。