CropProducts.GetCropProduct(String, RequestContext) Method

Definition

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Package:

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

Source:

CropProducts.cs

Gets a specified crop Product resource.

public virtual Azure.Response GetCropProduct (string cropProductId, Azure.RequestContext context = default);

abstract member GetCropProduct : string * Azure.RequestContext -> Azure.Response
override this.GetCropProduct : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetCropProduct (cropProductId As String, Optional context As RequestContext = Nothing) As Response

Parameters

cropProductId

String

Id of the crop Product.

context

RequestContext

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

Returns

Response

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

Exceptions

ArgumentNullException

cropProductId is null.

ArgumentException

cropProductId 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 GetCropProduct with required parameters and parse the result.

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

Response response = client.GetCropProduct("<cropProductId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("cropIds")[0].ToString());
Console.WriteLine(result.GetProperty("brand").ToString());
Console.WriteLine(result.GetProperty("product").ToString());
Console.WriteLine(result.GetProperty("trait").ToString());
Console.WriteLine(result.GetProperty("relativeMaturity").GetProperty("unit").ToString());
Console.WriteLine(result.GetProperty("relativeMaturity").GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("treatments")[0].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());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for CropProduct:

{
  cropIds: [string], # Optional. Ids of the crops it belongs to.
Note: A maximum of 25 crops can be associated with a cropProduct.
  brand: string, # Optional. CropProduct Brand.
  product: string, # Optional. CropProduct product.
  trait: string, # Optional. CropProduct trait.
  relativeMaturity: {
    unit: string, # Optional. Data unit.
    value: number, # Optional. Data value.
  }, # Optional. Schema for storing measurement reading and unit.
  treatments: [string], # Optional. CropProduct treatments.
  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.
}