FarmerOAuthTokens.GetAuthenticatedFarmersDetails メソッド

定義

名前空間:

Azure.Verticals.AgriFood.Farming

アセンブリ:

Azure.Verticals.AgriFood.Farming.dll

パッケージ:

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

ソース:

FarmerOAuthTokens.cs

OAuthToken ドキュメントの一覧を返します。

public virtual Azure.Pageable<BinaryData> GetAuthenticatedFarmersDetails (System.Collections.Generic.IEnumerable<string> authProviderIds = default, System.Collections.Generic.IEnumerable<string> partyIds = default, bool? isValid = 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 GetAuthenticatedFarmersDetails : seq<string> * seq<string> * Nullable<bool> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAuthenticatedFarmersDetails : seq<string> * seq<string> * Nullable<bool> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetAuthenticatedFarmersDetails (Optional authProviderIds As IEnumerable(Of String) = Nothing, Optional partyIds As IEnumerable(Of String) = Nothing, Optional isValid As Nullable(Of Boolean) = 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 Pageable(Of BinaryData)

パラメーター

authProviderIds

IEnumerable<String>

AuthProvider の名前。

partyIds

IEnumerable<String>

パーティの一覧。

isValid

Nullable<Boolean>

トークン オブジェクトが有効な場合。

minCreatedDateTime

Nullable<DateTimeOffset>

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

maxCreatedDateTime

Nullable<DateTimeOffset>

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

minLastModifiedDateTime

Nullable<DateTimeOffset>

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

maxLastModifiedDateTime

Nullable<DateTimeOffset>

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

maxPageSize

Nullable<Int32>

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

skipToken

String

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

context

RequestContext

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

戻り値

Pageable<BinaryData>

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

例外

RequestFailedException

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

例

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

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

foreach (var data in client.GetAuthenticatedFarmersDetails())
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("partyId").ToString());
    Console.WriteLine(result.GetProperty("authProviderId").ToString());
}

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

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

foreach (var data in client.GetAuthenticatedFarmersDetails(new String[]{"<authProviderIds>"}, new String[]{"<partyIds>"}, true, 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("authProviderId").ToString());
    Console.WriteLine(result.GetProperty("isValid").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("modifiedDateTime").ToString());
}

注釈

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

応答本文:

の OAuthTokenListResponseValueスキーマ:

{
  partyId: string, # Required. Party ID for this OAuth config.
  authProviderId: string, # Required. ID of the OAuth provider resource containing app information.
  isValid: boolean, # Optional. An optional flag indicating whether the token is a valid or expired (Default value: true).
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  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.
}