Azure Arc Licenses API

openapi: 3.2.0
info:
  title: HybridComputeManagementClient Licenses API
  version: '2026-09-01'
  description: Azure Arc API reference for managing connected machines, machine extensions, run commands, gateways, licenses, license profiles, private link scopes, and related HybridCompute resources.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Licenses
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/licenses:
    get:
      operationId: Licenses_ListBySubscription
      tags:
      - Licenses
      description: The operation to get all licenses of a non-Azure machine
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicensesListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Licenses list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense:
    post:
      operationId: Licenses_ValidateLicense
      tags:
      - Licenses
      description: The operation to validate a license.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/License'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/License'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/License'
        description: The content of the action request
        required: true
      summary: Licenses validate license
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses:
    get:
      operationId: Licenses_ListByResourceGroup
      tags:
      - Licenses
      description: The operation to get all licenses of a non-Azure machine
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LicensesListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Licenses list by resource group
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}
  : get:
      operationId: Licenses_Get
      tags:
      - Licenses
      description: Retrieves information about the view of a license.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: licenseName
        in: path
        description: The name of the license.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/License'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Licenses get
      x-summary-source: derived
    put:
      operationId: Licenses_CreateOrUpdate
      tags:
      - Licenses
      description: The operation to create or update a license.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: licenseName
        in: path
        description: The name of the license.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/License'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/License'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/License'
        description: Parameters supplied to the Create license operation.
        required: true
      summary: Licenses create or update
      x-summary-source: derived
    patch:
      operationId: Licenses_Update
      tags:
      - Licenses
      description: The operation to update a license.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: licenseName
        in: path
        description: The name of the license.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/License'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/License'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LicenseUpdate'
        description: Parameters supplied to the Update license operation.
        required: true
      summary: Licenses update
      x-summary-source: derived
    delete:
      operationId: Licenses_Delete
      tags:
      - Licenses
      description: The operation to delete a license.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: licenseName
        in: path
        description: The name of the license.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: The request has succeeded.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Licenses delete
      x-summary-source: derived
components:
  schemas:
    LicenseDetails:
      type: object
      description: Describes the properties of a License.
      properties:
        state:
          $ref: '#/components/schemas/LicenseState'
          description: Describes the state of the license.
        target:
          $ref: '#/components/schemas/LicenseTarget'
          description: Describes the license target server.
        edition:
          $ref: '#/components/schemas/LicenseEdition'
          description: Describes the edition of the license. The values are either Standard or Datacenter.
        type:
          $ref: '#/components/schemas/LicenseCoreType'
          description: Describes the license core type (pCore or vCore).
        processors:
          type: integer
          format: int32
          description: Describes the number of processors.
        assignedLicenses:
          type: integer
          format: int32
          description: Describes the number of assigned licenses.
          readOnly: true
        immutableId:
          type: string
          description: Describes the immutable id.
          readOnly: true
        volumeLicenseDetails:
          type: array
          description: A list of volume license details.
          items:
            $ref: '#/components/schemas/VolumeLicenseDetails'
    TrackedResource:
      type: object
      title: Tracked Resource
      description: The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
      properties:
        tags:
          type: object
          description: Resource tags.
          additionalProperties:
            type: string
          x-ms-mutability:
          - read
          - create
          - update
        location:
          type: string
          description: The geo-location where the resource lives
          x-ms-mutability:
          - read
          - create
      required:
      - location
      allOf:
      - $ref: '#/components/schemas/Resource'
    LicenseUpdatePropertiesLicenseDetails:
      type: object
      properties:
        state:
          $ref: '#/components/schemas/LicenseState'
          description: Describes the state of the license.
        target:
          $ref: '#/components/schemas/LicenseTarget'
          description: Describes the license target server.
        edition:
          $ref: '#/components/schemas/LicenseEdition'
          description: Describes the edition of the license. The values are either Standard or Datacenter.
        type:
          $ref: '#/components/schemas/LicenseCoreType'
          description: Describes the license core type (pCore or vCore).
        processors:
          type: integer
          format: int32
          description: Describes the number of processors.
    LicenseType:
      type: string
      description: The type of the license resource.
      enum:
      - ESU
      x-ms-enum:
        name: LicenseType
        modelAsString: true
        values:
        - name: ESU
          value: ESU
          description: ESU
    ProvisioningState:
      type: string
      description: The provisioning state, which only appears in the response.
      enum:
      - Creating
      - Updating
      - Deleting
      - Succeeded
      - Failed
      - Accepted
      - Canceled
      - Deleted
      x-ms-enum:
        name: ProvisioningState
        modelAsString: true
        values:
        - name: Creating
          value: Creating
          description: Creating
        - name: Updating
          value: Updating
          description: Updating
        - name: Deleting
          value: Deleting
          description: Deleting
        - name: Succeeded
          value: Succeeded
          description: Succeeded
        - name: Failed
          value: Failed
          description: Failed
        - name: Accepted
          value: Accepted
          description: Accepted
        - name: Canceled
          value: Canceled
          description: Canceled
        - name: Deleted
          value: Deleted
          description: Deleted
    ProgramYear:
      type: string
      description: Describes the program year the volume license is for.
      enum:
      - Year 1
      - Year 2
      - Year 3
      x-ms-enum:
        name: ProgramYear
        modelAsString: true
        values:
        - name: Year 1
          value: Year 1
          description: Year 1
        - name: Year 2
          value: Year 2
          description: Year 2
        - name: Year 3
          value: Year 3
          description: Year 3
    LicenseCoreType:
      type: string
      description: Describes the license core type (pCore or vCore).
      enum:
      - pCore
      - vCore
      x-ms-enum:
        name: LicenseCoreType
        modelAsString: true
        values:
        - name: pCore
          value: pCore
          description: pCore
        - name: vCore
          value: vCore
          description: vCore
    ResourceUpdate:
      type: object
      description: The Update Resource model definition.
      properties:
        tags:
          type: object
          description: Resource tags
          additionalProperties:
            type: string
    LicenseUpdateProperties:
      type: object
      description: Describes the Update properties of a License Profile.
      properties:
        licenseType:
          $ref: '#/components/schemas/LicenseType'
          description: The type of the license resource.
        licenseDetails:
          $ref: '#/components/schemas/LicenseUpdatePropertiesLicenseDetails'
          x-ms-client-flatten: true
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    LicenseEdition:
      type: string
      description: Describes the edition of the license. The values are either Standard or Datacenter.
      enum:
      - Standard
      - Datacenter
      x-ms-enum:
        name: LicenseEdition
        modelAsString: true
        values:
        - name: Standard
          value: Standard
          description: Standard
        - name: Datacenter
          value: Datacenter
          description: Datacenter
    LicenseTarget:
      type: string
      description: Describes the license target server.
      enum:
      - Windows Server 2012
      - Windows Server 2012 R2
      - Windows Server 2016
      x-ms-enum:
        name: LicenseTarget
        modelAsString: true
        values:
        - name: Windows Server 2012
          value: Windows Server 2012
          description: Windows Server 2012
        - name: Windows Server 2012 R2
          value: Windows Server 2012 R2
          description: Windows Server 2012 R2
        - name: Windows Server 2016
          value: Windows Server 2016
          description: Windows Server 2016 license target.
    LicenseUpdate:
      type: object
      description: Describes a License Update.
      properties:
        properties:
          $ref: '#/components/schemas/LicenseUpdateProperties'
          description: License Update properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ResourceUpdate'
    License:
      type: object
      description: Describes a license in a hybrid machine.
      properties:
        properties:
          $ref: '#/components/schemas/LicenseProperties'
          description: Hybrid Compute License properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    VolumeLicenseDetails:
      type: object
      properties:
        programYear:
          $ref: '#/components/schemas/ProgramYear'
          description: Describes the program year the volume license is for.
        invoiceId:
          type: string
          description: The invoice id for the volume license.
    LicenseProperties:
      type: object
      description: Describes the properties of a License Profile.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state, which only appears in the response.
          readOnly: true
        tenantId:
          type: string
          description: Describes the tenant id.
        licenseType:
          $ref: '#/components/schemas/LicenseType'
          description: The type of the license resource.
        licenseDetails:
          $ref: '#/components/schemas/LicenseDetails'
          description: Describes the properties of a License.
    LicenseState:
      type: string
      description: Describes the state of the license.
      enum:
      - Activated
      - Deactivated
      x-ms-enum:
        name: LicenseState
        modelAsString: true
        values:
        - name: Activated
          value: Activated
          description: Activated
        - name: Deactivated
          value: Deactivated
          description: Deactivated
    ErrorDetail:
      type: object
      description: The error detail.
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        target:
          type: string
          description: The error target.
          readOnly: true
        details:
          type: array
          description: The error details.
          items:
            $ref: '#/components/schemas/ErrorDetail'
          readOnly: true
          x-ms-identifiers:
          - message
          - target
        additionalInfo:
          type: array
          description: The error additional info.
          items:
            $ref: '#/components/schemas/ErrorAdditionalInfo'
          readOnly: true
          x-ms-identifiers: []
    LicensesListResult:
      type: object
      description: Paged collection of License items
      properties:
        value:
          type: array
          description: The License items on this page
          items:
            $ref: '#/components/schemas/License'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  parameters:
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.