Data Manager For Agriculture Extensions - List

Reference

Service:: Azure Data Manager for Agriculture

API Version:: 2023-06-01-preview

Get list of Data Manager For Agriculture extension.

GET https://management.azure.com/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions?api-version=2023-06-01-preview

With optional parameters:

GET https://management.azure.com/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions?farmBeatsExtensionIds={farmBeatsExtensionIds}&farmBeatsExtensionNames={farmBeatsExtensionNames}&extensionCategories={extensionCategories}&publisherIds={publisherIds}&$maxPageSize={$maxPageSize}&api-version=2023-06-01-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version to use for this operation.
$maxPageSize	query		integer int32	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.
extensionCategories	query		string[]	Extension categories.
farmBeatsExtensionIds	query		string[]	DataManagerForAgricultureExtension ids.
farmBeatsExtensionNames	query		string[]	DataManagerForAgriculture extension names.
publisherIds	query		string[]	Publisher ids.

Responses

Name	Type	Description
200 OK	DataManagerForAgricultureExtensionListResponse	Success
Other Status Codes	ErrorResponse	Error

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DataManagerForAgricultureExtensions_List

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions?api-version=2023-06-01-preview

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/examples-rg/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/DTN.ContentServices",
      "type": "Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions",
      "systemData": {
        "createdAt": "2021-04-12T15:28:06Z",
        "lastModifiedAt": "2021-04-12T15:30:01Z"
      },
      "properties": {
        "targetResourceType": "FarmBeats",
        "farmBeatsExtensionId": "DTN.ContentServices",
        "farmBeatsExtensionName": "DTN",
        "farmBeatsExtensionVersion": "1.0",
        "publisherId": "dtn",
        "extensionCategory": "Weather",
        "extensionAuthLink": "https://www.dtn.com/dtn-content-integration/",
        "extensionApiDocsLink": "https://cs-docs.dtn.com/api/weather-observations-and-forecasts-rest-api/",
        "detailedInformation": [
          {
            "apiName": "GetDailyObservations",
            "customParameters": [
              "stationId",
              "stationLatitude",
              "stationLongitude",
              "timeZone",
              "sunrise",
              "sunset",
              "weatherCode",
              "weatherDescription",
              "maxTemperature",
              "minTemperature",
              "avgHeatIndex",
              "maxHeatIndex",
              "minHeatIndex",
              "maxWindChill",
              "minWindChill",
              "maxFeelsLike",
              "minFeelsLike",
              "avgFeelsLike",
              "maxWindSpeed",
              "avgWetBulbGlobeTemp",
              "maxWetBulbGlobeTemp",
              "minWetBulbGlobeTemp",
              "minutesOfSunshine",
              "cornHeatUnit",
              "evapotranspiration"
            ],
            "platformParameters": [
              "cloudCover",
              "dewPoint",
              "growingDegreeDay",
              "precipitation",
              "pressure",
              "relativeHumidity",
              "temperature",
              "wetBulbTemperature",
              "dateTime",
              "windChill",
              "windSpeed",
              "windDirection"
            ],
            "unitsSupported": {
              "key": "units",
              "values": [
                "us",
                "si"
              ]
            },
            "apiInputParameters": [
              "stationId",
              "lat",
              "lon",
              "days",
              "units",
              "precision",
              "sector"
            ]
          },
          {
            "apiName": "GetHourlyObservations",
            "customParameters": [
              "stationId",
              "stationLatitude",
              "stationLongitude",
              "timeZone",
              "weatherCode",
              "weatherDescription",
              "feelsLike",
              "visibilityWeatherCode",
              "visibilityWeatherDescription",
              "minutesOfSunshine"
            ],
            "platformParameters": [
              "cloudCover",
              "dewPoint",
              "precipitation",
              "pressure",
              "relativeHumidity",
              "temperature",
              "wetBulbTemperature",
              "dateTime",
              "visibility",
              "windChill",
              "windSpeed",
              "windDirection",
              "windGust"
            ],
            "unitsSupported": {
              "key": "units",
              "values": [
                "us",
                "si"
              ]
            },
            "apiInputParameters": [
              "stationId",
              "lat",
              "lon",
              "hours",
              "units",
              "precision",
              "sector"
            ]
          },
          {
            "apiName": "GetHourlyForecasts",
            "customParameters": [
              "stationId",
              "stationLatitude",
              "stationLongitude",
              "timeZone",
              "weatherCode",
              "weatherDescription",
              "feelsLike",
              "visibilityWeatherCode",
              "visibilityWeatherDescription",
              "minutesOfSunshine"
            ],
            "platformParameters": [
              "cloudCover",
              "dewPoint",
              "precipitation",
              "pressure",
              "relativeHumidity",
              "temperature",
              "wetBulbTemperature",
              "dateTime",
              "visibility",
              "windChill",
              "windSpeed",
              "windDirection",
              "windGust"
            ],
            "unitsSupported": {
              "key": "units",
              "values": [
                "us",
                "si"
              ]
            },
            "apiInputParameters": [
              "stationId",
              "lat",
              "lon",
              "days",
              "units",
              "precision",
              "sector"
            ]
          },
          {
            "apiName": "GetDailyForecasts",
            "customParameters": [
              "stationId",
              "stationLatitude",
              "stationLongitude",
              "timeZone",
              "sunrise",
              "sunset",
              "weatherCode",
              "weatherDescription",
              "maxTemperature",
              "minTemperature",
              "avgHeatIndex",
              "maxHeatIndex",
              "minHeatIndex",
              "maxWindChill",
              "minWindChill",
              "maxFeelsLike",
              "minFeelsLike",
              "avgFeelsLike",
              "maxWindSpeed",
              "avgWetBulbGlobeTemp",
              "maxWetBulbGlobeTemp",
              "minWetBulbGlobeTemp",
              "minutesOfSunshine",
              "cornHeatUnit",
              "evapotranspiration"
            ],
            "platformParameters": [
              "cloudCover",
              "dewPoint",
              "growingDegreeDay",
              "precipitation",
              "pressure",
              "relativeHumidity",
              "temperature",
              "wetBulbTemperature",
              "dateTime",
              "windChill",
              "windSpeed",
              "windDirection"
            ],
            "unitsSupported": {
              "key": "units",
              "values": [
                "us",
                "si"
              ]
            },
            "apiInputParameters": [
              "stationId",
              "lat",
              "lon",
              "days",
              "units",
              "precision",
              "sector"
            ]
          }
        ]
      },
      "name": "DTN.ContentServices"
    }
  ],
  "nextLink": "string"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DataManagerForAgricultureExtension	DataManagerForAgriculture extension resource.
DataManagerForAgricultureExtensionListResponse	Paged response contains list of requested objects and a URL link to get the next set of results.
DataManagerForAgricultureExtensionProperties	DataManagerForAgricultureExtension properties.
DetailedInformation	Model to capture detailed information for Data Manager For AgricultureExtensions.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.
UnitSystemsInfo	Unit systems info for the data provider.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataManagerForAgricultureExtension

DataManagerForAgriculture extension resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	DataManagerForAgricultureExtensionProperties	DataManagerForAgricultureExtension properties.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

DataManagerForAgricultureExtensionListResponse

Paged response contains list of requested objects and a URL link to get the next set of results.

Name	Type	Description
$skipToken	string	Token used in retrieving the next page. If null, there are no additional pages.
nextLink	string	Continuation link (absolute URI) to the next page of results in the list.
value	DataManagerForAgricultureExtension[]	List of requested objects.

DataManagerForAgricultureExtensionProperties

DataManagerForAgricultureExtension properties.

Name	Type	Description
description	string	Textual description.
detailedInformation	DetailedInformation[]	Detailed information which shows summary of requested data. Used in descriptive get extension metadata call. Information for weather category per api included are apisSupported, customParameters, PlatformParameters and Units supported.
extensionApiDocsLink	string	Data Manager For Agriculture Extension api docs link.
extensionAuthLink	string	Data Manager For Agriculture Extension auth link.
extensionCategory	string	Category of the extension. e.g. weather/sensor/satellite.
farmBeatsExtensionId	string	Data Manager For Agriculture Extension ID.
farmBeatsExtensionName	string	Data Manager For Agriculture Extension name.
farmBeatsExtensionVersion	string	Data Manager For Agriculture Extension version.
publisherId	string	Publisher ID.
targetResourceType	string	Target ResourceType of the Data Manager For Agriculture Extension.

DetailedInformation

Model to capture detailed information for Data Manager For AgricultureExtensions.

Name	Type	Description
apiDefaultInputParameters	string[]	List of defaultParameters.
apiDocsLink	string	Extension provider's API documentation link.
apiInputParameters	string[]	List of apiInputParameters.
apiName	string	ApiName available for the Data Manager For Agriculture Extension.
apiType	string	Type of Api in Extension.
customParameters	string[]	List of customParameters.
platformParameters	string[]	List of platformParameters.
unitsSupported	UnitSystemsInfo	Unit systems info for the data provider.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UnitSystemsInfo

Unit systems info for the data provider.

Name	Type	Description
key	string	UnitSystem key sent as part of ProviderInput.
values	string[]	List of unit systems supported by this data provider.

Share via