SensorEvents.GetSensorEventsAsync メソッド

定義

名前空間:

Azure.Verticals.AgriFood.Farming

アセンブリ:

Azure.Verticals.AgriFood.Farming.dll

パッケージ:

Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

ソース:

SensorEvents.cs

センサー イベント データの一覧を返します。 クエリの期間は、一度に 90 日に制限されます。 startDateTime と endDateTime が指定されていない場合、過去 90 日間のイベントを返します。

public virtual System.Threading.Tasks.Task<Azure.Response> GetSensorEventsAsync (string sensorId, string sensorPartnerId, DateTimeOffset? startDateTime = default, DateTimeOffset? endDateTime = default, bool? excludeDuplicateEvents = default, Azure.RequestContext context = default);

abstract member GetSensorEventsAsync : string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSensorEventsAsync : string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetSensorEventsAsync (sensorId As String, sensorPartnerId As String, Optional startDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional endDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional excludeDuplicateEvents As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

パラメーター

sensorId

String

関連付けられているセンサーの ID。

sensorPartnerId

String

関連付けられているセンサー パートナーの ID。

startDateTime

Nullable<DateTimeOffset>

センサー イベントの検索スパン開始時刻 (含む)、サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 分数が指定されている場合は、最大秒単位で切り捨てられます。

endDateTime

Nullable<DateTimeOffset>

センサー イベントの検索スパン終了時刻 (含む)、サンプル形式: yyyy-MM-ddTHH:mm:ssZ。 分数が指定されている場合は、最大秒単位で切り捨てられます。

excludeDuplicateEvents

Nullable<Boolean>

重複するイベントを除外し、最新のイベントのみを受け取るようにフラグを設定します (既定値: true)。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Task<Response>

サービスから返された応答。 応答本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

ArgumentNullException

sensorId または sensorPartnerId が null です。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して GetSensorEventsAsync を呼び出し、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetSensorEventsClient(<2022-11-01-preview>);

Response response = await client.GetSensorEventsAsync("<sensorId>", "<sensorPartnerId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("value")[0].ToString());

このサンプルでは、すべてのパラメーターを使用して GetSensorEventsAsync を呼び出す方法と、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetSensorEventsClient(<2022-11-01-preview>);

Response response = await client.GetSensorEventsAsync("<sensorId>", "<sensorPartnerId>", DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, true);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("value")[0].GetProperty("sensorId").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("sensorPartnerId").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("boundaryId").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("eventDateTime").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("ingestionDateTime").ToString());
Console.WriteLine(result.GetProperty("value")[0].GetProperty("measures").GetProperty("<test>").ToString());
Console.WriteLine(result.GetProperty("skipToken").ToString());
Console.WriteLine(result.GetProperty("nextLink").ToString());

注釈

応答ペイロードの JSON スキーマを次に示します。

応答本文:

の SensorEventListResponseスキーマ:

{
  value: [
    {
      sensorId: string, # Optional. Id of the sensor.
      sensorPartnerId: string, # Optional. Id of the sensor partner.
      partyId: string, # Optional. Id of the associated party.
      boundaryId: string, # Optional. Id of the associated boundary.
      eventDateTime: string (ISO 8601 Format), # Optional. DateTime of sensor event observation.
      ingestionDateTime: string (ISO 8601 Format), # Optional. DateTime of sensor event ingestion to data store.
      measures: Dictionary<string, any>, # Optional. Sensor measures.
    }
  ], # Required. List of requested objects.
  skipToken: string, # Optional. Token used in retrieving the next page. If null, there are no additional pages.
  nextLink: string, # Optional. Continuation link (absolute URI) to the next page of results in the list.
}