FarmerOAuthTokens.GetAuthenticatedFarmersDetails Método

Definição

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Pacote:

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

Origem:

FarmerOAuthTokens.cs

Retorna uma lista de documentos 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)

Parâmetros

authProviderIds

IEnumerable<String>

Nome de AuthProvider.

partyIds

IEnumerable<String>

Lista de partes.

isValid

Nullable<Boolean>

Se o objeto de token for válido.

minCreatedDateTime

Nullable<DateTimeOffset>

Data mínima de criação do recurso (inclusive).

maxCreatedDateTime

Nullable<DateTimeOffset>

Data máxima de criação do recurso (inclusive).

minLastModifiedDateTime

Nullable<DateTimeOffset>

Data mínima da última modificação do recurso (inclusive).

maxLastModifiedDateTime

Nullable<DateTimeOffset>

Data máxima da última modificação do recurso (inclusive).

maxPageSize

Nullable<Int32>

Número máximo de itens necessários (inclusive). Mínimo = 10, Máximo = 1000, Valor padrão = 50.

skipToken

String

Ignore o token para obter o próximo conjunto de resultados.

context

RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Pageable<BinaryData>

O Pageable<T> do serviço que contém uma lista de BinaryData objetos. Os detalhes do esquema do corpo de cada item na coleção estão na seção Comentários abaixo.

Exceções

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar GetAuthenticatedFarmersDetails e analisar o resultado.

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());
}

Este exemplo mostra como chamar GetAuthenticatedFarmersDetails com todos os parâmetros e como analisar o resultado.

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());
}

Comentários

Abaixo está o esquema JSON de um item na resposta paginável.

Corpo da resposta:

Esquema para 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.
}