swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Marketplaces API
schemes:
- https
tags:
- name: Marketplaces
paths:
  /{scope}/providers/Microsoft.Consumption/marketplaces:
    get:
      tags:
      - Marketplaces
      x-ms-odata: '#/definitions/Marketplace'
      operationId: microsoftAzureMarketplacesList
      description: Lists the marketplaces for a scope at the defined scope. Marketplaces are available via this API only for May 1, 2014 or later.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        SubscriptionMarketplacesList:
          $ref: ./examples/MarketplacesList.json
        SubscriptionMarketplacesListForBillingPeriod:
          $ref: ./examples/MarketplacesListForBillingPeriod.json
        BillingAccountMarketplacesList:
          $ref: ./examples/MarketplacesByBillingAccountList.json
        BillingAccountMarketplacesListForBillingPeriod:
          $ref: ./examples/MarketplacesByBillingAccountListForBillingPeriod.json
        DepartmentMarketplacesList:
          $ref: ./examples/MarketplacesByDepartmentList.json
        DepartmentMarketplacesListForBillingPeriod:
          $ref: ./examples/MarketplacesByDepartment_ListByBillingPeriod.json
        EnrollmentAccountMarketplacesList:
          $ref: ./examples/MarketplacesByEnrollmentAccountList.json
        EnrollmentAccountMarketplacesListForBillingPeriod:
          $ref: ./examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json
        ManagementGroupMarketplacesList:
          $ref: ./examples/MarketplacesByManagementGroupList.json
        ManagementGroupMarketplacesListForBillingPeriod:
          $ref: ./examples/MarketplacesByManagementGroup_ListForBillingPeriod.json
      parameters:
      - name: $filter
        description: May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.
        in: query
        required: false
        type: string
      - name: $top
        description: May be used to limit the number of results to the most recent N marketplaces.
        in: query
        required: false
        type: integer
        minimum: 1
        maximum: 1000
      - name: $skiptoken
        description: Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
        in: query
        required: false
        type: string
      - $ref: '#/parameters/scopeMarketplaceParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/MarketplacesListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Scope Providers Microsoft Consumption Marketplaces
definitions:
  ErrorResponse:
    description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        description: The details of the error.
        $ref: '#/definitions/ErrorDetails'
  Resource:
    description: The Resource model definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
      tags:
        readOnly: true
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    x-ms-azure-resource: true
  MarketplaceProperties:
    description: The properties of the marketplace usage detail.
    type: object
    properties:
      billingPeriodId:
        description: The id of the billing period resource that the usage belongs to.
        type: string
        readOnly: true
      usageStart:
        description: The start of the date time range covered by the usage detail.
        type: string
        format: date-time
        readOnly: true
      usageEnd:
        description: The end of the date time range covered by the usage detail.
        type: string
        format: date-time
        readOnly: true
      resourceRate:
        description: The marketplace resource rate.
        type: number
        format: decimal
        readOnly: true
      offerName:
        description: The type of offer.
        type: string
        readOnly: true
      resourceGroup:
        description: The name of resource group.
        type: string
        readOnly: true
      orderNumber:
        description: The order number.
        type: string
        readOnly: true
      instanceName:
        description: The name of the resource instance that the usage is about.
        type: string
        readOnly: true
      instanceId:
        description: The uri of the resource instance that the usage is about.
        type: string
        readOnly: true
      currency:
        description: The ISO currency in which the meter is charged, for example, USD.
        type: string
        readOnly: true
      consumedQuantity:
        description: The quantity of usage.
        type: number
        format: decimal
        readOnly: true
      unitOfMeasure:
        description: The unit of measure.
        type: string
        readOnly: true
      pretaxCost:
        description: The amount of cost before tax.
        type: number
        format: decimal
        readOnly: true
      isEstimated:
        description: The estimated usage is subject to change.
        type: boolean
        readOnly: true
      meterId:
        description: The meter id (GUID).
        type: string
        format: uuid
        readOnly: true
      subscriptionGuid:
        description: Subscription guid.
        type: string
        format: uuid
        readOnly: true
      subscriptionName:
        description: Subscription name.
        type: string
        readOnly: true
      accountName:
        description: Account name.
        type: string
        readOnly: true
      departmentName:
        description: Department name.
        type: string
        readOnly: true
      consumedService:
        description: Consumed service name.
        type: string
        readOnly: true
      costCenter:
        description: The cost center of this department if it is a department and a costcenter exists
        type: string
        readOnly: true
      additionalProperties:
        description: Additional details of this usage item. By default this is not populated, unless it's specified in $expand.
        type: string
        readOnly: true
      publisherName:
        description: The name of publisher.
        type: string
        readOnly: true
      planName:
        description: The name of plan.
        type: string
        readOnly: true
      isRecurringCharge:
        description: Flag indicating whether this is a recurring charge or not.
        type: boolean
        readOnly: true
  ErrorDetails:
    description: The details of the error.
    properties:
      code:
        description: Error code.
        type: string
        readOnly: true
      message:
        description: Error message indicating why the operation failed.
        type: string
        readOnly: true
  Marketplace:
    description: An marketplace resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/MarketplaceProperties'
        title: Marketplace properties
  MarketplacesListResult:
    description: Result of listing marketplaces. It contains a list of available marketplaces in reverse chronological order by billing period.
    type: object
    properties:
      value:
        description: The list of marketplaces.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Marketplace'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        readOnly: true
parameters:
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. The current version is 2019-04-01-preview.
  scopeMarketplaceParameter:
    name: scope
    in: path
    required: true
    type: string
    description: The scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'