Partager via


Sensors.GetSensors Méthode

Définition

Retourne une liste paginé de ressources de capteur.

public virtual Azure.Pageable<BinaryData> GetSensors (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 GetSensors : 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.Pageable<BinaryData>
override this.GetSensors : 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.Pageable<BinaryData>
Public Overridable Function GetSensors (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 Pageable(Of BinaryData)

Paramètres

sensorPartnerId
String

ID du partenaire de capteur associé.

sensorDataModelIds
IEnumerable<String>

ID des modèles de données de capteur.

sensorMappingIds
IEnumerable<String>

ID des mappages de capteurs.

deviceIds
IEnumerable<String>

ID des appareils.

ids
IEnumerable<String>

ID de la ressource.

names
IEnumerable<String>

Noms de la ressource.

propertyFilters
IEnumerable<String>

Filtre les paires clé-valeur au sein de 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

Ignorez le jeton pour obtenir l’ensemble de résultats suivant.

context
RequestContext

Contexte de requête, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

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

Exceptions

sensorPartnerId a la valeur null.

sensorPartnerId est une chaîne vide, et on s’attendait à ce qu’elle ne soit pas vide.

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

Exemples

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

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

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

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

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

foreach (var data in client.GetSensors("<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());
}

Remarques

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

Corps de réponse :

Schéma pour 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.
}

S’applique à