Farms.GetFarmsAsync メソッド

定義

名前空間:

Azure.Verticals.AgriFood.Farming

アセンブリ:

Azure.Verticals.AgriFood.Farming.dll

パッケージ:

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

ソース:

Farms.cs

すべての関係者のファーム リソースのページ分割された一覧を返します。

public virtual Azure.AsyncPageable<BinaryData> GetFarmsAsync (System.Collections.Generic.IEnumerable<string> farmIds = default, System.Collections.Generic.IEnumerable<string> names = default, System.Collections.Generic.IEnumerable<string> propertyFilters = default, System.Collections.Generic.IEnumerable<string> statuses = default, DateTimeOffset? minCreatedDateTime = default, DateTimeOffset? maxCreatedDateTime = default, DateTimeOffset? minLastModifiedDateTime = default, DateTimeOffset? maxLastModifiedDateTime = default, int? maxPageSize = default, string skipToken = default, Azure.RequestContext context = default);

abstract member GetFarmsAsync : seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetFarmsAsync : seq<string> * seq<string> * seq<string> * seq<string> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>

Public Overridable Function GetFarmsAsync (Optional farmIds As IEnumerable(Of String) = Nothing, Optional names As IEnumerable(Of String) = Nothing, Optional propertyFilters As IEnumerable(Of String) = Nothing, Optional statuses As IEnumerable(Of String) = Nothing, Optional minCreatedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxCreatedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional minLastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxLastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional skipToken As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)

パラメーター

farmIds

IEnumerable<String>

リソースの ID。

names

IEnumerable<String>

リソースの名前。

propertyFilters

IEnumerable<String>

Properties オブジェクト内のキーと値のペアをフィルター処理します。 例: "{testKey} eq {testValue}"

statuses

IEnumerable<String>

リソースの状態。

minCreatedDateTime

Nullable<DateTimeOffset>

リソースの最小作成日 (含む)。

maxCreatedDateTime

Nullable<DateTimeOffset>

リソースの最大作成日 (含む)。

minLastModifiedDateTime

Nullable<DateTimeOffset>

リソースの最終更新日の最小値 (含む)。

maxLastModifiedDateTime

Nullable<DateTimeOffset>

リソースの最終更新日の最大値 (含む)。

maxPageSize

Nullable<Int32>

必要な項目の最大数 (含む)。 Minimum = 10、Maximum = 1000、既定値 = 50。

skipToken

String

次の結果セットを取得するためのトークンをスキップします。

context

RequestContext

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

戻り値

AsyncPageable<BinaryData>

AsyncPageable<T>オブジェクトの一覧を含むサービスの BinaryData 。 コレクション内の各項目の本文スキーマの詳細については、以下の「解説」セクションを参照してください。

例外

RequestFailedException

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

例

このサンプルでは、GetFarmsAsync を呼び出して結果を解析する方法を示します。

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

await foreach (var data in client.GetFarmsAsync())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

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

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

await foreach (var data in client.GetFarmsAsync(new String[]{"<farmIds>"}, new String[]{"<names>"}, new String[]{"<propertyFilters>"}, new String[]{"<statuses>"}, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, DateTimeOffset.UtcNow, 1234, "<skipToken>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("partyId").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
    Console.WriteLine(result.GetProperty("status").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("modifiedDateTime").ToString());
    Console.WriteLine(result.GetProperty("source").ToString());
    Console.WriteLine(result.GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("description").ToString());
    Console.WriteLine(result.GetProperty("createdBy").ToString());
    Console.WriteLine(result.GetProperty("modifiedBy").ToString());
    Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString());
}

注釈

ページング可能な応答の 1 つの項目の JSON スキーマを次に示します。

応答本文:

の FarmListResponseValueスキーマ:

{
  partyId: string, # Optional. Party Id.
  id: string, # Optional. Unique resource ID.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  status: string, # Optional. Status of the resource.
  createdDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
  modifiedDateTime: string (ISO 8601 Format), # Optional. Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
  source: string, # Optional. Source of the resource.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and only string,
numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}