Partager via


Boundaries.GetBoundariesAsync Méthode

Définition

Retourne une liste paginée de ressources de limites entre toutes les parties.

public virtual Azure.AsyncPageable<BinaryData> GetBoundariesAsync (string parentType = default, string type = default, System.Collections.Generic.IEnumerable<string> parentIds = default, double? minArea = default, double? maxArea = default, System.Collections.Generic.IEnumerable<string> boundaryIds = 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 GetBoundariesAsync : string * string * seq<string> * Nullable<double> * Nullable<double> * 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.GetBoundariesAsync : string * string * seq<string> * Nullable<double> * Nullable<double> * 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 GetBoundariesAsync (Optional parentType As String = Nothing, Optional type As String = Nothing, Optional parentIds As IEnumerable(Of String) = Nothing, Optional minArea As Nullable(Of Double) = Nothing, Optional maxArea As Nullable(Of Double) = Nothing, Optional boundaryIds 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

parentType
String

Type du parent auquel il appartient.

type
String

Type auquel il appartient.

parentIds
IEnumerable<String>

ID parent de la ressource.

minArea
Nullable<Double>

Zone minimale de la limite (inclusive).

maxArea
Nullable<Double>

Superficie maximale de la limite (inclusive).

boundaryIds
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 GetBoundariesAsync et analyser le résultat.

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

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

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

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

await foreach (var data in client.GetBoundariesAsync("<parentType>", "<type>", new String[]{"<parentIds>"}, 1234, 1234, new String[]{"<boundaryIds>"}, 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("parentId").ToString());
    Console.WriteLine(result.GetProperty("area").GetProperty("unit").ToString());
    Console.WriteLine(result.GetProperty("area").GetProperty("value").ToString());
    Console.WriteLine(result.GetProperty("parentType").ToString());
    Console.WriteLine(result.GetProperty("type").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());
}

Remarques

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

Corps de réponse :

Schéma pour BoundaryMetadataListResponseValue:

{
  partyId: string, # Optional. Party Id.
  parentId: string, # Optional. Id of the parent it belongs to.
  area: {
    unit: string, # Optional. Data unit.
    value: number, # Optional. Data value.
  }, # Optional. Schema for storing measurement reading and unit.
  parentType: "Field" | "SeasonalField" | "Zone" | "Prescription" | "PlantTissueAnalysis" | "ApplicationData" | "PlantingData" | "TillageData" | "HarvestData", # Optional. Type of the parent it belongs to.
  type: string, # Optional. Type it belongs to.
  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.
}

S’applique à