swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReservationRecommendations API
schemes:
- https
tags:
- name: ReservationRecommendations
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Consumption/reservationRecommendations:
    get:
      tags:
      - ReservationRecommendations
      operationId: microsoftAzureReservationrecommendationsList
      description: List of recommendations for purchasing reserved instances.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        ReservationRecommendations:
          $ref: ./examples/ReservationRecommendationsList.json
        ReservationRecommendationsFilterByScopeLookBackPeriod:
          $ref: ./examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json
      parameters:
      - name: $filter
        description: May be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod.
        in: query
        required: false
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      - $ref: '#/parameters/subscriptionIdParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ReservationRecommendationsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Consumption Reservationrecommendations
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'
  ReservationRecommendationProperties:
    description: The properties of the reservation recommendation.
    properties:
      lookBackPeriod:
        description: The number of days of usage to look back for recommendation.
        type: string
        readOnly: true
      meterId:
        description: The meter id (GUID)
        type: string
        format: uuid
        readOnly: true
      term:
        description: RI recommendations in one or three year terms.
        type: string
        readOnly: true
      costWithNoReservedInstances:
        description: The total amount of cost without reserved instances.
        type: number
        format: decimal
        readOnly: true
      recommendedQuantity:
        description: Recommended quality for reserved instances.
        type: number
        format: decimal
        readOnly: true
      totalCostWithReservedInstances:
        description: The total amount of cost with reserved instances.
        type: number
        format: decimal
        readOnly: true
      netSavings:
        description: Total estimated savings with reserved instances.
        type: number
        format: decimal
        readOnly: true
      firstUsageDate:
        description: The usage date for looking back.
        type: string
        format: date-time
        readOnly: true
      scope:
        description: Shared or single recommendation.
        type: string
        readOnly: true
  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
  ReservationRecommendationsListResult:
    description: Result of listing reservation recommendations.
    properties:
      value:
        description: The list of reservation recommendations.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/ReservationRecommendation'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        readOnly: true
  ReservationRecommendation:
    description: Reservation recommendation resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    - $ref: '#/definitions/ResourceAttributes'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ReservationRecommendationProperties'
        title: Reservation Recommendation properties
  ResourceAttributes:
    description: The Resource model definition.
    properties:
      location:
        readOnly: true
        type: string
        description: Resource location
      sku:
        readOnly: true
        type: string
        description: Resource sku
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'