swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Hybrid Use Benefit API
schemes:
- https
tags:
- name: Hybrid Use Benefit
paths:
  /{scope}/providers/Microsoft.SoftwarePlan/hybridUseBenefits/{planId}:
    put:
      description: Create a new hybrid use benefit under a given scope
      operationId: microsoftAzureHybridusebenefitCreate
      tags:
      - Hybrid Use Benefit
      x-ms-examples:
        HybridUseBenefit:
          $ref: ./examples/PutHybridUseBenefit.json
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/PlanIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/PutBodyParameter'
      responses:
        '200':
          description: OK - returns the plan that is created
          schema:
            $ref: '#/definitions/HybridUseBenefitModel'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Put Scope Providers Microsoft Softwareplan Hybridusebenefits Planid
    patch:
      description: Updates an existing hybrid use benefit
      operationId: microsoftAzureHybridusebenefitUpdate
      tags:
      - Hybrid Use Benefit
      x-ms-examples:
        HybridUseBenefit:
          $ref: ./examples/PatchHybridUseBenefit.json
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/PlanIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/PutBodyParameter'
      responses:
        '200':
          description: OK - successfully updated the given hybrid use benefit
          schema:
            $ref: '#/definitions/HybridUseBenefitModel'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Patch Scope Providers Microsoft Softwareplan Hybridusebenefits Planid
    get:
      description: Gets a given plan ID
      operationId: microsoftAzureHybridusebenefitGet
      tags:
      - Hybrid Use Benefit
      x-ms-examples:
        HybridUseBenefit:
          $ref: ./examples/GetSingleHybridUseBenefit.json
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/PlanIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - returns the plan that is created
          schema:
            $ref: '#/definitions/HybridUseBenefitModel'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Get Scope Providers Microsoft Softwareplan Hybridusebenefits Planid
    delete:
      description: Deletes a given plan ID
      operationId: microsoftAzureHybridusebenefitDelete
      tags:
      - Hybrid Use Benefit
      x-ms-examples:
        HybridUseBenefit:
          $ref: ./examples/DeleteHybridUseBenefit.json
      parameters:
      - $ref: '#/parameters/ScopeParameter'
      - $ref: '#/parameters/PlanIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - successfully deleted the given plan
        '204':
          description: OK - there was no plan to delete
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/Error'
      summary: Microsoft Azure Delete Scope Providers Microsoft Softwareplan Hybridusebenefits Planid
definitions:
  ErrorCode:
    type: string
    description: Defined error codes to be returned to the client.
    enum:
    - InvalidRequestParameter
    - MissingRequestParameter
    x-ms-enum:
      name: ErrorCode
      modelAsString: true
  HybridUseBenefitModel:
    description: Response on GET of a hybrid use benefit
    required:
    - sku
    allOf:
    - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource
    properties:
      sku:
        description: Hybrid use benefit SKU
        $ref: '#/definitions/Sku'
      etag:
        type: integer
        format: int32
        description: Indicates the revision of the hybrid use benefit
        readOnly: true
      properties:
        description: Property bag for a hybrid use benefit response
        x-ms-client-flatten: true
        $ref: '#/definitions/HybridUseBenefitProperties'
  ProvisioningState:
    type: string
    description: Represent the current state of the Reservation.
    enum:
    - Succeeded
    - Cancelled
    - Failed
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  Sku:
    type: object
    description: The SKU to be applied for this resource
    properties:
      name:
        type: string
        description: Name of the SKU to be applied
  Error:
    type: object
    description: Error object returned by the RP
    properties:
      code:
        description: Error code
        $ref: '#/definitions/ErrorCode'
      message:
        type: string
        description: A user readable error message. Localized based on x-ms-effective-locale header in the request
  HybridUseBenefitProperties:
    description: Hybrid use benefit properties
    properties:
      provisioningState:
        type: string
        description: Provisioning state
        $ref: '#/definitions/ProvisioningState'
        readOnly: true
      createdDate:
        type: string
        description: Created date
        format: date-time
        readOnly: true
      lastUpdatedDate:
        type: string
        description: Last updated date
        format: date-time
        readOnly: true
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
  PutBodyParameter:
    name: body
    in: body
    x-ms-parameter-location: method
    required: true
    description: Request body for creating a hybrid use benefit
    schema:
      $ref: '#/definitions/HybridUseBenefitModel'
  PlanIdParameter:
    name: planId
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: This is a unique identifier for a plan. Should be a guid.
  ScopeParameter:
    name: scope
    in: path
    x-ms-parameter-location: method
    required: true
    type: string
    description: The scope at which the operation is performed. This is limited to Microsoft.Compute/virtualMachines and Microsoft.Compute/hostGroups/hosts for now
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'