Microsoft Azure Agri Food Rp Service

Microsoft Azure Agri Food RP Service is a cloud-based platform designed to revolutionize the agriculture and food industry by providing advanced analytics, data management, and software solutions. This service enables farmers, food producers, and distributors to optimize their operations, improve crop yields, reduce waste, and enhance sustainability.

OpenAPI Specification

azure-agrifood-rp-service-openapi-original.yml Raw ↑
swagger: '2.0'
info:
  title: Microsoft Azure Azure AgriFood RP Service
  description: APIs documentation for Azure AgriFood Resource Provider Service.
  version: 2020-05-12-preview
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}
  : put:
      tags:
        - Extensions
      description: Install extension.
      operationId: microsoftAzureExtensionsCreate
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/ExtensionIdParameter'
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Extension'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Create:
          $ref: ./examples/Extensions_Create.json
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
    get:
      tags:
        - Extensions
      description: Get installed extension details by extension id.
      operationId: microsoftAzureExtensionsGet
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/ExtensionIdParameter'
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Extension'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Get:
          $ref: ./examples/Extensions_Get.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
    patch:
      tags:
        - Extensions
      description: Upgrade to latest extension.
      operationId: microsoftAzureExtensionsUpdate
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/ExtensionIdParameter'
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Extension'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Update:
          $ref: ./examples/Extensions_Update.json
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
    delete:
      tags:
        - Extensions
      description: Uninstall extension.
      operationId: microsoftAzureExtensionsDelete
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/ExtensionIdParameter'
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
        '204':
          description: Success
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Extensions_Delete:
          $ref: ./examples/Extensions_Delete.json
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions Extensionid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions
  : get:
      tags:
        - Extensions
      description: Get installed extensions details.
      operationId: microsoftAzureExtensionsListbyfarmbeats
      produces:
        - application/json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - in: query
          name: extensionIds
          description: Installed extension ids.
          type: array
          items:
            type: string
          collectionFormat: multi
        - in: query
          name: extensionCategories
          description: Installed extension categories.
          type: array
          items:
            type: string
          collectionFormat: multi
        - in: query
          name: $maxPageSize
          description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
        - in: query
          name: $skipToken
          description: Skip token for getting next set of results.
          type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ExtensionListResponse'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Extensions_ListByFarmBeats:
          $ref: ./examples/Extensions_ListByFarmBeats.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename Extensions
  ? /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/locations/{locations}/operationResults/{operationResultsId}
  : get:
      tags:
        - OperationResults
      description: Get operationResults for a FarmBeats resource.
      operationId: microsoftAzureOperationresultsGet
      produces:
        - application/json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - in: path
          name: locations
          description: Location.
          required: true
          type: string
        - in: path
          name: operationResultsId
          description: operation Results Id.
          required: true
          type: string
          pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ArmAsyncOperation'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        OperationResults_Get:
          $ref: ./examples/OperationResults_Get.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Agfoodplatform Locations Locations Operationresults Operationresultsid
  /providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions:
    get:
      tags:
        - FarmBeatsExtensions
      description: Get list of farmBeats extension.
      operationId: microsoftAzureFarmbeatsextensionsList
      produces:
        - application/json
      parameters:
        - in: query
          name: farmBeatsExtensionIds
          description: FarmBeatsExtension ids.
          type: array
          items:
            type: string
          collectionFormat: multi
        - in: query
          name: farmBeatsExtensionNames
          description: FarmBeats extension names.
          type: array
          items:
            type: string
          collectionFormat: multi
        - in: query
          name: extensionCategories
          description: Extension categories.
          type: array
          items:
            type: string
          collectionFormat: multi
        - in: query
          name: publisherIds
          description: Publisher ids.
          type: array
          items:
            type: string
          collectionFormat: multi
        - in: query
          name: $maxPageSize
          description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeatsExtensionListResponse'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        FarmBeatsExtensions_List:
          $ref: ./examples/FarmBeatsExtensions_List.json
      summary: Microsoft Azure Get Providers Microsoft Agfoodplatform Farmbeatsextensiondefinitions
  /providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/{farmBeatsExtensionId}:
    get:
      tags:
        - FarmBeatsExtensions
      description: Get farmBeats extension.
      operationId: microsoftAzureFarmbeatsextensionsGet
      produces:
        - application/json
      parameters:
        - in: path
          name: farmBeatsExtensionId
          description: farmBeatsExtensionId to be queried.
          required: true
          type: string
          pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeatsExtension'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        FarmBeatsExtensions_Get:
          $ref: ./examples/FarmBeatsExtensions_Get.json
      summary: >-
        Microsoft Azure Get Providers Microsoft Agfoodplatform Farmbeatsextensiondefinitions Farmbeatsextensionid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}
  : get:
      tags:
        - FarmBeatsModels
      description: Get FarmBeats resource.
      operationId: microsoftAzureFarmbeatsmodelsGet
      produces:
        - application/json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeats'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        FarmBeatsModels_Get:
          $ref: ./examples/FarmBeatsModels_Get.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename
    put:
      tags:
        - FarmBeatsModels
      description: Create or update FarmBeats resource.
      operationId: microsoftAzureFarmbeatsmodelsCreateorupdate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - in: body
          name: body
          description: FarmBeats resource create or update request object.
          required: true
          schema:
            $ref: '#/definitions/FarmBeats'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeats'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeats'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        FarmBeatsModels_CreateOrUpdate:
          $ref: ./examples/FarmBeatsModels_CreateOrUpdate.json
      summary: >-
        Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename
    patch:
      tags:
        - FarmBeatsModels
      description: Update a FarmBeats resource.
      operationId: microsoftAzureFarmbeatsmodelsUpdate
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - in: body
          name: body
          description: Request object.
          required: true
          schema:
            $ref: '#/definitions/FarmBeatsUpdateRequestModel'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeats'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        FarmBeatsModels_Update:
          $ref: ./examples/FarmBeatsModels_Update.json
      summary: >-
        Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename
    delete:
      tags:
        - FarmBeatsModels
      description: Delete a FarmBeats resource.
      operationId: microsoftAzureFarmbeatsmodelsDelete
      produces:
        - application/json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - $ref: '#/parameters/FarmBeatsResourceNameParameter'
      responses:
        '200':
          description: Success
        '204':
          description: Success
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        FarmBeatsModels_Delete:
          $ref: ./examples/FarmBeatsModels_Delete.json
      summary: >-
        Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Farmbeatsresourcename
  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats:
    get:
      tags:
        - FarmBeatsModels
      description: Lists the FarmBeats instances for a subscription.
      operationId: microsoftAzureFarmbeatsmodelsListbysubscription
      produces:
        - application/json
      parameters:
        - in: query
          name: $maxPageSize
          description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
        - in: query
          name: $skipToken
          description: Skip token for getting next set of results.
          type: string
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeatsListResponse'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        FarmBeatsModels_ListBySubscription:
          $ref: ./examples/FarmBeatsModels_ListBySubscription.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Agfoodplatform Farmbeats
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats:
    get:
      tags:
        - FarmBeatsModels
      description: Lists the FarmBeats instances for a resource group.
      operationId: microsoftAzureFarmbeatsmodelsListbyresourcegroup
      produces:
        - application/json
      parameters:
        - in: query
          name: $maxPageSize
          description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
        - in: query
          name: $skipToken
          description: Continuation token for getting next set of results.
          type: string
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FarmBeatsListResponse'
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        FarmBeatsModels_ListByResourceGroup:
          $ref: ./examples/FarmBeatsModels_ListByResourceGroup.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats
  /subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability:
    post:
      tags:
        - Locations
      description: >-
        Checks the name availability of the resource with requested resource
        name.
      operationId: microsoftAzureLocationsChecknameavailability
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
        - in: body
          name: body
          description: NameAvailabilityRequest object.
          required: true
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest
      responses:
        '200':
          description: Success
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Locations_CheckNameAvailability_AlreadyExists:
          $ref: ./examples/Locations_CheckNameAvailability_AlreadyExists.json
        Locations_CheckNameAvailability_Available:
          $ref: ./examples/Locations_CheckNameAvailability_Available.json
      summary: >-
        Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Agfoodplatform Checknameavailability
  /providers/Microsoft.AgFoodPlatform/operations:
    get:
      tags:
        - Operations
      description: >-
        Lists the available operations of Microsoft.AgFoodPlatform resource
        provider.
      operationId: microsoftAzureOperationsList
      produces:
        - application/json
      parameters:
        - $ref: >-
            ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult
        default:
          description: Error
          schema:
            $ref: >-
              ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Operations_List:
          $ref: ./examples/Operations_List.json
      summary: Microsoft Azure Get Providers Microsoft Agfoodplatform Operations
definitions:
  ExtensionProperties:
    description: Extension resource properties.
    type: object
    properties:
      extensionId:
        description: Extension Id.
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
        type: string
        readOnly: true
      extensionCategory:
        description: Extension category. e.g. weather/sensor/satellite.
        type: string
        readOnly: true
      installedExtensionVersion:
        description: Installed extension version.
        pattern: ^([1-9]|10).\d$
        type: string
        readOnly: true
      extensionAuthLink:
        description: Extension auth link.
        type: string
        readOnly: true
      extensionApiDocsLink:
        description: Extension api docs link.
        type: string
        readOnly: true
  Extension:
    description: Extension resource.
    type: object
    allOf:
      - $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      systemData:
        $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      properties:
        $ref: '#/definitions/ExtensionProperties'
        x-ms-client-flatten: true
      eTag:
        description: The ETag value to implement optimistic concurrency.
        type: string
        readOnly: true
    x-ms-azure-resource: true
  ExtensionListResponse:
    description: >-
      Paged response contains list of requested objects and a URL link to get
      the next set of results.
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/Extension'
      nextLink:
        description: >-
          Continuation link (absolute URI) to the next page of results in the
          list.
        type: string
        readOnly: true
  UnitSystemsInfo:
    description: Unit systems info for the data provider.
    required:
      - key
      - values
    type: object
    properties:
      key:
        description: UnitSystem key sent as part of ProviderInput.
        maxLength: 100
        minLength: 2
        type: string
      values:
        description: List of unit systems supported by this data provider.
        type: array
        items:
          type: string
  DetailedInformation:
    description: Model to capture detailed information for farmBeatsExtensions.
    type: object
    properties:
      apiName:
        description: ApiName available for the farmBeatsExtension.
        type: string
        example: dailyforecast, dailyhistorical.
      customParameters:
        description: List of customParameters.
        type: array
        items:
          type: string
      platformParameters:
        description: List of platformParameters.
        type: array
        items:
          type: string
      unitsSupported:
        $ref: '#/definitions/UnitSystemsInfo'
      apiInputParameters:
        description: List of apiInputParameters.
        type: array
        items:
          type: string
  FarmBeatsExtensionProperties:
    description: FarmBeatsExtension properties.
    type: object
    properties:
      targetResourceType:
        description: Target ResourceType of the farmBeatsExtension.
        type: string
        readOnly: true
      farmBeatsExtensionId:
        description: FarmBeatsExtension ID.
        maxLength: 100
        minLength: 2
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
        type: string
        readOnly: true
      farmBeatsExtensionName:
        description: FarmBeatsExtension name.
        maxLength: 100
        minLength: 2
        type: string
        readOnly: true
      farmBeatsExtensionVersion:
        description: FarmBeatsExtension version.
        maxLength: 100
        minLength: 2
        pattern: ^([1-9]|10).\d$
        type: string
        readOnly: true
      publisherId:
        description: Publisher ID.
        maxLength: 100
        minLength: 2
        type: string
        readOnly: true
      description:
        description: Textual description.
        maxLength: 500
        minLength: 2
        type: string
        readOnly: true
      extensionCategory:
        description: Category of the extension. e.g. weather/sensor/satellite.
        maxLength: 100
        minLength: 2
        type: string
        readOnly: true
      extensionAuthLink:
        description: FarmBeatsExtension auth link.
        type: string
        readOnly: true
      extensionApiDocsLink:
        description: FarmBeatsExtension api docs link.
        type: string
        readOnly: true
      detailedInformation:
        description: "Detailed information which shows summary of requested data.\r\nUsed in descriptive get extension metadata call.\r\nInformation for weather category per api included are apisSupported,\r\ncustomParameters, PlatformParameters and Units supported."
        type: array
        items:
          $ref: '#/definitions/DetailedInformation'
        x-ms-identifiers:
          - apiName
        readOnly: true
  FarmBeatsExtension:
    description: FarmBeats extension resource.
    type: object
    allOf:
      - $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    properties:
      systemData:
        $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      properties:
        $ref: '#/definitions/FarmBeatsExtensionProperties'
        x-ms-client-flatten: true
    x-ms-azure-resource: true
  FarmBeatsExtensionListResponse:
    description: >-
      Paged response contains list of requested objects and a URL link to get
      the next set of results.
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/FarmBeatsExtension'
      nextLink:
        description: >-
          Continuation link (absolute URI) to the next page of results in the
          list.
        type: string
        readOnly: true
  ArmAsyncOperation:
    description: "Arm async operation class.\r\nRef: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations."
    type: object
    properties:
      status:
        description: Status of the async operation.
        type: string
      error:
        $ref: '#/definitions/ArmAsyncOperationError'
  ArmAsyncOperationError:
    description: "Arm async operation error class.\r\nRef: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#azure-asyncoperation-resource-format."
    type: object
    properties:
      code:
        description: Status of the async operation.
        type: string
      message:
        description: Status of the async operation.
        type: string
  FarmBeatsProperties:
    description: FarmBeats ARM Resource properties.
    type: object
    properties:
      instanceUri:
        format: uri
        description: Uri of the FarmBeats instance.
        type: string
        readOnly: true
      provisioningState:
        description: FarmBeats instance provisioning state.
        enum:
          - Succeeded
          - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
  FarmBeats:
    description: FarmBeats ARM Resource.
    type: object
    allOf:
      - $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource
    properties:
      sku:
        $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/Sku
        x-ms-mutability:
          - read
          - create
      systemData:
        $ref: >-
          ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
      properties:
        $ref: '#/d

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-agrifood-rp-service-openapi-original.yml