DigitalTwinsClient.PublishComponentTelemetryAsync メソッド

  • リファレンス

定義

名前空間:
Azure.DigitalTwins.Core
アセンブリ:
Azure.DigitalTwins.Core.dll
パッケージ:
Azure.DigitalTwins.Core v1.4.0
Source:
DigitalTwinsClient.cs

デジタル ツインのコンポーネントからテレメトリを非同期的に発行します。 結果は、 で定義 DigitalTwinsEventRouteされた 1 つまたは複数の宛先エンドポイント (サブスクライバー) によって使用されます。 テレメトリ メッセージを使用するには、テレメトリ メッセージを発行する前に、これらのイベント ルートを設定する必要があります。

public virtual System.Threading.Tasks.Task<Azure.Response> PublishComponentTelemetryAsync (string digitalTwinId, string componentName, string messageId, string payload, DateTimeOffset? timestamp = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PublishComponentTelemetryAsync : string * string * string * string * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.PublishComponentTelemetryAsync : string * string * string * string * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function PublishComponentTelemetryAsync (digitalTwinId As String, componentName As String, messageId As String, payload As String, Optional timestamp As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

パラメーター

digitalTwinId
String

デジタル ツインの ID。

componentName
String

DTDL コンポーネントの名前。

messageId
String

メッセージの重複除去に一般的に使用される一意のメッセージ識別子 (デジタル ツイン ID のスコープ内)。 引数が null の場合、既定値はランダム GUID です。

payload
String

送信されるアプリケーション/json テレメトリ ペイロード。

timestamp
Nullable<DateTimeOffset>

テレメトリが測定された時刻を識別する RFC 3339 タイムスタンプ。 既定値は現在の日付/時刻 UTC です。

cancellationToken
CancellationToken

キャンセル トークン。

戻り値

Task<Response>

HTTP 応答 Response。

例外

RequestFailedException

サービスからのエラーをキャプチャする例外。 詳細については、 ErrorCode プロパティと Status プロパティを確認してください。

ArgumentNullException

または componentNamepayload が の場合digitalTwinId、例外がnullスローされます。

例

// construct your json telemetry payload by serializing a dictionary.
var telemetryPayload = new Dictionary<string, int>
{
    { "ComponentTelemetry1", 9 }
};
await client.PublishComponentTelemetryAsync(
    twinId,
    "Component1",
    Guid.NewGuid().ToString(),
    JsonSerializer.Serialize(telemetryPayload));
Console.WriteLine($"Published component telemetry message to twin '{twinId}'.");

注釈

その他のサンプルについては、 リポジトリのサンプルを参照してください。

適用対象

こちらもご覧ください