swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Reservation Order Aliases API
schemes:
- https
tags:
- name: Reservation Order Aliases
paths:
  /providers/Microsoft.BillingBenefits/reservationOrderAliases/{reservationOrderAliasName}:
    put:
      description: Create a reservation order alias.
      operationId: microsoftAzureReservationorderaliasCreate
      tags:
      - Reservation Order Aliases
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        ReservationOrderAliasCreate:
          $ref: ./examples/ReservationOrderAliasCreate.json
      parameters:
      - $ref: '#/parameters/ReservationOrderAliasNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/ReservationOrderAliasRequestParameter'
      responses:
        '200':
          description: The resource has been created.
          schema:
            $ref: '#/definitions/ReservationOrderAliasResponse'
        '201':
          description: The request is being processed.
          schema:
            $ref: '#/definitions/ReservationOrderAliasResponse'
          headers:
            Azure-AsyncOperation:
              type: string
              description: URL for checking the ongoing status of the operation.
            Retry-After:
              type: integer
              format: int32
              description: Clients should wait for the Retry-After interval before polling again
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Put Providers Microsoft Billingbenefits Reservationorderaliases Reservationorderaliasname
    get:
      description: Get a reservation order alias.
      operationId: microsoftAzureReservationorderaliasGet
      tags:
      - Reservation Order Aliases
      x-ms-examples:
        ReservationOrderAliasGet:
          $ref: ./examples/ReservationOrderAliasGet.json
      parameters:
      - $ref: '#/parameters/ReservationOrderAliasNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The request is completed.
          schema:
            $ref: '#/definitions/ReservationOrderAliasResponse'
        default:
          description: Unexpected error.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Providers Microsoft Billingbenefits Reservationorderaliases Reservationorderaliasname
definitions:
  Sku:
    type: object
    description: The SKU to be applied for this resource
    properties:
      name:
        type: string
        description: Name of the SKU to be applied
  ReservationOrderAliasResponse:
    type: object
    description: Reservation order alias
    required:
    - sku
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      sku:
        description: Reservation order SKU
        $ref: '#/definitions/Sku'
      location:
        type: string
        description: The Azure Region where the reserved resource lives.
      properties:
        description: Reservation order alias response properties
        x-ms-client-flatten: true
        $ref: '#/definitions/ReservationOrderAliasResponseProperties'
    x-ms-azure-resource: true
  Term:
    type: string
    description: Represent benefit term in ISO 8601 format.
    enum:
    - P1Y
    - P3Y
    - P5Y
    x-ms-enum:
      name: Term
      modelAsString: true
  AppliedScopeType:
    type: string
    description: Type of the Applied Scope.
    enum:
    - Single
    - Shared
    - ManagementGroup
    x-ms-enum:
      name: AppliedScopeType
      modelAsString: true
  ReservationOrderAliasRequest:
    type: object
    description: Reservation order alias
    required:
    - sku
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      sku:
        description: Reservation order SKU
        $ref: '#/definitions/Sku'
      location:
        type: string
        description: The Azure Region where the reservation benefits are applied to.
      properties:
        description: Reservation order alias request properties
        x-ms-client-flatten: true
        $ref: '#/definitions/ReservationOrderAliasRequestProperties'
    x-ms-azure-resource: true
  ManagementGroupId:
    type: string
    description: Fully-qualified identifier of the management group where the benefit must be applied.
  TenantId:
    type: string
    description: Tenant ID where the benefit is applied.
  BillingPlan:
    type: string
    description: Represents the billing plan in ISO 8601 format. Required only for monthly billing plans.
    enum:
    - P1M
    x-ms-enum:
      name: BillingPlan
      modelAsString: true
  SubscriptionId:
    type: string
    description: Fully-qualified identifier of the subscription.
  ReservationOrderAliasRequestProperties:
    type: object
    description: Reservation properties
    properties:
      displayName:
        $ref: '#/definitions/DisplayName'
      billingScopeId:
        $ref: '#/definitions/BillingScopeId'
      term:
        $ref: '#/definitions/Term'
      billingPlan:
        $ref: '#/definitions/BillingPlan'
      appliedScopeType:
        $ref: '#/definitions/AppliedScopeType'
      appliedScopeProperties:
        $ref: '#/definitions/AppliedScopeProperties'
      quantity:
        type: integer
        format: int32
        description: Total Quantity of the SKUs purchased in the Reservation.
        minimum: 1
      renew:
        $ref: '#/definitions/Renew'
      reservedResourceType:
        description: The type of the resource that is being reserved.
        $ref: '#/definitions/ReservedResourceType'
      reviewDateTime:
        type: string
        format: date-time
        description: This is the date-time when the Azure Hybrid Benefit needs to be reviewed.
      reservedResourceProperties:
        type: object
        description: Properties specific to each reserved resource type. Not required if not applicable.
        properties:
          instanceFlexibility:
            $ref: '#/definitions/InstanceFlexibility'
  ResourceGroupId:
    type: string
    description: Fully-qualified identifier of the resource group.
  AppliedScopeProperties:
    type: object
    description: Properties specific to applied scope type. Not required if not applicable.
    properties:
      tenantId:
        $ref: '#/definitions/TenantId'
      managementGroupId:
        $ref: '#/definitions/ManagementGroupId'
      subscriptionId:
        $ref: '#/definitions/SubscriptionId'
      resourceGroupId:
        $ref: '#/definitions/ResourceGroupId'
      displayName:
        type: string
        description: Display name
  ReservationOrderAliasResponseProperties:
    type: object
    description: Reservation properties
    properties:
      displayName:
        $ref: '#/definitions/DisplayName'
      reservationOrderId:
        type: string
        description: Identifier of the reservation order created
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
      billingScopeId:
        $ref: '#/definitions/BillingScopeId'
      term:
        $ref: '#/definitions/Term'
      billingPlan:
        $ref: '#/definitions/BillingPlan'
      appliedScopeType:
        $ref: '#/definitions/AppliedScopeType'
      appliedScopeProperties:
        $ref: '#/definitions/AppliedScopeProperties'
      quantity:
        type: integer
        format: int32
        description: Total Quantity of the SKUs purchased in the Reservation.
      renew:
        $ref: '#/definitions/Renew'
      reservedResourceType:
        description: The type of the resource that is being reserved.
        $ref: '#/definitions/ReservedResourceType'
      reviewDateTime:
        type: string
        format: date-time
        description: This is the date-time when the Reservation needs to be reviewed.
      reservedResourceProperties:
        type: object
        description: Properties specific to each reserved resource type. Not required if not applicable.
        properties:
          instanceFlexibility:
            $ref: '#/definitions/InstanceFlexibility'
  BillingScopeId:
    type: string
    description: Subscription that will be charged for purchasing the benefit
  ReservedResourceType:
    type: string
    description: The type of the resource that is being reserved.
    enum:
    - VirtualMachines
    - SqlDatabases
    - SuseLinux
    - CosmosDb
    - RedHat
    - SqlDataWarehouse
    - VMwareCloudSimple
    - RedHatOsa
    - Databricks
    - AppService
    - ManagedDisk
    - BlockBlob
    - RedisCache
    - AzureDataExplorer
    - MySql
    - MariaDb
    - PostgreSql
    - DedicatedHost
    - SapHana
    - SqlAzureHybridBenefit
    - AVS
    - DataFactory
    - NetAppStorage
    - AzureFiles
    - SqlEdge
    - VirtualMachineSoftware
    x-ms-enum:
      name: ReservedResourceType
      modelAsString: true
  ProvisioningState:
    type: string
    description: Provisioning state
    readOnly: true
    enum:
    - Creating
    - PendingBilling
    - ConfirmedBilling
    - Created
    - Succeeded
    - Cancelled
    - Expired
    - Failed
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  InstanceFlexibility:
    type: string
    description: Turning this on will apply the reservation discount to other VMs in the same VM size group.
    enum:
    - 'On'
    - 'Off'
    x-ms-enum:
      name: InstanceFlexibility
      modelAsString: true
  Renew:
    type: boolean
    default: false
    description: Setting this to true will automatically purchase a new benefit on the expiration date time.
  DisplayName:
    type: string
    description: Display name
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    x-ms-parameter-location: client
    required: true
    description: The api-version to be used by the service
    type: string
  ReservationOrderAliasNameParameter:
    name: reservationOrderAliasName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9_\-\.]+$
    description: Name of the reservation order alias
  ReservationOrderAliasRequestParameter:
    name: body
    in: body
    x-ms-parameter-location: method
    required: true
    description: Request body for creating a reservation order alias
    schema:
      $ref: '#/definitions/ReservationOrderAliasRequest'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'