Sensors.GetSensorsAsync Método

Referência

Definição

Namespace:: Azure.Verticals.AgriFood.Farming

Assembly:: Azure.Verticals.AgriFood.Farming.dll

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

Origem:: Sensors.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Retorna uma lista paginada de recursos de sensor.

public virtual Azure.AsyncPageable<BinaryData> GetSensorsAsync (string sensorPartnerId, System.Collections.Generic.IEnumerable<string> sensorDataModelIds = default, System.Collections.Generic.IEnumerable<string> sensorMappingIds = default, System.Collections.Generic.IEnumerable<string> deviceIds = 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 GetSensorsAsync : 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.GetSensorsAsync : 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 GetSensorsAsync (sensorPartnerId As String, Optional sensorDataModelIds As IEnumerable(Of String) = Nothing, Optional sensorMappingIds As IEnumerable(Of String) = Nothing, Optional deviceIds 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

sensorPartnerId: String

ID do parceiro de sensor associado.

sensorDataModelIds: IEnumerable<String>

IDs dos modelos de dados do sensor.

sensorMappingIds: IEnumerable<String>

IDs dos mapeamentos de sensor.

deviceIds: IEnumerable<String>

IDs dos dispositivos.

ids: IEnumerable<String>

IDs do recurso.

names: IEnumerable<String>

Nomes do recurso.

propertyFilters: IEnumerable<String>

Filtra os pares chave-valor dentro do objeto Properties. ex. "{testKey} eq {testValue}".

statuses: IEnumerable<String>

Status do recurso.

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 (inclusivo). 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

AsyncPageable<BinaryData>

O AsyncPageable<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

ArgumentNullException

sensorPartnerId é nulo.

ArgumentException

sensorPartnerId é uma cadeia de caracteres vazia e era esperado que não estivesse vazio.

RequestFailedException

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

Exemplos

Este exemplo mostra como chamar GetSensorsAsync com os parâmetros necessários e analisar o resultado.

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

await foreach (var data in client.GetSensorsAsync("<sensorPartnerId>"))
{
    JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
    Console.WriteLine(result.ToString());
}

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

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

await foreach (var data in client.GetSensorsAsync("<sensorPartnerId>", new String[]{"<sensorDataModelIds>"}, new String[]{"<sensorMappingIds>"}, new String[]{"<deviceIds>"}, 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("sensorDataModelId").ToString());
    Console.WriteLine(result.GetProperty("integrationId").ToString());
    Console.WriteLine(result.GetProperty("hardwareId").ToString());
    Console.WriteLine(result.GetProperty("deviceId").ToString());
    Console.WriteLine(result.GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("location").GetProperty("latitude").ToString());
    Console.WriteLine(result.GetProperty("location").GetProperty("longitude").ToString());
    Console.WriteLine(result.GetProperty("port").GetProperty("name").ToString());
    Console.WriteLine(result.GetProperty("port").GetProperty("type").ToString());
    Console.WriteLine(result.GetProperty("depthInMeters")[0].ToString());
    Console.WriteLine(result.GetProperty("sensorPartnerId").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("status").ToString());
    Console.WriteLine(result.GetProperty("createdDateTime").ToString());
    Console.WriteLine(result.GetProperty("modifiedDateTime").ToString());
    Console.WriteLine(result.GetProperty("eTag").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());
}

Comentários

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

Corpo da resposta:

Esquema para SensorListResponseValue:

{
  sensorDataModelId: string, # Optional. Id of the associated sensor data model.
  integrationId: string, # Optional. Integration id for the device.
  hardwareId: string, # Optional. Id of the associated hardware.
  deviceId: string, # Optional. Id of the associated device.
  type: string, # Optional. Type of sensor.
  location: {
    latitude: number, # Required. Latitude of the location.
    longitude: number, # Required. Longitude of the location.
  }, # Optional. Location model class.
  port: {
    name: string, # Optional. Name of the port.
    type: string, # Optional. Type of port digital/analog.
  }, # Optional. Schema for storing port values.
  depthInMeters: [number], # Optional. Depth of each sensor measure in meters.
Like sensor moisture at 2m, 4m, 6m.
  sensorPartnerId: string, # Optional. Id of the associated sensor partner.
  id: string, # Optional. Id of the resource.
  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.
  eTag: string, # Optional. The ETag value to implement optimistic concurrency.
  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.
}

Aplica-se a

Compartilhar via