Partager via


OAuthProviders.GetOAuthProvidersAsync Méthode

Définition

Retourne une liste paginée de ressources oauthProvider.

public virtual Azure.AsyncPageable<BinaryData> GetOAuthProvidersAsync (System.Collections.Generic.IEnumerable<string> providerIds = 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 GetOAuthProvidersAsync : 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.GetOAuthProvidersAsync : 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 GetOAuthProvidersAsync (Optional providerIds 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)

Paramètres

providerIds
IEnumerable<String>

ID de la ressource.

names
IEnumerable<String>

Noms de la ressource.

propertyFilters
IEnumerable<String>

Filtres sur les paires clé-valeur dans l’objet Properties. par exemple « {testKey} eq {testValue} ».

statuses
IEnumerable<String>

États de la ressource.

minCreatedDateTime
Nullable<DateTimeOffset>

Date de création minimale de la ressource (inclusive).

maxCreatedDateTime
Nullable<DateTimeOffset>

Date de création maximale de la ressource (inclusive).

minLastModifiedDateTime
Nullable<DateTimeOffset>

Date minimale de dernière modification de la ressource (inclusive).

maxLastModifiedDateTime
Nullable<DateTimeOffset>

Date maximale de dernière modification de la ressource (inclusive).

maxPageSize
Nullable<Int32>

Nombre maximal d’éléments nécessaires (inclus). Minimum = 10, Maximum = 1000, Valeur par défaut = 50.

skipToken
String

Ignorer le jeton pour obtenir le jeu de résultats suivant.

context
RequestContext

Contexte de la demande, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

du AsyncPageable<T> service contenant une liste d’objets BinaryData . Les détails du schéma de corps pour chaque élément de la collection sont décrits dans la section Remarques ci-dessous.

Exceptions

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler GetOAuthProvidersAsync et analyser le résultat.

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

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

Cet exemple montre comment appeler GetOAuthProvidersAsync avec tous les paramètres et comment analyser le résultat.

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

await foreach (var data in client.GetOAuthProvidersAsync(new String[]{"<providerIds>"}, 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("appId").ToString());
    Console.WriteLine(result.GetProperty("appSecret").ToString());
    Console.WriteLine(result.GetProperty("apiKey").ToString());
    Console.WriteLine(result.GetProperty("isProductionApp").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("eTag").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("modifiedDateTime").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());
}

Remarques

Voici le schéma JSON d’un élément de la réponse paginable.

Corps de réponse :

Schéma pour OAuthProviderListResponseValue:

{
  appId: string, # Optional. OAuth App Id for given OAuth Provider.
  appSecret: string, # Optional. OAuth App secret for given Provider.
Note: Won't be sent in response.
  apiKey: string, # Optional. OAuth Api key for given Provider.
Note: currently Applicable to Climate provider. Won't be sent in response.
  isProductionApp: boolean, # Optional. An optional flag to determine if the App is ready to be used for Production scenarios in the provider side or not. (Default value: false)
Note: Currently applicable for JohnDeere.
  id: string, # Optional. Unique OAuth provider ID.
  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.
  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.
}

S’applique à