swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ReservedInstances API
schemes:
- https
tags:
- name: ReservedInstances
paths:
  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries:
    get:
      tags:
      - ReservedInstances
      operationId: microsoftAzureReservationssummariesListbyreservationorder
      description: Lists the reservations summaries for daily or monthly grain.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        ReservationSummariesDaily:
          $ref: ./examples/ReservationSummariesDaily.json
        ReservationSummariesMonthly:
          $ref: ./examples/ReservationSummariesMonthly.json
      parameters:
      - $ref: '#/parameters/reservationOrderIdParameter'
      - $ref: '#/parameters/grainParameter'
      - name: $filter
        description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and  'ge'
        in: query
        required: false
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ReservationSummariesListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Capacity Reservationorders Reservationorderid Providers Microsoft Consumption Reservationsummaries
  ? /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries
  : get:
      tags:
      - ReservedInstances
      operationId: microsoftAzureReservationssummariesListbyreservationorderandreservation
      description: Lists the reservations summaries for daily or monthly grain.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        ReservationSummariesDailyWithReservationId:
          $ref: ./examples/ReservationSummariesDailyWithReservationId.json
        ReservationSummariesMonthlyWithReservationId:
          $ref: ./examples/ReservationSummariesMonthlyWithReservationId.json
      parameters:
      - $ref: '#/parameters/reservationOrderIdParameter'
      - $ref: '#/parameters/reservationIdParameter'
      - $ref: '#/parameters/grainParameter'
      - name: $filter
        description: Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and  'ge'
        in: query
        required: false
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ReservationSummariesListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Capacity Reservationorders Reservationorderid Reservations Reservationid Providers Microsoft Consumption Reservationsummaries
  /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails:
    get:
      tags:
      - ReservedInstances
      operationId: microsoftAzureReservationsdetailsListbyreservationorder
      description: Lists the reservations details for provided date range.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        ReservationDetails:
          $ref: ./examples/ReservationDetails.json
      parameters:
      - $ref: '#/parameters/reservationOrderIdParameter'
      - name: $filter
        description: 'Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports ''le'' and  ''ge'' '
        in: query
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ReservationDetailsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Capacity Reservationorders Reservationorderid Providers Microsoft Consumption Reservationdetails
  ? /providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails
  : get:
      tags:
      - ReservedInstances
      operationId: microsoftAzureReservationsdetailsListbyreservationorderandreservation
      description: Lists the reservations details for provided date range.
      externalDocs:
        url: https://docs.microsoft.com/en-us/rest/api/consumption/
      x-ms-examples:
        ReservationDetailsWithReservationId:
          $ref: ./examples/ReservationDetailsWithReservationId.json
      parameters:
      - $ref: '#/parameters/reservationOrderIdParameter'
      - $ref: '#/parameters/reservationIdParameter'
      - name: $filter
        description: 'Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports ''le'' and  ''ge'' '
        in: query
        required: true
        type: string
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ReservationDetailsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Capacity Reservationorders Reservationorderid Reservations Reservationid Providers Microsoft Consumption Reservationdetails
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
  ReservationDetailProperties:
    description: The properties of the reservation detail.
    properties:
      reservationOrderId:
        description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.
        type: string
        readOnly: true
      reservationId:
        description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.
        type: string
        readOnly: true
      skuName:
        description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
        type: string
        readOnly: true
      reservedHours:
        description: This is the total hours reserved for the day. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days.
        type: number
        format: decimal
        readOnly: true
      usageDate:
        description: The date on which consumption occurred.
        type: string
        format: date-time
        readOnly: true
      usedHours:
        description: This is the total hours used by the instance.
        type: number
        format: decimal
        readOnly: true
      instanceId:
        description: This identifier is the name of the resource or the fully qualified Resource ID.
        type: string
        readOnly: true
      totalReservedQuantity:
        description: This is the total count of instances that are reserved for the reservationId.
        type: number
        format: decimal
        readOnly: true
  ReservationDetail:
    description: reservation detail resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ReservationDetailProperties'
        title: Reservation Detail properties
  ReservationSummariesListResult:
    description: Result of listing reservation summaries.
    properties:
      value:
        description: The list of reservation summaries.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/ReservationSummary'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        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
  ReservationSummaryProperties:
    description: The properties of the reservation summary.
    properties:
      reservationOrderId:
        description: The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.
        type: string
        readOnly: true
      reservationId:
        description: The reservation ID is the identifier of a reservation within a reservation order. Each reservation is the grouping for applying the benefit scope and also specifies the number of instances to which the reservation benefit can be applied to.
        type: string
        readOnly: true
      skuName:
        description: This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.
        type: string
        readOnly: true
      reservedHours:
        description: This is the total hours reserved. E.g. if reservation for 1 instance was made on 1 PM, this will be 11 hours for that day and 24 hours from subsequent days
        type: number
        format: decimal
        readOnly: true
      usageDate:
        description: Data corresponding to the utilization record. If the grain of data is monthly, it will be first day of month.
        type: string
        format: date-time
        readOnly: true
      usedHours:
        description: Total used hours by the reservation
        type: number
        format: decimal
        readOnly: true
      minUtilizationPercentage:
        description: This is the minimum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 10%, this field will return 10% for that day
        type: number
        format: decimal
        readOnly: true
      avgUtilizationPercentage:
        description: This is average utilization for the entire time range. (day or month depending on the grain)
        type: number
        format: decimal
        readOnly: true
      maxUtilizationPercentage:
        description: This is the maximum hourly utilization in the usage time (day or month). E.g. if usage record corresponds to 12/10/2017 and on that for hour 4 and 5, utilization was 100%, this field will return 100% for that day.
        type: number
        format: decimal
        readOnly: true
  ReservationSummary:
    description: reservation summary resource.
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/ReservationSummaryProperties'
        title: Reservation Summary properties
  ReservationDetailsListResult:
    description: Result of listing reservation details.
    properties:
      value:
        description: The list of reservation details.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/ReservationDetail'
      nextLink:
        description: The link (url) to the next page of results.
        type: string
        readOnly: true
parameters:
  grainParameter:
    name: grain
    description: Can be daily or monthly
    x-ms-parameter-location: method
    in: query
    required: true
    type: string
    enum:
    - daily
    - monthly
    x-ms-enum:
      name: datagrain
      modelAsString: true
      values:
      - value: daily
        description: Daily grain of data
        name: DailyGrain
      - value: monthly
        description: Monthly grain of data
        name: MonthlyGrain
  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.
  reservationIdParameter:
    name: reservationId
    in: path
    description: Id of the reservation
    required: true
    type: string
    x-ms-parameter-location: method
  reservationOrderIdParameter:
    name: reservationOrderId
    in: path
    description: Order Id of the reservation
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'