Microsoft Azure
Microsoft Azure Public-Search API

The Public-Search API from Microsoft Azure — 2 operation(s) for public-search.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Public-Search API
schemes:
- https
tags:
- name: Public-Search
paths:
  /facets:
    get:
      tags:
      - Public-Search
      summary: "Microsoft Azure Public Facets Api Provides An Unauthenticated Endpoint For Consuming List Of Marketplace Public Products Counts Per Requested Properties In Addition, It Enables Filtering On Selected Product properties, Search, 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: microsoftAzureFacetsGet
      x-ms-examples:
        Facets_Get:
          $ref: ./examples/Facets_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
        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: hideKeys
        in: query
        description: Products that contains any of the given hideKeys for preview. Such as '22c6b3ae-1111-1111-1111-e7cbdc8569dd'. If no value provided, this filter is ignored. This filter is applied only when PublishingStage filter is set to Preview.
        collectionFormat: csv
        items:
          type: string
      - type: string
        name: market
        in: query
        required: true
        description: Product sold market, Possible values - https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies or 'All' for all markets. Such as 'US'
      - 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: string
        name: publishingStage
        in: query
        description: 'Audience. Default: Public.

          - `Preview`: Preview.

          - `Public`: Public'
        x-schema:
          $ref: '#/definitions/PublishingStage'
        default: Public
        enum:
        - Preview
        - Public
        x-ms-enum:
          name: PublishingStage
          modelAsString: true
      - type: array
        name: facets
        in: query
        required: true
        description: "Array facets to facet by, if none provided then no facets will return. Such as facets=PricingTypes,operatingSystems. \n- `SupportedProducts`: Supported Products. \n- `PublisherType`: Publisher Type.\n- `AzureBenefit`: Azure Benefit.\n- `ProductType`: Product Type.\n- `OperatingSystems`: Operating Systems.\n- `PricingTypes`: Pricing Types.\n- `VmImageGenerations`: Vm Image Generations.\n- `VmSecurityTypes`: Vm Security Types.\n- `VmArchitectureTypes`: Vm Architecture Types.\n- `RatingBuckets`: Rating Buckets."
        collectionFormat: csv
        items:
          type: string
          enum:
          - SupportedProducts
          - PublisherType
          - AzureBenefit
          - ProductType
          - OperatingSystems
          - PricingTypes
          - VmImageGenerations
          - VmSecurityTypes
          - VmArchitectureTypes
          - RatingBuckets
          x-ms-enum:
            name: SearchFieldName
            modelAsString: true
      responses:
        '200':
          description: Returns a list of offers count per filter
          schema:
            $ref: '#/definitions/FacetsResponse'
        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.
  /search:
    get:
      tags:
      - Public-Search
      summary: "Microsoft Azure Public Search Api Provides An Unauthenticated Endpoint For Consuming List Of Marketplace Public Products, Total Count Of Products Returned, And Facets Per Requested Properties In Addition, It Enables Filtering On Selected Product properties, Search, 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: microsoftAzureSearchGet
      x-ms-examples:
        Search_Get:
          $ref: ./examples/Search_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
        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: select
        in: query
        required: true
        description: "Array of fields to return. Such as select=pricingTypes. \n- `All`: All fields.\n- `SupportedProducts`: Supported Products.\n- `PublisherId`: Publisher Id.\n- `DisplayName`: Display Name.\n- `AzureBenefit`: Azure Benefit.\n- `Badges`: Badges.\n- `SmallIconUri`: Small Icon Uri.\n- `PublisherType`: Publisher Type.\n- `PublishingState`: Publishing State.\n- `UniqueProductId`: Unique Product Id.\n- `ProductType`: Product Type.\n- `Plans`: Plans.\n- `OperatingSystems`: Operating Systems.\n- `PricingTypes`: Pricing Types.\n- `PublisherDisplayName`: Publisher Display Name.\n- `Summary`: Summary.\n- `Description`: Description.\n- `RatingBuckets`: Rating Buckets.\n- `RatingAverage`: Rating Average.\n- `LastModifiedDateTime`: Last Modified time.\n- `RatingCount`: Rating Count.\n- `LongSummary`: Long Summary."
        collectionFormat: csv
        items:
          type: string
          enum:
          - All
          - SupportedProducts
          - PublisherId
          - DisplayName
          - AzureBenefit
          - Badges
          - SmallIconUri
          - PublisherType
          - PublishingState
          - UniqueProductId
          - ProductType
          - Plans
          - OperatingSystems
          - PricingTypes
          - PublisherDisplayName
          - Summary
          - Description
          - RatingBuckets
          - RatingAverage
          - LastModifiedDateTime
          - RatingCount
          - LongSummary
          x-ms-enum:
            name: SearchFieldName
            modelAsString: true
      - type: array
        name: orderBy
        in: query
        description: "Array of sort by fields to order by and ordering type (asc\\desc), If no value provided, ordered by search score. Default ordering type: asc. For example, orderby=RatingCount desc. \n- `RatingCount`: ratingCount (asc/desc).\n- `LastModifiedDateTime`: lastModifiedDateTime (asc/desc).\n- `RatingAverage`: RatingAverage (asc/desc)."
        collectionFormat: csv
        items:
          type: string
      - 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: hideKeys
        in: query
        description: Products that contains any of the given hideKeys for preview. Such as '22c6b3ae-1111-1111-1111-e7cbdc8569dd'. If no value provided, this filter is ignored. This filter is applied only when PublishingStage filter is set to Preview.
        collectionFormat: csv
        items:
          type: string
      - type: string
        name: market
        in: query
        required: true
        description: Product sold market, Possible values - https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies or 'All' for all markets. Such as 'US'
      - 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: string
        name: publishingStage
        in: query
        description: 'Audience. Default: Public.

          - `Preview`: Preview.

          - `Public`: Public'
        x-schema:
          $ref: '#/definitions/PublishingStage'
        default: Public
        enum:
        - Preview
        - Public
        x-ms-enum:
          name: PublishingStage
          modelAsString: true
      - type: array
        name: facets
        in: query
        description: "Array facets to facet by, if none provided then no facets will return. Such as facets=PricingTypes,operatingSystems. \n- `SupportedProducts`: Supported Products. \n- `PublisherType`: Publisher Type.\n- `AzureBenefit`: Azure Benefit.\n- `ProductType`: Product Type.\n- `OperatingSystems`: Operating Systems.\n- `PricingTypes`: Pricing Types.\n- `VmImageGenerations`: Vm Image Generations.\n- `VmSecurityTypes`: Vm Security Types.\n- `VmArchitectureTypes`: Vm Architecture Types.\n- `RatingBuckets`: Rating Buckets."
        collectionFormat: csv
        items:
          type: string
          enum:
          - SupportedProducts
          - PublisherType
          - AzureBenefit
          - ProductType
          - OperatingSystems
          - PricingTypes
          - VmImageGenerations
          - VmSecurityTypes
          - VmArchitectureTypes
          - RatingBuckets
          x-ms-enum:
            name: SearchFieldName
            modelAsString: true
      - type: integer
        name: skip
        in: query
        description: 'Number of items to skip. Minimum: 0, Maximum: 100000, Default : 0.'
        format: int32
        default: 0
      - type: integer
        name: top
        in: query
        description: 'Number of items to return. Minimum: 0, Maximum: 1000, Default: 20.'
        format: int32
        default: 20
      responses:
        '200':
          description: Returns a list of Azure Marketplace catalog offers and total count and facets
          schema:
            $ref: '#/definitions/SearchResponse'
        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:
  VmArchitectureType:
    type: string
    description: VM Architecture Type
    enum:
    - X64Gen1
    - X64Gen2
    - Arm64
    x-ms-enum:
      name: VmArchitectureType
      modelAsString: true
      values:
      - value: X64Gen1
        description: The VM image architecture of the plan is X64 Generation1
      - value: X64Gen2
        description: The VM image architecture of the plan is X64 Generation2
      - value: Arm64
        description: The VM image architecture of the plan is Arm64
  MarketStartPrice:
    type: object
    description: Retail price of the product's cheapest plan
    properties:
      market:
        type: string
        description: The market for which the starting price is calculated
      termUnits:
        type: string
        description: The terms pricing model units
      meterUnits:
        type: string
        description: The meters pricing model units
      minTermPrice:
        type: number
        description: Starting (minimal) terms price
      minMeterPrice:
        type: number
        description: Starting (minimal) meters price
      currency:
        type: string
        description: Currency for price
  FacetsResponse:
    type: object
    description: The facets response
    properties:
      value:
        type: object
        description: The facet items results
        additionalProperties:
          $ref: '#/definitions/FacetsItem'
  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'
  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
  PublishingStage:
    type: string
    description: 'The product publishing stage. Possible values are: Preview, Public'
    enum:
    - Preview
    - Public
    x-ms-enum:
      name: PublishingStage
      modelAsString: true
      values:
      - value: Preview
        description: Product is available to restricted audience
      - value: Public
        description: Product is publicly available in the Marketplace
  FacetsItem:
    type: object
    description: The facets item
    properties:
      facetValues:
        type: object
        description: The facet values
        additionalProperties:
          $ref: '#/definitions/FacetValue'
  PublisherType:
    type: string
    description: A value indicating whether this is a Microsoft or third party product
    enum:
    - Microsoft
    - ThirdParty
    x-ms-enum:
      name: PublisherType
      modelAsString: true
      values:
      - value: Microsoft
        description: Product is published by Microsoft (1st party product)
      - value: ThirdParty
        description: Product is published by Third Party Vendor
  ProductSummary:
    type: object
    description: Summary description of the product
    required:
    - productType
    properties:
      displayName:
        type: string
        description: Product display name
      publisherId:
        type: string
        description: Publisher id
      azureBenefit:
        description: "Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Possible values: \n- `Eligible` - Product is eligible for Azure consumption commitment benefit\n- `NotEligible` - Product is not eligible for Azure consumption commitment benefit"
        allOf:
        - $ref: '#/definitions/AzureBenefit'
      badges:
        type: array
        description: 'The following product badges are available: preferredSolution, powerBICertified, AdditionalPurchaseRequirement'
        items:
          $ref: '#/definitions/Badge'
      publisherType:
        description: 'A value indicating

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-public-search-api-openapi.yml
Microsoft Azure Public-Search API

Documentation

Specifications

Other Resources

OpenAPI Specification
