swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector CommitmentPlans API
schemes:
- https
tags:
- name: CommitmentPlans
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}
  : parameters:
    - $ref: '#/parameters/SubscriptionIdParameter'
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/CommitmentPlanNameParameter'
    - $ref: '#/parameters/APIVersionParameter'
    get:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureCommitmentplansGet
      description: Retrieve an Azure ML commitment plan by its subscription, resource group and name.
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CommitmentPlan'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Commitmentplans Commitmentplanname
    put:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureCommitmentplansCreateorupdate
      description: Create a new Azure ML commitment plan resource or updates an existing one.
      parameters:
      - name: createOrUpdatePayload
        description: The payload to create or update the Azure ML commitment plan.
        in: body
        required: true
        schema:
          $ref: '#/definitions/CommitmentPlan'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CommitmentPlan'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/CommitmentPlan'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Commitmentplans Commitmentplanname
    delete:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureCommitmentplansRemove
      description: Remove an existing Azure ML commitment plan.
      responses:
        '200':
          description: OK
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Commitmentplans Commitmentplanname
    patch:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureCommitmentplansPatch
      description: Patch an existing Azure ML commitment plan resource.
      parameters:
      - name: patchPayload
        description: The payload to use to patch the Azure ML commitment plan. Only tags and SKU may be modified on an existing commitment plan.
        in: body
        required: true
        schema:
          $ref: '#/definitions/CommitmentPlanPatchPayload'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CommitmentPlan'
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Commitmentplans Commitmentplanname
  /subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/commitmentPlans:
    get:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureCommitmentplansList
      description: Retrieve all Azure ML commitment plans in a subscription.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: $skipToken
        description: Continuation token for pagination.
        in: query
        required: false
        type: string
      - $ref: '#/parameters/APIVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CommitmentPlanListResult'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Machinelearning Commitmentplans
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans:
    get:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureCommitmentplansListinresourcegroup
      description: Retrieve all Azure ML commitment plans in a resource group.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/SkipTokenParameter'
      - $ref: '#/parameters/APIVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CommitmentPlanListResult'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Commitmentplans
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/commitmentPlans/{commitmentPlanName}/usageHistory
  : get:
      tags:
      - CommitmentPlans
      operationId: microsoftAzureUsagehistoryList
      description: Retrieve the usage history for an Azure ML commitment plan.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/CommitmentPlanNameParameter'
      - $ref: '#/parameters/SkipTokenParameter'
      - $ref: '#/parameters/APIVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/PlanUsageHistoryListResult'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Machinelearning Commitmentplans Commitmentplanname Usagehistory
definitions:
  ResourceSku:
    type: object
    description: The SKU of a resource.
    properties:
      capacity:
        format: int32
        type: integer
        description: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
      name:
        type: string
        description: The SKU name. Along with tier, uniquely identifies the SKU.
      tier:
        type: string
        description: The SKU tier. Along with name, uniquely identifies the SKU.
  CommitmentPlanListResult:
    type: object
    description: A page of commitment plan resources.
    properties:
      nextLink:
        type: string
        description: A URI to retrieve the next page of results.
      value:
        type: array
        description: The set of results for this page.
        items:
          $ref: '#/definitions/CommitmentPlan'
  Tags:
    type: object
    description: Resource tags
    additionalProperties:
      type: string
  CommitmentPlan:
    type: object
    description: An Azure ML commitment plan resource.
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      etag:
        type: string
        description: An entity tag used to enforce optimistic concurrency.
      properties:
        description: The commitment plan properties.
        $ref: '#/definitions/CommitmentPlanProperties'
        readOnly: true
      sku:
        description: The commitment plan SKU.
        $ref: '#/definitions/ResourceSku'
  Resource:
    x-ms-azure-resource: true
    description: Common properties of an ARM resource.
    required:
    - location
    properties:
      id:
        description: Resource Id.
        type: string
        readOnly: true
      name:
        description: Resource name.
        type: string
        readOnly: true
      location:
        description: Resource location.
        type: string
      type:
        description: Resource type.
        type: string
        readOnly: true
      tags:
        description: User-defined tags for the resource.
        $ref: '#/definitions/Tags'
  PlanUsageHistory:
    type: object
    description: Represents historical information about usage of the Azure resources associated with a commitment plan.
    properties:
      planDeletionOverage:
        type: object
        description: Overage incurred as a result of deleting a commitment plan.
        additionalProperties:
          format: double
          type: number
      planMigrationOverage:
        type: object
        description: Overage incurred as a result of migrating a commitment plan from one SKU to another.
        additionalProperties:
          format: double
          type: number
      planQuantitiesAfterUsage:
        type: object
        description: Included quantities remaining after usage against the commitment plan's associated resources was calculated.
        additionalProperties:
          format: double
          type: number
      planQuantitiesBeforeUsage:
        type: object
        description: Included quantities remaining before usage against the commitment plan's associated resources was calculated.
        additionalProperties:
          format: double
          type: number
      planUsageOverage:
        type: object
        description: Usage against the commitment plan's associated resources which was not covered by included quantities and is therefore overage.
        additionalProperties:
          format: double
          type: number
      usage:
        type: object
        description: Usage against the commitment plan's associated resources.
        additionalProperties:
          format: double
          type: number
      usageDate:
        format: date-time
        type: string
        description: The date of usage, in ISO 8601 format.
  CommitmentPlanProperties:
    type: object
    description: Properties of an Azure ML commitment plan.
    properties:
      chargeForOverage:
        type: boolean
        description: Indicates whether usage beyond the commitment plan's included quantities will be charged.
        readOnly: true
      chargeForPlan:
        type: boolean
        description: Indicates whether the commitment plan will incur a charge.
        readOnly: true
      creationDate:
        format: date-time
        type: string
        description: The date at which this commitment plan was created, in ISO 8601 format.
        readOnly: true
      includedQuantities:
        type: object
        description: The included resource quantities this plan gives you.
        additionalProperties:
          $ref: '#/definitions/PlanQuantity'
        readOnly: true
      maxAssociationLimit:
        format: int32
        type: integer
        description: The maximum number of commitment associations that can be children of this commitment plan.
        readOnly: true
      maxCapacityLimit:
        format: int32
        type: integer
        description: The maximum scale-out capacity for this commitment plan.
        readOnly: true
      minCapacityLimit:
        format: int32
        type: integer
        description: The minimum scale-out capacity for this commitment plan.
        readOnly: true
      planMeter:
        type: string
        description: The Azure meter which will be used to charge for this commitment plan.
        readOnly: true
      refillFrequencyInDays:
        format: int32
        type: integer
        description: The frequency at which this commitment plan's included quantities are refilled.
        readOnly: true
      suspendPlanOnOverage:
        type: boolean
        description: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.
        readOnly: true
  PlanQuantity:
    type: object
    description: Represents the quantity a commitment plan provides of a metered resource.
    properties:
      allowance:
        format: double
        type: number
        description: The quantity added to the commitment plan at an interval specified by its allowance frequency.
        readOnly: true
      amount:
        format: double
        type: number
        description: The quantity available to the plan the last time usage was calculated.
        readOnly: true
      includedQuantityMeter:
        type: string
        description: The Azure meter for usage against included quantities.
        readOnly: true
      overageMeter:
        type: string
        description: The Azure meter for usage which exceeds included quantities.
        readOnly: true
  CommitmentPlanPatchPayload:
    type: object
    description: The properties of a commitment plan which may be updated via PATCH.
    properties:
      tags:
        description: User-defined tags for the commitment plan.
        $ref: '#/definitions/Tags'
      sku:
        description: The commitment plan SKU.
        $ref: '#/definitions/ResourceSku'
  PlanUsageHistoryListResult:
    type: object
    description: A page of usage history.
    properties:
      nextLink:
        type: string
        description: A URI to retrieve the next page of results.
      value:
        type: array
        description: The set of results for this page.
        items:
          $ref: '#/definitions/PlanUsageHistory'
        x-ms-identifiers: []
parameters:
  SkipTokenParameter:
    x-ms-parameter-location: method
    name: $skipToken
    description: Continuation token for pagination.
    type: string
    in: query
    required: false
  APIVersionParameter:
    name: api-version
    description: The version of the Microsoft.MachineLearning resource provider API to use.
    type: string
    in: query
    required: true
  CommitmentPlanNameParameter:
    x-ms-parameter-location: method
    name: commitmentPlanName
    description: The Azure ML commitment plan name.
    type: string
    in: path
    required: true
  SubscriptionIdParameter:
    name: subscriptionId
    description: Azure Subscription ID.
    type: string
    in: path
    required: true
  ResourceGroupNameParameter:
    x-ms-parameter-location: method
    name: resourceGroupName
    description: The resource group name.
    type: string
    in: path
    required: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'