SensorPartnerIntegrations.CheckConsent Method

Reference

Definition

Namespace:: Azure.Verticals.AgriFood.Farming

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

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

Source:: SensorPartnerIntegrations.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Checks consent for partner integration.

public virtual Azure.Response CheckConsent (string sensorPartnerId, string integrationId, string key, Azure.RequestContext context = default);

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

Public Overridable Function CheckConsent (sensorPartnerId As String, integrationId As String, key As String, Optional context As RequestContext = Nothing) As Response

Parameters

sensorPartnerId: String

Id of the sensor partner.

integrationId: String

Id of the integration object.

key: String

Partner integration key.

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

sensorPartnerId, integrationId or key is null.

ArgumentException

sensorPartnerId or integrationId 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 CheckConsent with required parameters and parse the result.

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

Response response = client.CheckConsent("<sensorPartnerId>", "<integrationId>", "<key>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("consented").ToString());
Console.WriteLine(result.GetProperty("sensorPartnerId").ToString());
Console.WriteLine(result.GetProperty("integrationId").ToString());

Remarks

Below is the JSON schema for the response payload.

Response Body:

Schema for SensorPartnerIntegrationCheckConsentResponse:

{
  consented: boolean, # Optional. Flag to determine the status of partner integration consent.
  sensorPartnerId: string, # Optional. Id of the associated sensor partner.
  integrationId: string, # Optional. Id of the integration.
}

Applies to

Udostępnij za pośrednictwem