swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Forecasts API
schemes:
- https
tags:
- name: Forecasts
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/forecasts:
    get:
      tags:
      - Forecasts
      x-ms-odata: '#/definitions/Forecast'
      operationId: microsoftAzureForecastsList
      description: Lists the forecast charges by subscriptionId.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        ForecastsList:
          $ref: ./examples/ForecastsList.json
        ForecastsListFilterByGrain:
          $ref: ./examples/ForecastsListFilterByGrain.json
        ForecastsListFilterByDates:
          $ref: ./examples/ForecastsListFilterByDates.json
      parameters:
      - name: $filter
        description: May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. 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
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ForecastsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Consumption Forecasts
definitions:
  Forecast:
    description: A forecast resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ForecastProperties'
        title: Forecast properties
  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'
  ForecastsListResult:
    description: Result of listing forecasts. It contains a list of available forecasts.
    type: object
    properties:
      value:
        description: The list of forecasts.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/Forecast'
  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
  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
  ForecastProperties:
    description: The properties of the forecast charge.
    type: object
    properties:
      usageDate:
        description: The usage date of the forecast.
        type: string
        readOnly: true
      grain:
        description: The granularity of forecast.
        type: string
        enum:
        - Daily
        - Monthly
        - Yearly
        x-ms-enum:
          name: Grain
          modelAsString: true
      charge:
        description: The amount of charge
        type: number
        format: decimal
        readOnly: true
      currency:
        description: The ISO currency in which the meter is charged, for example, USD.
        type: string
        readOnly: true
      chargeType:
        description: The type of the charge. Could be actual or forecast
        type: string
        enum:
        - Actual
        - Forecast
        x-ms-enum:
          name: ChargeType
          modelAsString: true
      confidenceLevels:
        description: The details about the forecast confidence levels. This is populated only when chargeType is Forecast.
        type: array
        items:
          type: object
          properties:
            percentage:
              description: The percentage level of the confidence
              type: number
              format: decimal
              readOnly: true
            bound:
              description: The boundary of the percentage, values could be 'Upper' or 'Lower'
              type: string
              enum:
              - Upper
              - Lower
              x-ms-enum:
                name: Bound
                modelAsString: true
            value:
              description: The amount of forecast within the percentage level
              type: number
              format: decimal
              readOnly: true
        readOnly: true
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  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.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'