swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Savings Plan Order Aliases API
schemes:
- https
tags:
- name: Savings Plan Order Aliases
paths:
  /providers/Microsoft.BillingBenefits/savingsPlanOrderAliases/{savingsPlanOrderAliasName}:
    put:
      description: Create a savings plan. Learn more about permissions needed at https://go.microsoft.com/fwlink/?linkid=2215851
      operationId: microsoftAzureSavingsplanorderaliasCreate
      externalDocs:
        url: https://go.microsoft.com/fwlink/?linkid=2215851/
      tags:
      - Savings Plan Order Aliases
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        SavingsPlanOrderAliasCreate:
          $ref: ./examples/SavingsPlanOrderAliasCreate.json
        SavingsPlanOrderAliasCreateSingleScope:
          $ref: ./examples/SavingsPlanOrderAliasCreateSingleScope.json
      parameters:
      - $ref: '#/parameters/SavingsPlanOrderAliasNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SavingsPlanOrderAliasRequestParameter'
      responses:
        '200':
          description: The resource has been created.
          schema:
            $ref: '#/definitions/SavingsPlanOrderAliasModel'
        '201':
          description: The request is being processed.
          schema:
            $ref: '#/definitions/SavingsPlanOrderAliasModel'
          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 Savingsplanorderaliases Savingsplanorderaliasname
    get:
      description: Get a savings plan.
      operationId: microsoftAzureSavingsplanorderaliasGet
      tags:
      - Savings Plan Order Aliases
      x-ms-examples:
        SavingsPlanOrderAliasGet:
          $ref: ./examples/SavingsPlanOrderAliasGet.json
      parameters:
      - $ref: '#/parameters/SavingsPlanOrderAliasNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The request is completed.
          schema:
            $ref: '#/definitions/SavingsPlanOrderAliasModel'
        default:
          description: Unexpected error.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Providers Microsoft Billingbenefits Savingsplanorderaliases Savingsplanorderaliasname
definitions:
  Price:
    type: object
    properties:
      currencyCode:
        type: string
        description: The ISO 4217 3-letter currency code for the currency used by this purchase record.
      amount:
        type: number
        format: double
  Sku:
    type: object
    description: The SKU to be applied for this resource
    properties:
      name:
        type: string
        description: Name of the SKU to be applied
  SavingsPlanOrderAliasProperties:
    type: object
    description: Savings plan properties
    properties:
      displayName:
        $ref: '#/definitions/DisplayName'
      savingsPlanOrderId:
        type: string
        description: Identifier of the savings plan 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'
      commitment:
        $ref: '#/definitions/Commitment'
      renew:
        $ref: '#/definitions/Renew'
  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
  Commitment:
    type: object
    description: Commitment towards the benefit.
    allOf:
    - $ref: '#/definitions/Price'
    properties:
      grain:
        type: string
        description: Commitment grain.
        enum:
        - Hourly
        x-ms-enum:
          name: CommitmentGrain
          modelAsString: 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
  SavingsPlanOrderAliasModel:
    type: object
    description: Savings plan order alias
    required:
    - sku
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/Resource
    properties:
      sku:
        description: Savings plan SKU
        $ref: '#/definitions/Sku'
      kind:
        type: string
        description: Resource provider kind
      properties:
        description: Savings plan order alias properties
        x-ms-client-flatten: true
        $ref: '#/definitions/SavingsPlanOrderAliasProperties'
    x-ms-azure-resource: true
  SubscriptionId:
    type: string
    description: Fully-qualified identifier of the subscription.
  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
  BillingScopeId:
    type: string
    description: Subscription that will be charged for purchasing the benefit
  ProvisioningState:
    type: string
    description: Provisioning state
    readOnly: true
    enum:
    - Creating
    - PendingBilling
    - ConfirmedBilling
    - Created
    - Succeeded
    - Cancelled
    - Expired
    - Failed
    x-ms-enum:
      name: ProvisioningState
      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
  SavingsPlanOrderAliasRequestParameter:
    name: body
    in: body
    x-ms-parameter-location: method
    required: true
    description: Request body for creating a savings plan order alias
    schema:
      $ref: '#/definitions/SavingsPlanOrderAliasModel'
  SavingsPlanOrderAliasNameParameter:
    name: savingsPlanOrderAliasName
    x-ms-parameter-location: method
    in: path
    required: true
    type: string
    pattern: ^[a-zA-Z0-9_\-\.]+$
    description: Name of the savings plan order alias
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'