swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AggregatedCost API
schemes:
- https
tags:
- name: AggregatedCost
paths:
  /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost:
    get:
      tags:
      - AggregatedCost
      operationId: microsoftAzureAggregatedcostGetbymanagementgroup
      description: Provides the aggregate cost of a management group and all child management groups by current billing period.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        AggregatedCostByManagementGroup:
          $ref: ./examples/AggregatedCostByManagementGroup.json
        AggregatedCostByManagementGroupFilterByDate:
          $ref: ./examples/AggregatedCostByManagementGroupFilterByDate.json
      parameters:
      - $ref: '#/parameters/managementGroupIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      - name: $filter
        description: May be used to filter aggregated cost by properties/usageStart (Utc time), properties/usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ManagementGroupAggregatedCostResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Consumption Aggregatedcost
  ? /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedcost
  : get:
      tags:
      - AggregatedCost
      operationId: microsoftAzureAggregatedcostGetforbillingperiodbymanagementgroup
      description: Provides the aggregate cost of a management group and all child management groups by specified billing period
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        AggregatedCostListForBillingPeriodByManagementGroup:
          $ref: ./examples/AggregatedCostForBillingPeriodByManagementGroup.json
      parameters:
      - $ref: '#/parameters/managementGroupIdParameter'
      - $ref: '#/parameters/billingPeriodNameParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ManagementGroupAggregatedCostResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Billing Billingperiods Billingperiodname Microsoft Consumption Aggregatedcost
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
  ManagementGroupAggregatedCostProperties:
    description: The properties of the Management Group Aggregated Cost.
    type: object
    properties:
      billingPeriodId:
        description: The id of the billing period resource that the aggregated cost belongs to.
        type: string
        readOnly: true
      usageStart:
        description: The start of the date time range covered by aggregated cost.
        type: string
        format: date-time
        readOnly: true
      usageEnd:
        description: The end of the date time range covered by the aggregated cost.
        type: string
        format: date-time
        readOnly: true
      azureCharges:
        description: Azure Charges.
        type: number
        format: decimal
        readOnly: true
      marketplaceCharges:
        description: Marketplace Charges.
        type: number
        format: decimal
        readOnly: true
      chargesBilledSeparately:
        description: Charges Billed Separately.
        type: number
        format: decimal
        readOnly: true
      currency:
        description: The ISO currency in which the meter is charged, for example, USD.
        type: string
        readOnly: true
      children:
        description: Children of a management group
        type: array
        items:
          $ref: '#/definitions/ManagementGroupAggregatedCostResult'
      includedSubscriptions:
        description: List of subscription Guids included in the calculation of aggregated cost
        type: array
        items:
          type: string
      excludedSubscriptions:
        description: List of subscription Guids excluded from the calculation of aggregated cost
        type: array
        items:
          type: string
  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
  ManagementGroupAggregatedCostResult:
    description: A management group aggregated cost resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ManagementGroupAggregatedCostProperties'
        title: Management Group Aggregated Cost properties
parameters:
  managementGroupIdParameter:
    name: managementGroupId
    in: path
    description: Azure Management Group ID.
    required: true
    type: string
    x-ms-parameter-location: method
  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.
  billingPeriodNameParameter:
    name: billingPeriodName
    in: path
    description: Billing Period Name.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'