Microsoft Azure Public-Suggestions API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Public-Suggestions API
schemes:
- https
tags:
- name: Public-Suggestions
paths:
  /suggestions/products:
    get:
      tags:
      - Public-Suggestions
      summary: "Microsoft Azure Public Suggestions Api Provides An Unauthenticated Endpoint For Consuming List Of Marketplace Public Products Suggestions Per Requested Properties In Addition, It Enables Filtering On Selected Product properties, And Getting Product Details Each Api Request Must Include An Api Key Allocated To You See X Api Key Description  Send An Email To Mkpl Platform Api Dl@microsoft Com Including The Following Details To Get The Api Key:\n Customer Name\n Service Product Name\n Ad Registered App Id If Available \n Focal Point Email\n Use Case Scenario\n Expected Traffic Volume, Including Peak Requests Per Second Daily"
      operationId: microsoftAzureSuggestionsGetproducts
      x-ms-examples:
        SuggestionsProducts_Get:
          $ref: ./examples/SuggestionsProducts_Get.json
      parameters:
      - type: string
        name: api-version
        in: query
        required: true
        description: Version of the REST API used for the request.
      - type: string
        name: searchQuery
        in: query
        required: true
        description: The search text, if no value provided, this filter is ignored. Such as searchQuery=red hat
      - type: string
        name: publisherDisplayName
        in: query
        description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored.
      - type: string
        name: azureBenefit
        in: query
        description: "Define the search for only azure benefit eligible offers, if no value provided, this filter is ignored. Default: null. \n- `Eligible`: Eligible.\n- `NotEligible`: Not Eligible."
        x-schema:
          $ref: '#/definitions/AzureBenefit'
        enum:
        - Eligible
        - NotEligible
        x-ms-enum:
          name: AzureBenefit
          modelAsString: true
      - type: array
        name: publisherTypes
        in: query
        description: "Products that contains any of the given publisher types, If no value provided, this filter is ignored. Possible values: Microsoft, ThirdParty. Default: Microsoft. \n- `Microsoft`: Microsoft.\n- `ThirdParty`: Third Party."
        collectionFormat: csv
        items:
          type: string
          enum:
          - Microsoft
          - ThirdParty
          x-ms-enum:
            name: PublisherType
            modelAsString: true
      - type: array
        name: badges
        in: query
        description: "Products that contains any of the given badges. If no value provided, this filter is ignored. The following product badges are available: \n- `PreferredSolution`: Preferred Solution.\n- `PowerBICertified`: power BI Certified.\n- `AdditionalPurchaseRequirement`: Additional Purchase Requirement."
        collectionFormat: csv
        items:
          type: string
          enum:
          - PreferredSolution
          - PowerBICertified
          - AdditionalPurchaseRequirement
          x-ms-enum:
            name: Badge
            modelAsString: true
      - type: string
        name: industryCloud
        in: query
        description: "Define the search for IndustryCloud offers. If no value provided, this filter is ignored. Default: NotApplicable. \n- `NotApplicable`: Not Applicable.\n- `True`: True.\n- `False`: False."
        x-schema:
          $ref: '#/definitions/IndustryCloud'
        enum:
        - NotApplicable
        - 'True'
        - 'False'
        x-ms-enum:
          name: IndustryCloud
          modelAsString: true
      - type: string
        name: language
        in: query
        required: true
        description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'
      - type: array
        name: productTypes
        in: query
        description: 'Products that contains any of the given product types, Such as ''VirtualMachine''. If no value provided, this filter is ignored.

          - `AADApps`: Azure Active Directory Apps.

          - `AzureApplication`: Azure Application.

          - `AzureServices`: Azure Services.

          - `ConsultingServices`: Consulting Services.

          - `Container`: Container.

          - `ContainerApps`: Container Apps.

          - `CoreVirtualMachine`: Core Virtual Machine.

          - `CosellOnly`: Cosell Only.

          - `DevService`: Dev Service.

          - `DynamicsBC`: Dynamics BC.

          - `DynamicsCE`: Dynamics CE.

          - `DynamicsOps`: Dynamics Ops.

          - `IotEdgeModules`: Iot Edge Modules.

          - `ManagedApplication`: Managed Application.

          - `ManagedServices`: Managed Services.

          - `Office365`: Office365.

          - `PowerBI`: PowerBI.

          - `PowerBIVisuals`: PowerBI Visuals.

          - `SaaS`: SaaS.

          - `SolutionTemplate`: Solution Template.

          - `VirtualMachine`: Virtual Machine.

          - `VisualStudioExtension`: Visual Studio Extension.

          - `AppService`: App Service.

          - `LogAnalytics`: Log Analytics.'
        collectionFormat: csv
        items:
          type: string
          enum:
          - DevService
          - ManagedApplication
          - VirtualMachine
          - AzureApplication
          - Container
          - SaaS
          - SolutionTemplate
          - IotEdgeModules
          - ManagedServices
          - ContainerApps
          - VisualStudioExtension
          - DynamicsOps
          - DynamicsCE
          - DynamicsBC
          - PowerBI
          - ConsultingServices
          - CosellOnly
          - CoreVirtualMachine
          - PowerBIVisuals
          - Office365
          - AADApps
          - AzureServices
          - AppService
          - LogAnalytics
          x-ms-enum:
            name: ProductType
            modelAsString: true
      - type: array
        name: pricingTypes
        in: query
        description: "Products that contains any of the given pricing types. If no value provided, this filter is ignored. \n- `Byol`: The product has at least one plan that is bring your own license.\n- `Free`: The product has at least one plan that is free of charge.\n- `FreeTrial`: The product has at least one plan that is free trial.\n- `Payg`: The product has at least one plan that is Pay as you go, usage based billing model.\n- `RI`: The product has at least one plan that is Reserved Instance billing model."
        collectionFormat: csv
        items:
          type: string
          enum:
          - Free
          - FreeTrial
          - Byol
          - Payg
          - Ri
          x-ms-enum:
            name: PricingType
            modelAsString: true
      - type: array
        name: operatingSystems
        in: query
        description: 'Products that contains any of the given operating systems, Such as operatingSystems=windows,linux. If no value provided, this filter is ignored. This filter is relevant for Virtual Machine product type only.

          - `windows.windowsserver2019`: Windows Server 2019.

          - `windows.windowsserver2019`: Windows Server 2019.

          - `windows.windowsserver2016`: Windows Server 2016.

          - `windows.windowsserver2012r2`: Windows Server 2012 R2.

          - `windows.windowsserver2012`: Windows Server 2012.

          - `windows.windowsserver2008r2`: Windows Server 2008 R2.

          - `windows.others`: Others (windows).

          - `windows.windowsserver2022`: Windows Server 2022.

          - `linux.centos`: Cent OS.

          - `linux.debian`: Debian.

          - `linux.redhat`: Red Hat.

          - `linux.suse`: SUSE.

          - `linux.ubuntu`: Ubuntu.

          - `linux.others`: Others (Linux).'
        collectionFormat: csv
        items:
          type: string
      - type: array
        name: supportedProducts
        in: query
        description: Products that contains any of the given supported products. Such as 'CRM'. If no value provided, this filter is ignored.
        collectionFormat: csv
        items:
          type: string
      - type: array
        name: publisherIds
        in: query
        description: Products that contains any of the given publisher ids. Such as 'Microsoft'. If no value provided, this filter is ignored.
        collectionFormat: csv
        items:
          type: string
      - type: array
        name: ratingBuckets
        in: query
        description: "Products that contains any of the given rating buckets. Such as 'Above1'. If no value provided, this filter is ignored. \n- `AboveOne`: Above One.\n- `AboveTwo`: Above Two.\n- `AboveThree`: Above Three.\n- `AboveFour`: Above Four"
        collectionFormat: csv
        items:
          type: string
          enum:
          - AboveOne
          - AboveTwo
          - AboveThree
          - AboveFour
          x-ms-enum:
            name: RatingBucket
            modelAsString: true
      - type: array
        name: vmArchitectureTypes
        in: query
        description: "Array of Virtual Machine image architecture types to search by, If no value provided, this filter is ignored. see https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2: \n - `X64Gen1`: X64 Generation 1.\n - `X64Gen2`: X64 Generation 2.\n - `Arm64`: Arm64 image architecture."
        collectionFormat: csv
        items:
          type: string
          enum:
          - X64Gen1
          - X64Gen2
          - Arm64
          x-ms-enum:
            name: VmArchitectureType
            modelAsString: true
      - type: array
        name: vmSecurityTypes
        in: query
        description: "Products that contains any of the given vm security types. Such as 'Trusted'. If no value provided, this filter is ignored. \n- `None`: None.\n- `Trusted`: Trusted.\n- `Confidential`: Confidential"
        collectionFormat: csv
        items:
          type: string
          enum:
          - None
          - Trusted
          - Confidential
          x-ms-enum:
            name: VmSecurityType
            modelAsString: true
      - type: array
        name: suggestionTypes
        in: query
        required: true
        description: "Suggestion types. \n- `WordSearch`: WordSearch.\n- `Entity`: Entity."
        collectionFormat: csv
        items:
          type: string
          enum:
          - WordSearch
          - Entity
          x-ms-enum:
            name: SuggestionType
            modelAsString: true
      - type: integer
        name: top
        in: query
        description: 'Number of items per SuggestionType to return. Minimum: 1, Maximum: 40, Default: 20.'
        format: int32
        default: 20
      - type: array
        name: select
        in: query
        description: "Array of fields to return. Such as 'displayText'. If no value provided, return fields as follows. if suggestionsType=Entity, return: suggestionType, displayText, id. if suggestionType=WordSearch, return suggestionType and displayText. \n- `DisplayText`: Display text.\n- `Id`: Id.\n- `IconUrl`: Icon Url.\n- `ProductType`: Product type.\n- `LinkedAddInsTypes`: Linked AddIns types."
        collectionFormat: csv
        items:
          type: string
          enum:
          - DisplayText
          - Id
          - IconUrl
          - ProductType
          - LinkedAddInsTypes
          x-ms-enum:
            name: SuggestionsFieldName
            modelAsString: true
      responses:
        '200':
          description: Returns a list of azure marketplace products suggestions and count
          schema:
            $ref: '#/definitions/SuggestionsResponse'
        default:
          description: " Error Responses: \n\n * 400 - In case request malformed.\n\n * 401 - In case of a missing or invalid api key header\n\n * 500 - In case internal error."
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: Error code
      description: Needs a more full description created.
definitions:
  ErrorResponse:
    type: object
    description: The search error response object
    properties:
      error:
        description: The search error response details
        allOf:
        - $ref: '#/definitions/ErrorDetails'
  IndustryCloud:
    type: string
    description: Industry Cloud
    enum:
    - NotApplicable
    - 'True'
    - 'False'
    x-ms-enum:
      name: IndustryCloud
      modelAsString: true
      values:
      - value: NotApplicable
        description: Not Applicable
      - value: 'True'
        description: 'True'
      - value: 'False'
        description: 'False'
  SuggestionsItem:
    type: object
    description: The suggestion item
    required:
    - displayText
    properties:
      suggestionType:
        description: The suggestion type
        allOf:
        - $ref: '#/definitions/SuggestionType'
      displayText:
        type: string
        description: The suggestion display text
      id:
        type: string
        description: The suggestion item id
      iconUrl:
        type: string
        description: The suggestion icon url
      productType:
        description: The suggestion supported product types
        allOf:
        - $ref: '#/definitions/ProductType'
      linkedAddInsTypes:
        type: object
        description: The suggestion linked add-in types
        additionalProperties:
          type: string
  ErrorDetails:
    type: object
    description: The search error response details object
    properties:
      code:
        type: string
        description: The error code description. Such as code=InternalError
      message:
        type: string
        description: The error message. Such as message=Internal server error
      details:
        type: array
        description: List of error response details
        items:
          $ref: '#/definitions/ErrorDetails'
  SuggestionsResponse:
    type: object
    description: The suggestion response
    required:
    - value
    - totalCount
    properties:
      value:
        type: array
        description: The suggestion items results
        items:
          $ref: '#/definitions/SuggestionsItem'
      totalCount:
        type: integer
        description: The suggestion count
        format: int64
  ProductType:
    type: string
    description: The delivery method or deployment model
    enum:
    - None
    - DevService
    - ManagedApplication
    - VirtualMachine
    - AzureApplication
    - Container
    - SaaS
    - SolutionTemplate
    - IotEdgeModules
    - ManagedServices
    - ContainerApps
    - VisualStudioExtension
    - DynamicsOps
    - DynamicsCE
    - DynamicsBC
    - PowerBI
    - ConsultingServices
    - CosellOnly
    - CoreVirtualMachine
    - PowerBIVisuals
    - Office365
    - AADApps
    - AzureServices
    - AppService
    - LogAnalytics
    x-ms-enum:
      name: ProductType
      modelAsString: true
      values:
      - value: None
        description: product type returned for Azure Services, Container Extensions and VM extensions
      - value: DevService
        description: Dev Service
      - value: ManagedApplication
        description: Managed Application plan type (applicable to Azure Applications only)
      - value: VirtualMachine
        description: the product is Image service instances with usage-based pricing
      - value: AzureApplication
        description: products published as Solution Templates (ST) or Azure Managed Apps (AMA) plans that deploy Azure resources to the customer tenant.
      - value: Container
        description: the product is delivered as Container
      - value: SaaS
        description: the product is a Software solution purchased on pay-as-you-go basis from a cloud service provider
      - value: SolutionTemplate
        description: Solution Template plan type (applicable to Azure Applications only)
      - value: IotEdgeModules
        description: resource is delivered as IoT Edge Module
      - value: ManagedServices
        description: the product is delivered as Managed Service
      - value: ContainerApps
        description: resource is delivered as Container App
      - value: VisualStudioExtension
        description: Visual Studio Extensions
      - value: DynamicsOps
        description: Dynamics 365 Operations Apps
      - value: DynamicsCE
        description: All Dynamics products except for DynamicsBC and DynamicsOps
      - value: DynamicsBC
        description: Dynamics 365 Business Central
      - value: PowerBI
        description: Power BI products
      - value: ConsultingServices
        description: Consulting Services (available only in Azure Marketplace as listing offers)
      - value: CosellOnly
        description: Products available in scope of Co-Sell program only
      - value: CoreVirtualMachine
        description: Virtual Machine with Windows or endorsed Linux OS image
      - value: PowerBIVisuals
        description: Power BI Visuals products
      - value: Office365
        description: Office 365 products
      - value: AADApps
        description: Azure Active Directory Applications
      - value: AzureServices
        description: Native Azure Services such as Azure Open AI service, Azure Storage Account, etc.
      - value: AppService
        description: HTTP-based service for hosting web applications, REST APIs, and mobile back ends
      - value: LogAnalytics
        description: Log Analytics services that log data from Azure Monitor and other Azure services
  AzureBenefit:
    type: string
    description: Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit)
    enum:
    - Eligible
    - NotEligible
    x-ms-enum:
      name: AzureBenefit
      modelAsString: true
      values:
      - value: Eligible
        description: the product is eligible for Azure consumption commitment benefit
      - value: NotEligible
        description: the product is not eligible for Azure consumption commitment benefit
  SuggestionType:
    type: string
    description: The type of the suggestion
    enum:
    - WordSearch
    - Entity
    x-ms-enum:
      name: SuggestionType
      modelAsString: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'