ServiceClient クラス

定義

サービスがデバイスにメッセージを送信するために使用できるメソッドが含まれています。

public class ServiceClient : IDisposable
type ServiceClient = class
    interface IDisposable
Public Class ServiceClient
Implements IDisposable
継承
ServiceClient
実装

注釈

詳細については、「https://github.com/Azure/azure-iot-sdk-csharp#iot-hub-service-sdk」を参照してください。

このクライアントは、指定された IoT ハブの HttpClient URI に関連付けられている の有効期間の長いインスタンスを作成し、プロキシ設定を構成し、接続リース タイムアウトを行います。 そのため、インスタンスは静的ではなく、このクライアントを使用するアプリケーションは、すべての用途のために作成して保存する必要があります。 作成を繰り返すと 、ソケットが枯渇する可能性があります。

コンストラクター

ServiceClient()

のインスタンス ServiceClientを作成します。これは単体テスト専用です。 CreateFromConnectionString メソッドを使用して、クライアントを使用するインスタンスを作成します。

メソッド

CloseAsync()

ServiceClient インスタンスを閉じます。 この呼び出しは AMQP 経由で行われます。

Create(String, AzureSasCredential, TransportType, ServiceClientTransportSettings, ServiceClientOptions)

呼び出し元によって提供され、必要に応じて更新された共有アクセス署名を使用して ServiceClient を作成します。

Create(String, TokenCredential, TransportType, ServiceClientTransportSettings, ServiceClientOptions)

Azure Active Directory (AAD) で ID を使用して認証する ServiceClient を作成します。

CreateFromConnectionString(String, ServiceClientOptions)

IoT ハブ接続文字列から ServiceClient を作成します。

CreateFromConnectionString(String, TransportType, ServiceClientOptions)

指定したトランスポートの種類を使用して、指定した IoT ハブ接続文字列から ServiceClient のインスタンスを作成します。

CreateFromConnectionString(String, TransportType, ServiceClientTransportSettings, ServiceClientOptions)

指定したトランスポートの種類とトランスポート設定を使用して、指定した IoT ハブ接続文字列から ServiceClient のインスタンスを作成します。

Dispose()

サービスがデバイスにメッセージを送信するために使用できるメソッドが含まれています。

Dispose(Boolean)

アンマネージド リソースを解放し、必要に応じてマネージド リソースも解放します。

GetFeedbackReceiver()

FeedbackReceiver<T> IoT ハブからデバイスまたはモジュールに送信されたメッセージの受信確認を配信できる を取得します。 この呼び出しは AMQP 経由で行われます。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-c2d#message-feedback」を参照してください。

GetFileNotificationReceiver()

ファイルアップロード操作の FileNotificationReceiver<T> 通知を配信できる を取得します。 この呼び出しは AMQP 経由で行われます。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notifications」を参照してください。

GetServiceStatisticsAsync(CancellationToken)

IoT ハブのサービス統計を取得します。 この呼び出しは HTTP 経由で行われます。

InvokeDeviceMethodAsync(String, CloudToDeviceMethod, CancellationToken)

デバイスでメソッドを対話形式で呼び出します。 cloudToDeviceMethod のタイムアウトに 15 が追加され、要求のワイヤ化にかかった時間を考慮します

InvokeDeviceMethodAsync(String, String, CloudToDeviceMethod, CancellationToken)

モジュールでメソッドを対話形式で呼び出します。

OpenAsync()

ServiceClient インスタンスを開きます。 この呼び出しは AMQP 経由で行われます。

PurgeMessageQueueAsync(String, CancellationToken)

デバイスのキューからすべてのクラウドからデバイスへのメッセージを削除します。 この呼び出しは HTTP 経由で行われます。

SendAsync(String, Message, Nullable<TimeSpan>)

指定したデバイスにクラウドからデバイスへのメッセージを送信します。 この呼び出しは AMQP 経由で行われます。

SendAsync(String, String, Message, Nullable<TimeSpan>)

指定したモジュールにクラウドからデバイスへのメッセージを送信します。

適用対象