Microsoft Azure Public-Suggestions API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft Marketplace Search Public…
  description: Microsoft Marketplace Search API
  version: 2023-01-01-preview
servers:
- url: https://catalogapi.azure.com
security:
- ApiKey: []
tags:
- name: Public-Suggestions
paths:
  /suggestions/products:
    get:
      tags:
      - Public-Suggestions
      summary: Microsoft Azure Public Suggestions Api Provides An Unauthenticated Endpoint For…
      operationId: microsoftAzureSuggestionsGetproducts
      x-ms-examples:
        SuggestionsProducts_Get:
          $ref: ./examples/SuggestionsProducts_Get.json
      parameters:
      - name: api-version
        in: query
        required: true
        description: Version of the REST API used for the request.
        schema:
          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
        schema:
          type: string
      - name: publisherDisplayName
        in: query
        description: The search publisher name. Such as publisherDisplayName=red hat. If no value provided, this filter is ignored.
        schema:
          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: '#/components/schemas/AzureBenefit'
        x-ms-enum:
          name: AzureBenefit
          modelAsString: true
        schema:
          type: string
          enum:
          - Eligible
          - NotEligible
      - 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."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Microsoft
            - ThirdParty
            x-ms-enum:
              name: PublisherType
              modelAsString: true
      - 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."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - PreferredSolution
            - PowerBICertified
            - AdditionalPurchaseRequirement
            x-ms-enum:
              name: Badge
              modelAsString: true
      - 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: '#/components/schemas/IndustryCloud'
        x-ms-enum:
          name: IndustryCloud
          modelAsString: true
        schema:
          type: string
          enum:
          - NotApplicable
          - 'True'
          - 'False'
      - 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'
        schema:
          type: string
      - 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.'
        style: form
        explode: false
        schema:
          type: array
          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
      - 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."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Free
            - FreeTrial
            - Byol
            - Payg
            - Ri
            x-ms-enum:
              name: PricingType
              modelAsString: true
      - 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).'
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - 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.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - 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.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - 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"
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - AboveOne
            - AboveTwo
            - AboveThree
            - AboveFour
            x-ms-enum:
              name: RatingBucket
              modelAsString: true
      - 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."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - X64Gen1
            - X64Gen2
            - Arm64
            x-ms-enum:
              name: VmArchitectureType
              modelAsString: true
      - 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"
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - None
            - Trusted
            - Confidential
            x-ms-enum:
              name: VmSecurityType
              modelAsString: true
      - name: suggestionTypes
        in: query
        required: true
        description: "Suggestion types. \n- `WordSearch`: WordSearch.\n- `Entity`: Entity."
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - WordSearch
            - Entity
            x-ms-enum:
              name: SuggestionType
              modelAsString: true
      - name: top
        in: query
        description: 'Number of items per SuggestionType to return. Minimum: 1, Maximum: 40, Default: 20.'
        schema:
          type: integer
          format: int32
          default: 20
      - 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."
        style: form
        explode: false
        schema:
          type: array
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/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."
          headers:
            x-ms-error-code:
              description: Error code
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      description: Needs a more full description created.
components:
  schemas:
    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
    SuggestionsResponse:
      type: object
      description: The suggestion response
      required:
      - value
      - totalCount
      properties:
        value:
          type: array
          description: The suggestion items results
          items:
            $ref: '#/components/schemas/SuggestionsItem'
        totalCount:
          type: integer
          description: The suggestion count
          format: int64
    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: '#/components/schemas/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: '#/components/schemas/ProductType'
        linkedAddInsTypes:
          type: object
          description: The suggestion linked add-in types
          additionalProperties:
            type: string
    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
    ErrorResponse:
      type: object
      description: The search error response object
      properties:
        error:
          description: The search error response details
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
    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: '#/components/schemas/ErrorDetails'
  securitySchemes:
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Use Api key provided by Marketplace Catalog Team as a parameter provided in the header
x-generator: NSwag v13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v13.0.0.0))