Zones.GetZonesByPartyIdAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Devuelve una lista paginada de recursos de zona en una entidad determinada.
public virtual Azure.AsyncPageable<BinaryData> GetZonesByPartyIdAsync (string partyId, System.Collections.Generic.IEnumerable<string> types = default, System.Collections.Generic.IEnumerable<string> managementZoneIds = default, System.Collections.Generic.IEnumerable<string> sources = default, System.Collections.Generic.IEnumerable<string> ids = 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 GetZonesByPartyIdAsync : string * seq<string> * seq<string> * seq<string> * 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.GetZonesByPartyIdAsync : string * seq<string> * seq<string> * seq<string> * 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 GetZonesByPartyIdAsync (partyId As String, Optional types As IEnumerable(Of String) = Nothing, Optional managementZoneIds As IEnumerable(Of String) = Nothing, Optional sources As IEnumerable(Of String) = Nothing, Optional ids 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)
Parámetros
- partyId
- String
Id. de la entidad asociada.
- types
- IEnumerable<String>
Tipos de zonas.
- managementZoneIds
- IEnumerable<String>
ManagementZoneIds de las zonas.
- sources
- IEnumerable<String>
Orígenes de las zonas.
- ids
- IEnumerable<String>
Identificadores del recurso.
- names
- IEnumerable<String>
Nombres del recurso.
- propertyFilters
- IEnumerable<String>
Filtra los pares clave-valor dentro del objeto Properties. P. ej. "{testKey} eq {testValue}".
- statuses
- IEnumerable<String>
Estados del recurso.
- minCreatedDateTime
- Nullable<DateTimeOffset>
Fecha mínima de creación del recurso (inclusive).
- maxCreatedDateTime
- Nullable<DateTimeOffset>
Fecha máxima de creación del recurso (inclusive).
- minLastModifiedDateTime
- Nullable<DateTimeOffset>
Fecha mínima de última modificación del recurso (inclusive).
- maxLastModifiedDateTime
- Nullable<DateTimeOffset>
Fecha máxima de última modificación del recurso (inclusive).
Número máximo de elementos necesarios (ambos incluidos). Mínimo = 10, Máximo = 1000, Valor predeterminado = 50.
- skipToken
- String
Omita el token para obtener el siguiente conjunto de resultados.
- context
- RequestContext
Contexto de solicitud, que puede invalidar los comportamientos predeterminados de la canalización de cliente por llamada.
Devoluciones
del AsyncPageable<T> servicio que contiene una lista de BinaryData objetos. Los detalles del esquema de cuerpo de cada elemento de la colección se encuentran en la sección Comentarios siguiente.
Excepciones
partyId
es null.
partyId
es una cadena vacía y se esperaba que no estuviera vacía.
El servicio devolvió un código de estado no correcto.
Ejemplos
En este ejemplo se muestra cómo llamar a GetZonesByPartyIdAsync con los parámetros necesarios y analizar el resultado.
var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetZonesClient(<2022-11-01-preview>);
await foreach (var data in client.GetZonesByPartyIdAsync("<partyId>"))
{
JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
Console.WriteLine(result.ToString());
}
En este ejemplo se muestra cómo llamar a GetZonesByPartyIdAsync con todos los parámetros y cómo analizar el resultado.
var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetZonesClient(<2022-11-01-preview>);
await foreach (var data in client.GetZonesByPartyIdAsync("<partyId>", new String[]{"<types>"}, new String[]{"<managementZoneIds>"}, new String[]{"<sources>"}, new String[]{"<ids>"}, 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("type").ToString());
Console.WriteLine(result.GetProperty("managementZoneId").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());
}
Comentarios
A continuación se muestra el esquema JSON de un elemento de la respuesta paginable.
Cuerpo de la respuesta:
Esquema para ZoneListResponseValue
:
{
partyId: string, # Optional. Party Id associated with the Zone.
type: string, # Optional. Type of the Zone.
managementZoneId: string, # Optional. Management Zone Id associated with the Zone.
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.
}
Se aplica a
Azure SDK for .NET