Microsoft Azure SolutionsDiscoverability API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure AgFoodPlatform RP Service Solutions…
  description: APIs documentation for Microsoft Azure Data Manager for Agriculture Service.
  version: 2023-06-01-preview
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: SolutionsDiscoverability
paths:
  /providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions:
    get:
      tags:
      - SolutionsDiscoverability
      description: Get list of Data Manager For Agriculture solutions.
      operationId: microsoftAzureSolutionsdiscoverabilityList
      parameters:
      - in: query
        name: farmBeatsSolutionIds
        description: Ids of Data Manager For Agriculture Solutions which the customer requests to fetch.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: farmBeatsSolutionNames
        description: Names of Data Manager For Agriculture Solutions which the customer requests to fetch.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - in: query
        name: $maxPageSize
        description: 'Maximum number of items needed (inclusive).

          Minimum = 10, Maximum = 1000, Default value = 50.'
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
          minimum: 10
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataManagerForAgricultureSolutionListResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SolutionsDiscoverability_List:
          $ref: ./examples/SolutionsDiscoverability_List.json
      summary: Microsoft Azure Get Providers Microsoft Agfoodplatform…
  /providers/Microsoft.AgFoodPlatform/farmBeatsSolutionDefinitions/{dataManagerForAgricultureSolutionId}:
    get:
      tags:
      - SolutionsDiscoverability
      description: Get Data Manager For Agriculture solution by id.
      operationId: microsoftAzureSolutionsdiscoverabilityGet
      parameters:
      - in: path
        name: dataManagerForAgricultureSolutionId
        description: dataManagerForAgricultureSolutionId to be queried.
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataManagerForAgricultureSolution'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SolutionsDiscoverability_Get:
          $ref: ./examples/SolutionsDiscoverability_Get.json
      summary: Microsoft Azure Get Providers Microsoft Agfoodplatform…
components:
  schemas:
    DataManagerForAgricultureSolution:
      description: DataManagerForAgriculture solution resource.
      type: object
      allOf:
      - $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource
      properties:
        systemData:
          $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/systemData
        properties:
          $ref: '#/components/schemas/DataManagerForAgricultureSolutionProperties'
      x-ms-azure-resource: true
    DataManagerForAgricultureSolutionListResponse:
      description: Paged response contains list of requested objects and a URL link to get the next set of results.
      required:
      - value
      type: object
      properties:
        value:
          description: List of requested objects.
          type: array
          items:
            $ref: '#/components/schemas/DataManagerForAgricultureSolution'
        $skipToken:
          description: Token used in retrieving the next page. If null, there are no additional pages.
          type: string
        nextLink:
          description: Continuation link (absolute URI) to the next page of results in the list.
          type: string
    MarketplaceOfferDetails:
      type: object
      properties:
        saasOfferId:
          type: string
        publisherId:
          type: string
    DataManagerForAgricultureSolutionProperties:
      description: DataManagerForAgricultureSolution properties.
      type: object
      properties:
        partnerId:
          description: Solution Partner Id.
          type: string
          readOnly: true
        partnerTenantId:
          description: Solution Partner Tenant Id.
          type: string
          readOnly: true
        dataAccessScopes:
          description: 'Gets scope of the Data manager For Agriculture data access that''s required for processing solution request to partner.

            Example: For gdd they might need weatherScope and satelliteScope.'
          type: array
          items:
            type: string
          readOnly: true
        marketplaceOfferDetails:
          $ref: '#/components/schemas/MarketplaceOfferDetails'
        openApiSpecsDictionary:
          description: Gets api-version Swagger Document Dictionary to capture all api-versions of swagger exposed by partner to Data Manager For Agriculture.
          type: object
          additionalProperties: {}
          readOnly: true
        accessFBApplicationId:
          format: uuid
          description: Application id of the multi tenant application to be used by partner to access Data Manager For Agriculture data.
          type: string
          readOnly: true
        saaSApplicationId:
          description: Application id of the SaaS multi tenant application.
          type: string
          readOnly: true
        actionIds:
          description: List of ActionIds needed to make the SaaS multi tenant application access relevant fb data.
          type: array
          items:
            type: string
          readOnly: true
        roleId:
          description: Role Id of the SaaS multi tenant application to access relevant fb data.
          type: string
          readOnly: true
        roleName:
          description: Role Name of the SaaS multi tenant application to access relevant fb data.
          type: string
          readOnly: true
        accessFBApplicationName:
          description: Application name of the multi tenant application to be used by partner to access Data Manager For Agriculture Data.
          type: string
          readOnly: true
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.