swagger: "2.0"
schemes:
  - https
host: management.azure.com
info:
  description: This API describe Azure Reservation
  title: Azure Reservation
  version: 2019-04-01
  x-apisguru-categories:
    - cloud
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
  x-origin:
    - format: swagger
      url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-04-01/reservations.json
      version: "2.0"
  x-preferred: true
  x-providerName: azure.com
  x-serviceName: reservations
  x-tags:
    - Azure
    - Microsoft
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  azure_auth:
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    description: Azure Active Directory OAuth2 Flow
    flow: implicit
    scopes:
      user_impersonation: impersonate your user account
    type: oauth2
parameters:
  ApiVersionParameter:
    description: Supported version for this document is 2019-04-01
    in: query
    name: api-version
    required: true
    type: string
  ExpandRenewPropertiesParameter:
    description: Supported value of this query is renewProperties
    in: query
    name: expand
    required: false
    type: string
    x-ms-parameter-location: method
  LocationIdParameter:
    description: Filters the skus based on the location specified in this parameter. This can be an azure region or global
    in: query
    name: location
    required: false
    type: string
    x-ms-parameter-location: method
  MergeParameter:
    description: Information needed for commercial request for a reservation
    in: body
    name: body
    required: true
    schema:
      $ref: "#/definitions/MergeRequest"
    x-ms-parameter-location: method
  PatchParameter:
    description: Information needed to patch a reservation item
    in: body
    name: parameters
    required: true
    schema:
      $ref: "#/definitions/Patch"
    x-ms-parameter-location: method
  PurchaseParameter:
    description: Information needed for calculate or purchase reservation
    in: body
    name: body
    required: true
    schema:
      $ref: "#/definitions/PurchaseRequest"
    x-ms-parameter-location: method
  ReservationIdParameter:
    description: Id of the Reservation Item
    in: path
    name: reservationId
    required: true
    type: string
    x-ms-parameter-location: method
  ReservationOrderIdParameter:
    description: Order Id of the reservation
    in: path
    name: reservationOrderId
    required: true
    type: string
    x-ms-parameter-location: method
  ReservedResourceTypeIdParameter:
    description: The type of the resource for which the skus should be provided.
    in: query
    name: reservedResourceType
    required: true
    type: string
    x-ms-parameter-location: method
  ScopeParameter:
    in: body
    name: body
    required: true
    schema:
      items:
        type: string
      type: array
    x-ms-parameter-location: method
  SplitParameter:
    description: Information needed to Split a reservation item
    in: body
    name: body
    required: true
    schema:
      $ref: "#/definitions/SplitRequest"
    x-ms-parameter-location: method
  SubscriptionIdParameter:
    description: Id of the subscription
    in: path
    name: subscriptionId
    required: true
    type: string
    x-ms-parameter-location: method
paths:
  /providers/Microsoft.Capacity/calculatePrice:
    post:
      description: Calculate price for placing a `ReservationOrder`.
      operationId: ReservationOrder_Calculate
      parameters:
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/PurchaseParameter"
      responses:
        "200":
          description: Detailed price info for purchasing `ReservationOrder`
          schema:
            $ref: "#/definitions/CalculatePriceResponse"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Calculate price for a `ReservationOrder`.
      tags:
        - Reservation, Calculate
      x-ms-examples:
        Purchase:
          parameters:
            api-version: 2019-04-01
            body:
              location: westus
              properties:
                appliedScopeType: Shared
                appliedScopes: null
                billingPlan: Monthly
                billingScopeId: /subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83
                displayName: TestReservationOrder
                quantity: "1"
                reservedResourceProperties:
                  instanceFlexibility: On
                reservedResourceType: VirtualMachines
                term: P1Y
              sku:
                name: standard_D1
          responses:
            "200":
              body:
                properties:
                  billingCurrencyTotal:
                    amount: 46
                    currencyCode: USD
                  paymentSchedule:
                    - billingCurrencyTotal:
                        amount: 40
                        currencyCode: EUR
                      dueDate: 2019-05-14
                      pricingCurrencyTotal:
                        amount: 46
                        currencyCode: USD
                    - dueDate: 2019-06-14
                      pricingCurrencyTotal:
                        amount: 46
                        currencyCode: USD
                    - dueDate: 2019-07-14
                      pricingCurrencyTotal:
                        amount: 46
                        currencyCode: USD
                  pricingCurrencyTotal:
                    amount: 46
                    currencyCode: USD
                  reservationOrderId: 6d9cec54-7de8-abcd-9de7-80f5d634f2d2
                  skuDescription: standard_D1
                  skuTitle: Reserved VM Instance, Standard_D1, US West, 1 Year
  /providers/Microsoft.Capacity/operations:
    get:
      description: List all the operations.
      operationId: Operation_List
      parameters:
        - $ref: "#/parameters/ApiVersionParameter"
      responses:
        "200":
          description: List all the operations.
          schema:
            $ref: "#/definitions/OperationList"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get operations.
      tags:
        - Operation
      x-ms-examples:
        GetOperations:
          parameters:
            api-version: 2019-04-01
          responses:
            "200":
              body:
                value:
                  - display:
                      description: Read All Reservations
                      operation: Get Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/read
                  - display:
                      description: Create any Reservation
                      operation: Create Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/write
                  - display:
                      description: Update any Reservation
                      operation: Update Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/action
                  - display:
                      description: Delete any Reservation
                      operation: Delete Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/delete
                  - display:
                      description: Read All Reservations
                      operation: Get Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/reservations/read
                  - display:
                      description: Create any Reservation
                      operation: Create Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/reservations/write
                  - display:
                      description: Update any Reservation
                      operation: Update Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/reservations/action
                  - display:
                      description: Delete any Reservation
                      operation: Delete Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/reservations/delete
                  - display:
                      description: Read All Reservations
                      operation: Get Reservations
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/reservationorders/reservations/revisions/read
                  - display:
                      description: Registers the Capacity resource provider and enables the creation of Capacity resources.
                      operation: Registers the Capacity Resource Provider.
                      provider: Microsoft Capacity
                      resource: Reservations
                    name: Microsoft.Capacity/register/action
      x-ms-pageable:
        nextLinkName: nextLink
  /providers/Microsoft.Capacity/reservationOrders:
    get:
      description: List of all the `ReservationOrder`s that the user has access to in the current tenant.
      operationId: ReservationOrder_List
      parameters:
        - $ref: "#/parameters/ApiVersionParameter"
      responses:
        "200":
          description: List of `ReservationOrder`s
          schema:
            $ref: "#/definitions/ReservationOrderList"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get all `ReservationOrder`s.
      tags:
        - Reservation
      x-ms-examples:
        ReservationOrderList:
          parameters:
            api-version: 2019-04-01
          responses:
            "200":
              body:
                nextLink: https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2017-11-01&%24skiptoken=eyJyZyI6IjIwNTkyMzdlLWY3MmYtNDczYi1hNTZiLWExOGJkM2UwMDhlZCIsImlnIjpudWxsLCJzdCI6bnVsbH0%3d
                value:
                  - etag: 7
                    id: /providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443
                    name: 1e6407ba-37a5-499f-80ed-a3f0f338e443
                    properties:
                      billingPlan: Monthly
                      createdDateTime: 2017-08-29T21:22:56.8541664Z
                      displayName: cabri
                      expiryDate: 2018-08-29
                      originalQuantity: 1
                      provisioningState: Succeeded
                      requestDateTime: 2017-08-29T21:20:23.8134834Z
                      reservations:
                        - id: /providers/microsoft.capacity/reservationOrders/1e6407ba-37a5-499f-80ed-a3f0f338e443/reservations/cae5924e-7a15-419f-a369-124f52d4a106
                      term: P1Y
                    type: Microsoft.Capacity/reservationOrders
                  - etag: 7
                    id: /providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614
                    name: 1ea6e203-288e-4732-b9e1-da8bbe10c614
                    properties:
                      billingPlan: Monthly
                      createdDateTime: 2017-08-30T12:58:20.526Z
                      displayName: cabri
                      expiryDate: 2018-08-30
                      originalQuantity: 9
                      provisioningState: Succeeded
                      requestDateTime: 2017-08-30T12:55:40.2799114Z
                      reservations:
                        - id: /providers/microsoft.capacity/reservationOrders/1ea6e203-288e-4732-b9e1-da8bbe10c614/reservations/d04fd48d-e3f6-42a3-a8f6-1ad0b7513e48
                      term: P1Y
                    type: Microsoft.Capacity/reservationOrders
                  - etag: 7
                    id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa
                    name: 1f14354c-dc12-4c8d-8090-6f295a3a34aa
                    properties:
                      billingPlan: Monthly
                      createdDateTime: 2017-08-30T03:51:49.8083758Z
                      displayName: cabri
                      expiryDate: 2018-08-30
                      originalQuantity: 7
                      provisioningState: Succeeded
                      requestDateTime: 2017-08-30T03:49:19.0252126Z
                      reservations:
                        - id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6
                      term: P1Y
                    type: Microsoft.Capacity/reservationOrders
      x-ms-pageable:
        nextLinkName: nextLink
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}":
    get:
      description: Get the details of the `ReservationOrder`.
      operationId: ReservationOrder_Get
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - description: May be used to expand the planInformation.
          in: query
          name: $expand
          required: false
          type: string
      responses:
        "200":
          description: Get the details of the `ReservationOrder`.
          schema:
            $ref: "#/definitions/ReservationOrderResponse"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get a specific `ReservationOrder`.
      tags:
        - Reservation
      x-ms-examples:
        GetReservation:
          parameters:
            api-version: 2019-04-01
            reservationOrderId: a075419f-44cc-497f-b68a-14ee811d48b9
          responses:
            "200":
              body:
                etag: 7
                id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa
                name: 1f14354c-dc12-4c8d-8090-6f295a3a34aa
                properties:
                  billingPlan: Monthly
                  createdDateTime: 2017-08-30T03:51:49.8083758Z
                  displayName: cabri
                  expiryDate: 2018-08-30
                  originalQuantity: 7
                  provisioningState: Succeeded
                  requestDateTime: 2017-08-30T03:49:19.0252126Z
                  reservations:
                    - id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6
                  term: P1Y
                type: Microsoft.Capacity/reservationOrders
        GetReservationWithExpandPayments:
          parameters:
            $expand: schedule
            api-version: 2019-04-01
            reservationOrderId: a075419f-44cc-497f-b68a-14ee811d48b9
          responses:
            "200":
              body:
                etag: 7
                id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa
                name: 1f14354c-dc12-4c8d-8090-6f295a3a34aa
                properties:
                  billingPlan: Monthly
                  createdDateTime: 2019-08-30T03:51:49Z
                  displayName: cabri
                  expiryDate: 2018-08-30
                  originalQuantity: 7
                  planInformation:
                    nextPaymentDueDate: 2019-09-30
                    pricingCurrencyTotal:
                      amount: 466
                      currencyCode: USD
                    startDate: 2019-08-30
                    transactions:
                      - billingAccount: "23456"
                        billingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        dueDate: 2019-09-30
                        paymentDate: 2019-09-30
                        pricingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        status: Succeeded
                      - billingAccount: "23456"
                        billingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        dueDate: 2019-10-30
                        extendedStatusInfo:
                          message: Credit card charge failed.
                          statusCode: PaymentDeclined
                        paymentDate: 2019-10-30
                        pricingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        status: Failed
                      - billingAccount: "23456"
                        billingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        dueDate: 2019-10-31
                        paymentDate: 2019-10-31
                        pricingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        status: Succeeded
                      - billingAccount: "23456"
                        billingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        dueDate: 2019-11-30
                        paymentDate: 2019-11-30
                        pricingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        status: Succeeded
                      - billingAccount: "23456"
                        billingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        dueDate: 2019-07-14
                        paymentDate: 2019-06-14
                        pricingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        status: Scheduled
                      - billingAccount: "23456"
                        billingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        dueDate: 2019-06-14
                        paymentDate: 2019-08-14
                        pricingCurrencyTotal:
                          amount: 466
                          currencyCode: USD
                        status: Scheduled
                  provisioningState: Succeeded
                  requestDateTime: 2019-08-30T03:49:19Z
                  reservations:
                    - id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6
                  term: P1Y
                type: Microsoft.Capacity/reservationOrders
    put:
      description: Purchase `ReservationOrder` and create resource under the specified URI.
      operationId: ReservationOrder_Purchase
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/PurchaseParameter"
      responses:
        "200":
          description: The resource has been created
          schema:
            $ref: "#/definitions/ReservationOrderResponse"
        "202":
          description: The request is accepted and is being processed. Operation result link is in location header.
          schema:
            $ref: "#/definitions/ReservationOrderResponse"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Purchase `ReservationOrder`
      tags:
        - Reservation, Purchase
      x-ms-examples:
        Purchase:
          parameters:
            api-version: 2019-04-01
            body:
              location: westus
              properties:
                appliedScopeType: Shared
                appliedScopes: null
                billingPlan: Monthly
                billingScopeId: /subscriptions/ed3a1871-612d-abcd-a849-c2542a68be83
                displayName: TestReservationOrder
                quantity: "1"
                renew: false
                reservedResourceProperties:
                  instanceFlexibility: On
                reservedResourceType: VirtualMachines
                term: P1Y
              sku:
                name: standard_D1
            reservationOrderId: a075419f-44cc-497f-b68a-14ee811d48b9
          responses:
            "200":
              body:
                etag: 7
                id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa
                name: 1f14354c-dc12-4c8d-8090-6f295a3a34aa
                properties:
                  billingPlan: Monthly
                  createdDateTime: 2017-08-30T03:51:49.8083758Z
                  displayName: cabri
                  expiryDate: 2018-08-30
                  originalQuantity: 7
                  provisioningState: Succeeded
                  requestDateTime: 2017-08-30T03:49:19.0252126Z
                  reservations:
                    - id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6
                  term: P1Y
                type: Microsoft.Capacity/reservationOrders
            "202":
              body:
                etag: 7
                id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa
                name: 1f14354c-dc12-4c8d-8090-6f295a3a34aa
                properties:
                  billingPlan: Monthly
                  createdDateTime: 2017-08-30T03:51:49.8083758Z
                  displayName: cabri
                  expiryDate: 2018-08-30
                  originalQuantity: 7
                  provisioningState: Succeeded
                  requestDateTime: 2017-08-30T03:49:19.0252126Z
                  reservations:
                    - id: /providers/microsoft.capacity/reservationOrders/1f14354c-dc12-4c8d-8090-6f295a3a34aa/reservations/c8c926bd-fc5d-4e29-9d43-b68340ac23a6
                  term: P1Y
                type: Microsoft.Capacity/reservationOrders
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/merge":
    post:
      description: Merge the specified `Reservation`s into a new `Reservation`. The two `Reservation`s being merged must have same properties.
      operationId: Reservation_Merge
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/MergeParameter"
      responses:
        "200":
          description: Returns the `Reservation` created after the merge.
          schema:
            items:
              $ref: "#/definitions/ReservationResponse"
            type: array
        "202":
          description: The request is accepted and is being processed
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Merges two `Reservation`s.
      tags:
        - Reservation, Merge
      x-ms-examples:
        Merge:
          parameters:
            api-version: 2019-04-01
            body:
              properties:
                sources:
                  - /providers/Microsoft.Capacity/reservationOrders/c0565a8a-4491-4e77-b07b-5e6d66718e1c/reservations/cea04232-932e-47db-acb5-e29a945ecc73
                  - /providers/Microsoft.Capacity/reservationOrders/c0565a8a-4491-4e77-b07b-5e6d66718e1c/reservations/5bf54dc7-dacd-4f46-a16b-7b78f4a59799
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                - etag: 5
                  id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                  location: eastus
                  name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/00238563-7312-4c20-a134-8c030bf938a7
                  properties:
                    appliedScopeType: Single
                    appliedScopes:
                      - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                    billingPlan: Monthly
                    billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                    displayName: cabri_test
                    effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                    expiryDate: 2018-09-22
                    extendedStatusInfo:
                      message: This reservation was merged and is no longer active.
                      statusCode: Merged
                    instanceFlexibility: Off
                    lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                    mergeProperties:
                      mergeDestination: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                    provisioningState: Cancelled
                    quantity: 1
                    renew: false
                    reservedResourceType: VirtualMachines
                    skuDescription: D1 v2
                    splitProperties:
                      splitSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                  sku:
                    name: Standard_DS1_v2
                  type: Microsoft.Capacity/reservationOrders/reservations
                - etag: 4
                  id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  location: eastus
                  name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  properties:
                    appliedScopeType: Single
                    appliedScopes:
                      - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                    billingPlan: Monthly
                    billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                    displayName: cabri_test
                    effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                    expiryDate: 2018-09-22
                    extendedStatusInfo:
                      message: This reservation was merged and is no longer active.
                      statusCode: Merged
                    instanceFlexibility: Off
                    lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                    mergeProperties:
                      mergeDestination: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                    provisioningState: Cancelled
                    quantity: 2
                    renew: false
                    reservedResourceType: VirtualMachines
                    skuDescription: D1 v2
                    splitProperties:
                      splitSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                  sku:
                    name: Standard_DS1_v2
                  type: Microsoft.Capacity/reservationOrders/reservations
                - etag: 2
                  id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                  location: eastus
                  name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc
                  properties:
                    appliedScopeType: Single
                    appliedScopes:
                      - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                    billingPlan: Monthly
                    billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                    displayName: cabri_test
                    effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                    expiryDate: 2018-09-22
                    instanceFlexibility: Off
                    lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                    mergeProperties:
                      mergeSources:
                        - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                        - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                    provisioningState: Succeeded
                    quantity: 3
                    renew: false
                    reservedResourceType: VirtualMachines
                    skuDescription: D1 v2
                  sku:
                    name: Standard_DS1_v2
                  type: Microsoft.Capacity/reservationOrders/reservations
            "202": {}
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations":
    get:
      description: List `Reservation`s within a single `ReservationOrder`.
      operationId: Reservation_List
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
      responses:
        "200":
          description: List `Reservation`s within a single `ReservationOrder`.
          schema:
            $ref: "#/definitions/ReservationList"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get `Reservation`s in a given reservation Order
      tags:
        - Reservation
      x-ms-examples:
        ReservationList:
          parameters:
            api-version: 2019-04-01
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                value:
                  - etag: 10
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/bcae77cd-3119-4766-919f-b50d36c75c7a
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      billingPlan: Monthly
                      billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T01:00:30.9253826Z
                      expiryDate: 2018-09-22
                      extendedStatusInfo:
                        message: This reservation was split and is no longer active.
                        statusCode: Split
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T01:00:36.3191627Z
                      provisioningState: Cancelled
                      quantity: 3
                      renew: false
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                      splitProperties:
                        splitDestinations:
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations
                  - etag: 5
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/00238563-7312-4c20-a134-8c030bf938a7
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      billingPlan: Monthly
                      billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                      expiryDate: 2018-09-22
                      extendedStatusInfo:
                        message: This reservation was merged and is no longer active.
                        statusCode: Merged
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                      mergeProperties:
                        mergeDestination: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                      provisioningState: Cancelled
                      quantity: 1
                      renew: false
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                      splitProperties:
                        splitSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations
                  - etag: 4
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      billingPlan: Monthly
                      billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                      expiryDate: 2018-09-22
                      extendedStatusInfo:
                        message: This reservation was merged and is no longer active.
                        statusCode: Merged
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                      mergeProperties:
                        mergeDestination: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                      provisioningState: Cancelled
                      quantity: 2
                      renew: false
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                      splitProperties:
                        splitSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations
                  - etag: 2
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      billingPlan: Monthly
                      billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                      expiryDate: 2018-09-22
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                      mergeProperties:
                        mergeSources:
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                      provisioningState: Succeeded
                      quantity: 3
                      renew: false
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations
      x-ms-pageable:
        nextLinkName: nextLink
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}":
    get:
      description: Get specific `Reservation` details.
      operationId: Reservation_Get
      parameters:
        - $ref: "#/parameters/ReservationIdParameter"
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/ExpandRenewPropertiesParameter"
      responses:
        "200":
          description: Get `Reservation` details.
          schema:
            $ref: "#/definitions/ReservationResponse"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get `Reservation` details.
      tags:
        - Reservation
      x-ms-examples:
        GetReservation:
          parameters:
            api-version: 2019-04-01
            expand: renewProperties
            reservationId: 6ef59113-3482-40da-8d79-787f823e34bc
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                etag: 2
                id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                location: eastus
                name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc
                properties:
                  appliedScopeType: Single
                  appliedScopes:
                    - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                  billingPlan: Monthly
                  billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                  displayName: cabri_test
                  effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                  expiryDate: 2018-09-22
                  instanceFlexibility: Off
                  lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                  mergeProperties:
                    mergeSources:
                      - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                      - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  provisioningState: Succeeded
                  quantity: 3
                  renew: false
                  renewDestination: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                  renewProperties:
                    billingCurrencyTotal:
                      amount: 466
                      currencyCode: USD
                    pricingCurrencyTotal:
                      amount: 466
                      currencyCode: USD
                    purchaseProperties:
                      location: westus
                      properties:
                        appliedScopeType: Shared
                        billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                        displayName: Renew_Test_0618
                        quantity: 2
                        renew: false
                        reservedResourceProperties:
                          instanceFlexibility: On
                        reservedResourceType: VirtualMachines
                        term: P1Y
                      sku:
                        name: Standard_D1
                  renewSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                  reservedResourceType: VirtualMachines
                  skuDescription: D1 v2
                  term: P1Y
                sku:
                  name: Standard_DS1_v2
                type: Microsoft.Capacity/reservationOrders/reservations
    patch:
      description: Updates the applied scopes of the `Reservation`.
      operationId: Reservation_Update
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ReservationIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/PatchParameter"
      responses:
        "200":
          description: Returns the updated `Reservation`.
          schema:
            $ref: "#/definitions/ReservationResponse"
        "202":
          description: The request is accepted and is being processed
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Updates a `Reservation`.
      tags:
        - Reservation
        - ApplyScope
      x-ms-examples:
        PatchReservation:
          parameters:
            api-version: 2019-04-01
            parameters:
              properties:
                appliedScopeType: Shared
                instanceFlexibility: Off
            reservationId: 6ef59113-3482-40da-8d79-787f823e34bc
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                etag: 4
                id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc
                location: eastus
                name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc
                properties:
                  appliedScopeType: Shared
                  billingPlan: Monthly
                  billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                  displayName: cabri_test
                  effectiveDateTime: 2017-09-22T23:57:48.1891638Z
                  expiryDate: 2018-09-22
                  instanceFlexibility: Off
                  lastUpdatedDateTime: 2017-09-22T23:57:54.3768768Z
                  mergeProperties:
                    mergeSources:
                      - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                      - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  provisioningState: Succeeded
                  quantity: 3
                  renew: false
                  reservedResourceType: VirtualMachines
                  skuDescription: D1 v2
                sku:
                  name: Standard_DS1_v2
                type: Microsoft.Capacity/reservationOrders/reservations
            "202": {}
      x-ms-long-running-operation: true
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}/availableScopes":
    post:
      description: |
        Get Available Scopes for `Reservation`.
      operationId: Reservation_AvailableScopes
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ReservationIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/ScopeParameter"
      responses:
        "200":
          description: List of `Subscription`s created after the filter.
          schema:
            $ref: "#/definitions/Properties"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get Available Scopes for `Reservation`.
      tags:
        - Reservation, AvailableScopes
      x-ms-examples:
        AvailableScopes:
          parameters:
            api-version: 2019-04-01
            body:
              properties:
                scopes:
                  - /subscriptions/efc7c997-7700-4a74-b731-55aec16c15e9
            reservationId: 356e7ae4-84d0-4da6-ab4b-d6b94f3557da
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                properties:
                  scopes:
                    - scope: /subscriptions/efc7c997-7700-4a74-b731-55aec16c15e9
                      valid: true
      x-ms-long-running-operation: true
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}/revisions":
    get:
      description: List of all the revisions for the `Reservation`.
      operationId: Reservation_ListRevisions
      parameters:
        - $ref: "#/parameters/ReservationIdParameter"
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
      responses:
        "200":
          description: List of all the revisions for the `Reservation`.
          schema:
            $ref: "#/definitions/ReservationList"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get `Reservation` revisions.
      tags:
        - Reservation
      x-ms-examples:
        ReservationRevisions:
          parameters:
            api-version: 2019-04-01
            reservationId: 6ef59113-3482-40da-8d79-787f823e34bc
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                value:
                  - etag: 4
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/4
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/4
                    properties:
                      appliedScopeType: Shared
                      billingPlan: Monthly
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T23:57:48.1891638Z
                      expiryDate: 2018-09-22
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T23:57:54.3768768Z
                      mergeProperties:
                        mergeSources:
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                      provisioningState: Succeeded
                      quantity: 3
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations/revisions
                  - etag: 3
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/3
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/3
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      billingPlan: Monthly
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                      expiryDate: 2018-09-22
                      extendedStatusInfo:
                        message: An operation is in progress on your reservation. Please wait for operation to complete before taking further action
                        statusCode: Pending
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T23:57:47.488284Z
                      mergeProperties:
                        mergeSources:
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                      provisioningState: Succeeded
                      quantity: 3
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations/revisions
                  - etag: 2
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/2
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/2
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      billingPlan: Monthly
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T22:46:32.7632798Z
                      expiryDate: 2018-09-22
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T22:46:32.7632798Z
                      mergeProperties:
                        mergeSources:
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                      provisioningState: Succeeded
                      quantity: 3
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations/revisions
                  - etag: 1
                    id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/6ef59113-3482-40da-8d79-787f823e34bc/revisions/1
                    location: eastus
                    name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/6ef59113-3482-40da-8d79-787f823e34bc/1
                    properties:
                      appliedScopeType: Single
                      appliedScopes:
                        - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                      displayName: cabri_test
                      effectiveDateTime: 2017-09-22T22:46:27.3313607Z
                      expiryDate: 2018-09-22
                      instanceFlexibility: On
                      lastUpdatedDateTime: 2017-09-22T22:46:27.3313607Z
                      mergeProperties:
                        mergeSources:
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                          - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                      provisioningState: Creating
                      quantity: 3
                      reservedResourceType: VirtualMachines
                      skuDescription: D1 v2
                    sku:
                      name: Standard_DS1_v2
                    type: Microsoft.Capacity/reservationOrders/reservations/revisions
      x-ms-pageable:
        nextLinkName: nextLink
  "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/split":
    post:
      description: Split a `Reservation` into two `Reservation`s with specified quantity distribution.
      operationId: Reservation_Split
      parameters:
        - $ref: "#/parameters/ReservationOrderIdParameter"
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/SplitParameter"
      responses:
        "200":
          description: List of `Reservation`s created after the split operation.
          schema:
            items:
              $ref: "#/definitions/ReservationResponse"
            type: array
        "202":
          description: The request is accepted and is being processed
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Split the `Reservation`.
      tags:
        - Reservation, Split
      x-ms-examples:
        Split:
          parameters:
            api-version: 2019-04-01
            body:
              properties:
                quantities:
                  - 1
                  - 2
                reservationId: /providers/Microsoft.Capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
            reservationOrderId: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da
          responses:
            "200":
              body:
                - etag: 2
                  id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                  location: eastus
                  name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/00238563-7312-4c20-a134-8c030bf938a7
                  properties:
                    appliedScopeType: Single
                    appliedScopes:
                      - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                    billingPlan: Monthly
                    billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                    displayName: cabri_test
                    effectiveDateTime: 2017-09-22T01:00:30.9253826Z
                    expiryDate: 2018-09-22
                    instanceFlexibility: Off
                    lastUpdatedDateTime: 2017-09-22T01:00:36.3191627Z
                    provisioningState: Succeeded
                    quantity: 1
                    renew: false
                    reservedResourceType: VirtualMachines
                    skuDescription: D1 v2
                    splitProperties:
                      splitSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                  sku:
                    name: Standard_DS1_v2
                  type: Microsoft.Capacity/reservationOrders/reservations
                - etag: 2
                  id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  location: eastus
                  name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  properties:
                    appliedScopeType: Single
                    appliedScopes:
                      - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                    billingPlan: Monthly
                    billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                    displayName: cabri_test
                    effectiveDateTime: 2017-09-22T01:00:30.9253826Z
                    expiryDate: 2018-09-22
                    instanceFlexibility: Off
                    lastUpdatedDateTime: 2017-09-22T01:00:36.3191627Z
                    provisioningState: Succeeded
                    quantity: 2
                    renew: false
                    reservedResourceType: VirtualMachines
                    skuDescription: D1 v2
                    splitProperties:
                      splitSource: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                  sku:
                    name: Standard_DS1_v2
                  type: Microsoft.Capacity/reservationOrders/reservations
                - etag: 10
                  id: /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/bcae77cd-3119-4766-919f-b50d36c75c7a
                  location: eastus
                  name: 276e7ae4-84d0-4da6-ab4b-d6b94f3557da/bcae77cd-3119-4766-919f-b50d36c75c7a
                  properties:
                    appliedScopeType: Single
                    appliedScopes:
                      - /subscriptions/98df3792-7962-4f18-8be2-d5576f122de3
                    billingPlan: Monthly
                    billingScopeId: /subscriptions/19376483-64b8-49e4-a931-d5248828720a
                    displayName: cabri_test
                    effectiveDateTime: 2017-09-22T01:00:30.9253826Z
                    expiryDate: 2018-09-22
                    extendedStatusInfo:
                      message: This reservation was split and is no longer active.
                      statusCode: Split
                    instanceFlexibility: Off
                    lastUpdatedDateTime: 2017-09-22T01:00:36.3191627Z
                    provisioningState: Cancelled
                    quantity: 3
                    renew: false
                    reservedResourceType: VirtualMachines
                    skuDescription: D1 v2
                    splitProperties:
                      splitDestinations:
                        - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/00238563-7312-4c20-a134-8c030bf938a7
                        - /providers/microsoft.capacity/reservationOrders/276e7ae4-84d0-4da6-ab4b-d6b94f3557da/reservations/e0e4b4f5-77ea-4984-9ee4-6bf9850ee6de
                  sku:
                    name: Standard_DS1_v2
                  type: Microsoft.Capacity/reservationOrders/reservations
            "202": {}
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
  "/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/appliedReservations":
    get:
      description: Get applicable `Reservation`s that are applied to this subscription or a resource group under this subscription.
      operationId: GetAppliedReservationList
      parameters:
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/SubscriptionIdParameter"
      responses:
        "200":
          description: Applicable `Reservation`s.
          schema:
            $ref: "#/definitions/AppliedReservations"
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get list of applicable `Reservation`s.
      tags:
        - AppliedReservation
      x-ms-examples:
        AppliedReservationList:
          parameters:
            api-version: 2019-04-01
            subscriptionId: 23bc208b-083f-4901-ae85-4f98c0c3b4b6
          responses:
            "200":
              body:
                id: /subscriptions/23bc208b-083f-4901-ae85-4f98c0c3b4b6/providers/microsoft.capacity/AppliedReservations/default
                name: default
                properties:
                  reservationOrderIds:
                    value:
                      - /providers/Microsoft.Capacity/reservationorders/e1eccf0b-2db4-4e84-97e7-98b50e9d46f7
                      - /providers/Microsoft.Capacity/reservationorders/741a32eb-6158-4cee-9642-a0243ae79fac
                      - /providers/Microsoft.Capacity/reservationorders/e061223d-fcff-4d10-bd49-56a740cfb96a
                      - /providers/Microsoft.Capacity/reservationorders/2eeb7234-970e-4663-b60b-85241b515901
                      - /providers/Microsoft.Capacity/reservationorders/9db2f4c5-b1c5-42a8-bd79-ee56cdde2c7f
                      - /providers/Microsoft.Capacity/reservationorders/5da7a877-6d6e-44af-8880-ed3f533bf928
                      - /providers/Microsoft.Capacity/reservationorders/f65b0d0a-f945-4105-821c-d00bc8bacde8
                      - /providers/Microsoft.Capacity/reservationorders/51304124-e477-4b07-b9fa-03b05c8b924b
                      - /providers/Microsoft.Capacity/reservationorders/f5409b98-8a42-4dc6-be0a-cc59bef4d0db
                      - /providers/Microsoft.Capacity/reservationorders/a495550a-80a4-46f8-8843-34d4df46f9a6
                      - /providers/Microsoft.Capacity/reservationorders/1a966e18-c272-4ce1-a0c2-d4e1039023c3
                      - /providers/Microsoft.Capacity/reservationorders/939310b4-f9de-4645-9569-ab5b6cfe958e
                      - /providers/Microsoft.Capacity/reservationorders/4193a889-7c3b-44dc-8b7b-bfd7aad6c723
                type: Microsoft.Capacity/AppliedReservations
  "/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs":
    get:
      operationId: GetCatalog
      parameters:
        - $ref: "#/parameters/ApiVersionParameter"
        - $ref: "#/parameters/SubscriptionIdParameter"
        - $ref: "#/parameters/ReservedResourceTypeIdParameter"
        - $ref: "#/parameters/LocationIdParameter"
      responses:
        "200":
          description: List of available resources
          schema:
            items:
              $ref: "#/definitions/Catalog"
            type: array
        default:
          description: Unexpected error
          schema:
            $ref: "#/definitions/Error"
      summary: Get the regions and skus that are available for RI purchase for the specified Azure subscription.
      tags:
        - Catalog
      x-ms-examples:
        Catalog:
          parameters:
            api-version: 2019-04-01
            location: eastus
            reservedResourceType: VirtualMachines
            subscriptionId: 23bc208b-083f-4901-ae85-4f98c0c3b4b6
          responses:
            "200":
              body:
                - billingPlans:
                    P1Y:
                      - Upfront
                      - Monthly
                    P3Y:
                      - Upfront
                      - Monthly
                  locations:
                    - eastus
                  name: Standard_DS5_v2
                  resourceType: VirtualMachines
                  restrictions: []
                  skuProperties:
                    - name: Cores
                      value: "16"
                    - name: ProductTitle
                      value: DSv2 Series, DS5
                    - name: ProductShortName
                      value: DSv2 Series
                    - name: SKUName
                      value: DS5 v2
                    - name: MeterId
                      value: 12bc208b-083f-4901-ae85-4f98c0c3b4b8
                  terms:
                    - P1Y
                    - P3Y
                - billingPlans:
                    - P1Y:
                        - Upfront
                        - Monthly
                    - P3Y:
                        - Upfront
                        - Monthly
                  locations:
                    - eastus
                  name: Standard_D1
                  resourceType: VirtualMachines
                  restrictions:
                    - reasonCode: NotAvailableForSubscription
                      type: Term
                      values:
                        - P1Y
                    - reasonCode: NotAvailableForSubscription
                      type: Term
                      values:
                        - P3Y
                  skuProperties:
                    - name: Cores
                      value: "1"
                    - name: ProductTitle
                      value: D Series, D1
                    - name: ProductShortName
                      value: D Series
                    - name: SKUName
                      value: D1
                    - name: MeterId
                      value: 12bc208b-083f-4901-ae85-4f98c0c3b4b8
                  terms:
                    - P1Y
                    - P3Y
                - billingPlans:
                    - P1Y:
                        - Upfront
                        - Monthly
                    - P3Y:
                        - Upfront
                        - Monthly
                  locations:
                    - eastus
                  name: Standard_F2
                  resourceType: VirtualMachines
                  restrictions:
                    - reasonCode: NotAvailableForSubscription
                      type: Location
                      values:
                        - eastus
                  skuProperties:
                    - name: Cores
                      value: "2"
                    - name: ProductTitle
                      value: F Series, F2
                    - name: ProductShortName
                      value: F Series
                    - name: SKUName
                      value: F2
                    - name: MeterId
                      value: 12bc208b-083f-4901-ae85-4f98c0c3b4b8
                  terms:
                    - P1Y
                    - P3Y
definitions:
  AppliedReservationList:
    properties:
      nextLink:
        description: Url to get the next page of reservations
        type: string
      value:
        items:
          description: Reservation resource Id. "/providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}"
          type: string
        type: array
    type: object
  AppliedReservations:
    properties:
      id:
        description: Identifier of the applied reservations
        readOnly: true
        type: string
      name:
        description: Name of resource
        readOnly: true
        type: string
      properties:
        $ref: "#/definitions/AppliedReservationsProperties"
        x-ms-client-flatten: true
      type:
        description: Type of resource. "Microsoft.Capacity/AppliedReservations"
        readOnly: true
        type: string
    type: object
  AppliedReservationsProperties:
    properties:
      reservationOrderIds:
        $ref: "#/definitions/AppliedReservationList"
    type: object
  AppliedScopeType:
    description: Type of the Applied Scope.
    enum:
      - Single
      - Shared
    type: string
    x-ms-enum:
      modelAsString: true
      name: AppliedScopeType
  AppliedScopes:
    description: List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.
    items:
      maxItems: 1
      minItems: 1
      type: string
    type: array
  BillingScopeId:
    description: Subscription that will be charged for purchasing Reservation
    type: string
  CalculatePriceResponse:
    properties:
      properties:
        $ref: "#/definitions/CalculatePriceResponseProperties"
    type: object
  CalculatePriceResponseProperties:
    properties:
      billingCurrencyTotal:
        description: Currency and amount that customer will be charged in customer's local currency. Tax is not included.
        properties:
          amount:
            type: number
          currencyCode:
            type: string
        type: object
      isBillingPartnerManaged:
        description: True if billing is managed by Microsoft Partner. Used only for CSP accounts.
        type: boolean
      paymentSchedule:
        items:
          $ref: "#/definitions/PaymentDetail"
        type: array
      pricingCurrencyTotal:
        description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included.
        properties:
          amount:
            type: number
          currencyCode:
            type: string
        type: object
      reservationOrderId:
        description: GUID that represents reservation order that can be placed after calculating price.
        type: string
      skuDescription:
        description: Description of SKU that is being purchased.
        type: string
      skuTitle:
        description: Title of SKU that is being purchased.
        type: string
    type: object
  Catalog:
    properties:
      billingPlans:
        additionalProperties:
          items:
            $ref: "#/definitions/ReservationBillingPlan"
          type: array
        description: The billing plan options available for this SKU.
        type: object
      locations:
        items:
          description: The set of locations that the SKU is available. If not specified, the SKU is available in all locations.
          type: string
        readOnly: true
        type: array
      name:
        description: The name of SKU
        readOnly: true
        type: string
      resourceType:
        description: The type of resource the SKU applies to.
        readOnly: true
        type: string
      restrictions:
        items:
          $ref: "#/definitions/SkuRestriction"
        readOnly: true
        type: array
      skuProperties:
        items:
          $ref: "#/definitions/SkuProperty"
        readOnly: true
        type: array
      terms:
        description: Available reservation terms for this resource
        items:
          $ref: "#/definitions/ReservationTerm"
        readOnly: true
        type: array
    type: object
  Error:
    properties:
      error:
        $ref: "#/definitions/ExtendedErrorInfo"
    type: object
  ErrorResponseCode:
    enum:
      - NotSpecified
      - InternalServerError
      - ServerTimeout
      - AuthorizationFailed
      - BadRequest
      - ClientCertificateThumbprintNotSet
      - InvalidRequestContent
      - OperationFailed
      - HttpMethodNotSupported
      - InvalidRequestUri
      - MissingTenantId
      - InvalidTenantId
      - InvalidReservationOrderId
      - InvalidReservationId
      - ReservationIdNotInReservationOrder
      - ReservationOrderNotFound
      - InvalidSubscriptionId
      - InvalidAccessToken
      - InvalidLocationId
      - UnauthenticatedRequestsThrottled
      - InvalidHealthCheckType
      - Forbidden
      - BillingScopeIdCannotBeChanged
      - AppliedScopesNotAssociatedWithCommerceAccount
      - PatchValuesSameAsExisting
      - RoleAssignmentCreationFailed
      - ReservationOrderCreationFailed
      - ReservationOrderNotEnabled
      - CapacityUpdateScopesFailed
      - UnsupportedReservationTerm
      - ReservationOrderIdAlreadyExists
      - RiskCheckFailed
      - CreateQuoteFailed
      - ActivateQuoteFailed
      - NonsupportedAccountId
      - PaymentInstrumentNotFound
      - MissingAppliedScopesForSingle
      - NoValidReservationsToReRate
      - ReRateOnlyAllowedForEA
      - OperationCannotBePerformedInCurrentState
      - InvalidSingleAppliedScopesCount
      - InvalidFulfillmentRequestParameters
      - NotSupportedCountry
      - InvalidRefundQuantity
      - PurchaseError
      - BillingCustomerInputError
      - BillingPaymentInstrumentSoftError
      - BillingPaymentInstrumentHardError
      - BillingTransientError
      - BillingError
      - FulfillmentConfigurationError
      - FulfillmentOutOfStockError
      - FulfillmentTransientError
      - FulfillmentError
      - CalculatePriceFailed
    type: string
    x-ms-enum:
      modelAsString: true
      name: ErrorResponseCode
  ExtendedErrorInfo:
    properties:
      code:
        $ref: "#/definitions/ErrorResponseCode"
      message:
        type: string
    type: object
  ExtendedStatusInfo:
    properties:
      message:
        description: The message giving detailed information about the status code.
        type: string
      statusCode:
        $ref: "#/definitions/ReservationStatusCode"
    type: object
  InstanceFlexibility:
    description: Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.
    enum:
      - On
      - Off
    type: string
    x-ms-enum:
      modelAsString: true
      name: InstanceFlexibility
  MergeProperties:
    properties:
      sources:
        description: Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
        items:
          type: string
        type: array
    type: object
  MergeRequest:
    properties:
      properties:
        $ref: "#/definitions/MergeProperties"
        x-ms-client-flatten: true
    type: object
  OperationDisplay:
    properties:
      description:
        type: string
      operation:
        type: string
      provider:
        type: string
      resource:
        type: string
    type: object
  OperationList:
    properties:
      nextLink:
        description: Url to get the next page of items.
        type: string
      value:
        items:
          $ref: "#/definitions/OperationResponse"
        type: array
    type: object
  OperationResponse:
    properties:
      display:
        $ref: "#/definitions/OperationDisplay"
      name:
        type: string
      origin:
        type: string
    type: object
  Patch:
    properties:
      properties:
        $ref: "#/definitions/PatchProperties"
        x-ms-client-flatten: true
    type: object
  PatchProperties:
    properties:
      appliedScopeType:
        $ref: "#/definitions/AppliedScopeType"
      appliedScopes:
        $ref: "#/definitions/AppliedScopes"
      instanceFlexibility:
        $ref: "#/definitions/InstanceFlexibility"
      name:
        description: Name of the Reservation
        type: string
      renew:
        $ref: "#/definitions/Renew"
      renewProperties:
        properties:
          purchaseProperties:
            $ref: "#/definitions/PurchaseRequest"
        type: object
    type: object
  PaymentDetail:
    description: Information about payment related to a reservation order.
    properties:
      billingAccount:
        description: Shows the Account that is charged for this payment.
        type: string
      billingCurrencyTotal:
        $ref: "#/definitions/Price"
        description: Amount charged in Billing currency. Tax not included. Is null for future payments
      dueDate:
        description: Date when the payment needs to be done.
        format: date
        type: string
      extendedStatusInfo:
        $ref: "#/definitions/ExtendedStatusInfo"
      paymentDate:
        description: Date when the transaction is completed. Is null when it is scheduled.
        format: date
        type: string
      pricingCurrencyTotal:
        $ref: "#/definitions/Price"
        description: Amount in pricing currency. Tax not included.
      status:
        $ref: "#/definitions/PaymentStatus"
    type: object
  PaymentStatus:
    description: Describes whether the payment is completed, failed, cancelled or scheduled in the future.
    enum:
      - Succeeded
      - Failed
      - Scheduled
      - Cancelled
    type: string
    x-ms-enum:
      modelAsString: true
      name: PaymentStatus
  Price:
    properties:
      amount:
        format: double
        type: number
      currencyCode:
        description: The ISO 4217 3-letter currency code for the currency used by this purchase record.
        type: string
    type: object
  Properties:
    properties:
      properties:
        $ref: "#/definitions/SubscriptionScopeProperties"
    type: object
  PurchaseRequest:
    properties:
      location:
        description: The Azure Region where the reserved resource lives.
        type: string
      properties:
        $ref: "#/definitions/PurchaseRequestProperties"
        x-ms-client-flatten: true
      sku:
        $ref: "#/definitions/SkuName"
    type: object
  PurchaseRequestProperties:
    properties:
      appliedScopeType:
        $ref: "#/definitions/AppliedScopeType"
      appliedScopes:
        $ref: "#/definitions/AppliedScopes"
      billingPlan:
        $ref: "#/definitions/ReservationBillingPlan"
      billingScopeId:
        $ref: "#/definitions/BillingScopeId"
      displayName:
        description: Friendly name of the Reservation
        type: string
      quantity:
        $ref: "#/definitions/ReservationQuantity"
      renew:
        $ref: "#/definitions/Renew"
      reservedResourceProperties:
        description: Properties specific to each reserved resource type. Not required if not applicable.
        properties:
          instanceFlexibility:
            $ref: "#/definitions/InstanceFlexibility"
        type: object
      reservedResourceType:
        $ref: "#/definitions/ReservedResourceType"
      term:
        $ref: "#/definitions/ReservationTerm"
    type: object
  Renew:
    default: false
    description: Setting this to true will automatically purchase a new reservation on the expiration date time.
    type: boolean
  RenewPropertiesResponse:
    properties:
      billingCurrencyTotal:
        description: Currency and amount that customer will be charged in customer's local currency for renewal purchase. Tax is not included.
        properties:
          amount:
            type: number
          currencyCode:
            type: string
        type: object
      pricingCurrencyTotal:
        description: Amount that Microsoft uses for record. Used during refund for calculating refund limit. Tax is not included. This is locked price 30 days before expiry.
        properties:
          amount:
            type: number
          currencyCode:
            type: string
        type: object
      purchaseProperties:
        $ref: "#/definitions/PurchaseRequest"
    type: object
  ReservationBillingPlan:
    description: Represent the billing plans.
    enum:
      - Upfront
      - Monthly
    type: string
    x-ms-enum:
      modelAsString: true
      name: ReservationBillingPlan
  ReservationList:
    properties:
      nextLink:
        description: Url to get the next page of reservations.
        type: string
      value:
        items:
          $ref: "#/definitions/ReservationResponse"
        type: array
    type: object
  ReservationMergeProperties:
    properties:
      mergeDestination:
        description: Reservation Resource Id Created due to the merge. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
        type: string
      mergeSources:
        description: Resource Ids of the Source Reservation's merged to form this Reservation. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
        items:
          type: string
        type: array
    type: object
  ReservationOrderBillingPlanInformation:
    description: Information describing the type of billing plan for this reservation.
    properties:
      nextPaymentDueDate:
        description: For recurring billing plans, indicates the date when next payment will be processed. Null when total is paid off.
        format: date
        type: string
      pricingCurrencyTotal:
        $ref: "#/definitions/Price"
        description: Amount of money to be paid for the Order. Tax is not included.
      startDate:
        description: Date when the billing plan has started.
        format: date
        type: string
      transactions:
        items:
          $ref: "#/definitions/PaymentDetail"
        type: array
    type: object
  ReservationOrderList:
    properties:
      nextLink:
        description: Url to get the next page of reservationOrders.
        type: string
      value:
        items:
          $ref: "#/definitions/ReservationOrderResponse"
        type: array
    type: object
  ReservationOrderProperties:
    properties:
      billingPlan:
        $ref: "#/definitions/ReservationBillingPlan"
      createdDateTime:
        description: This is the DateTime when the reservation was created.
        format: date-time
        type: string
      displayName:
        description: Friendly name for user to easily identified the reservation.
        type: string
      expiryDate:
        description: This is the date when the Reservation will expire.
        format: date
        type: string
      originalQuantity:
        $ref: "#/definitions/ReservationQuantity"
      planInformation:
        $ref: "#/definitions/ReservationOrderBillingPlanInformation"
      provisioningState:
        description: Current state of the reservation.
        type: string
      requestDateTime:
        description: This is the DateTime when the reservation was initially requested for purchase.
        format: date-time
        type: string
      reservations:
        items:
          $ref: "#/definitions/ReservationResponse"
        type: array
      term:
        $ref: "#/definitions/ReservationTerm"
    type: object
  ReservationOrderResponse:
    properties:
      etag:
        type: integer
      id:
        description: Identifier of the reservation
        readOnly: true
        type: string
      name:
        description: Name of the reservation
        readOnly: true
        type: string
      properties:
        $ref: "#/definitions/ReservationOrderProperties"
        x-ms-client-flatten: true
      type:
        description: Type of resource. "Microsoft.Capacity/reservations"
        readOnly: true
        type: string
    type: object
    x-ms-azure-resource: true
  ReservationProperties:
    properties:
      appliedScopeType:
        $ref: "#/definitions/AppliedScopeType"
      appliedScopes:
        $ref: "#/definitions/AppliedScopes"
      billingPlan:
        $ref: "#/definitions/ReservationBillingPlan"
      billingScopeId:
        $ref: "#/definitions/BillingScopeId"
      displayName:
        description: Friendly name for user to easily identify the reservation
        type: string
      effectiveDateTime:
        description: DateTime of the Reservation starting when this version is effective from.
        format: date-time
        type: string
      expiryDate:
        description: This is the date when the Reservation will expire.
        format: date
        type: string
      extendedStatusInfo:
        $ref: "#/definitions/ExtendedStatusInfo"
      instanceFlexibility:
        $ref: "#/definitions/InstanceFlexibility"
      lastUpdatedDateTime:
        description: DateTime of the last time the Reservation was updated.
        format: date-time
        readOnly: true
        type: string
      mergeProperties:
        $ref: "#/definitions/ReservationMergeProperties"
      provisioningState:
        description: Current state of the reservation.
        type: string
      quantity:
        $ref: "#/definitions/ReservationQuantity"
      renew:
        $ref: "#/definitions/Renew"
      renewDestination:
        description: Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
        type: string
      renewProperties:
        $ref: "#/definitions/RenewPropertiesResponse"
      renewSource:
        description: Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
        type: string
      reservedResourceType:
        $ref: "#/definitions/ReservedResourceType"
      skuDescription:
        description: Description of the SKU in english.
        type: string
      splitProperties:
        $ref: "#/definitions/ReservationSplitProperties"
      term:
        $ref: "#/definitions/ReservationTerm"
    type: object
  ReservationQuantity:
    description: Quantity of the SKUs that are part of the Reservation. Must be greater than zero.
    format: int32
    type: integer
  ReservationResponse:
    properties:
      etag:
        type: integer
      id:
        description: Identifier of the reservation
        readOnly: true
        type: string
      location:
        description: The Azure Region where the reserved resource lives.
        readOnly: true
        type: string
      name:
        description: Name of the reservation
        readOnly: true
        type: string
      properties:
        $ref: "#/definitions/ReservationProperties"
      sku:
        $ref: "#/definitions/SkuName"
      type:
        description: Type of resource. "Microsoft.Capacity/reservationOrders/reservations"
        readOnly: true
        type: string
    type: object
    x-ms-azure-resource: true
  ReservationSplitProperties:
    properties:
      splitDestinations:
        description: List of destination Resource Id that are created due to split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
        items:
          type: string
        type: array
      splitSource:
        description: Resource Id of the Reservation from which this is split. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
        type: string
    type: object
  ReservationStatusCode:
    enum:
      - None
      - Pending
      - Active
      - PurchaseError
      - PaymentInstrumentError
      - Split
      - Merged
      - Expired
      - Succeeded
    type: string
    x-ms-enum:
      modelAsString: true
      name: ReservationStatusCode
  ReservationTerm:
    description: Represent the term of Reservation.
    enum:
      - P1Y
      - P3Y
    type: string
    x-ms-enum:
      modelAsString: true
      name: ReservationTerm
  ReservedResourceType:
    description: The type of the resource that is being reserved.
    enum:
      - VirtualMachines
      - SqlDatabases
      - SuseLinux
      - CosmosDb
      - RedHat
      - SqlDataWarehouse
      - VMwareCloudSimple
      - RedHatOsa
    type: string
    x-ms-enum:
      modelAsString: true
      name: ReservedResourceType
  ScopeProperties:
    properties:
      scope:
        type: string
      valid:
        type: boolean
    type: object
  SkuName:
    properties:
      name:
        type: string
    type: object
  SkuProperty:
    properties:
      name:
        description: An invariant to describe the feature.
        type: string
      value:
        description: An invariant if the feature is measured by quantity.
        type: string
    type: object
  SkuRestriction:
    properties:
      reasonCode:
        description: The reason for restriction.
        type: string
      type:
        description: The type of restrictions.
        type: string
      values:
        description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
        items:
          type: string
        type: array
    type: object
  SplitProperties:
    properties:
      quantities:
        description: List of the quantities in the new reservations to create.
        items:
          maxItems: 2
          minItems: 2
          type: integer
        type: array
      reservationId:
        description: Resource id of the reservation to be split. Format of the resource id should be /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}
        type: string
    type: object
  SplitRequest:
    properties:
      properties:
        $ref: "#/definitions/SplitProperties"
        x-ms-client-flatten: true
    type: object
  SubscriptionScopeProperties:
    properties:
      scopes:
        items:
          $ref: "#/definitions/ScopeProperties"
        type: array
    type: object
