DeviceDataModels.GetDeviceDataModelAsync Method

Definition

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Package:

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

Source:

DeviceDataModels.cs

Gets a device data model entity.

public virtual System.Threading.Tasks.Task<Azure.Response> GetDeviceDataModelAsync (string sensorPartnerId, string deviceDataModelId, Azure.RequestContext context = default);

abstract member GetDeviceDataModelAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDeviceDataModelAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetDeviceDataModelAsync (sensorPartnerId As String, deviceDataModelId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

sensorPartnerId

String

Id of the sensor partner.

deviceDataModelId

String

Id of the device data model resource.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

ArgumentNullException

sensorPartnerId or deviceDataModelId is null.

ArgumentException

sensorPartnerId or deviceDataModelId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetDeviceDataModelAsync with required parameters and parse the result.

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

Response response = await client.GetDeviceDataModelAsync("<sensorPartnerId>", "<deviceDataModelId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("manufacturer").ToString());
Console.WriteLine(result.GetProperty("productCode").ToString());
Console.WriteLine(result.GetProperty("ports")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("ports")[0].GetProperty("type").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());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for DeviceDataModel:

{
  type: string, # Optional. Type of device.
  manufacturer: string, # Optional. Device manufacturer.
  productCode: string, # Optional. Device productCode.
  ports: [
    {
      name: string, # Optional. Name of the port.
      type: string, # Optional. Type of port digital/analog.
    }
  ], # Optional. List of device ports supported.
  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.
}