Azure Arc Extensions API

openapi: 3.2.0
info:
  title: HybridComputeManagementClient Extensions 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: Extensions
paths:
  /providers/Microsoft.HybridCompute/locations/{location}/publishers:
    get:
      operationId: ExtensionPublisher_List
      tags:
      - Extensions
      description: Gets all Extension publishers based on the location
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/LocationParameter'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionPublisherListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Extension publisher list
      x-summary-source: derived
  /providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes:
    get:
      operationId: ExtensionType_List
      tags:
      - Extensions
      description: Gets all Extension types based on location and publisher
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/LocationParameter'
      - name: publisher
        in: path
        description: The publisher of the Extension being received.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionTypeListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Extension type list
      x-summary-source: derived
  /providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions:
    get:
      operationId: ExtensionMetadataV2_List
      tags:
      - Extensions
      description: Gets all Extension versions based on location, publisher, extensionType
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: location
        in: path
        description: The location of the Extension being received.
        required: true
        schema:
          type: string
          minLength: 1
      - name: publisher
        in: path
        description: The publisher of the Extension being received.
        required: true
        schema:
          type: string
      - name: extensionType
        in: path
        description: The extensionType of the Extension being received.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionValueListResultV2'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Extension metadata V2 list
      x-summary-source: derived
  ? /providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}
  : get:
      operationId: ExtensionMetadataV2_Get
      tags:
      - Extensions
      description: Gets an Extension Metadata based on location, publisher, extensionType and version
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - name: location
        in: path
        description: The location of the Extension being received.
        required: true
        schema:
          type: string
          minLength: 1
      - name: publisher
        in: path
        description: The publisher of the Extension being received.
        required: true
        schema:
          type: string
      - name: extensionType
        in: path
        description: The extensionType of the Extension being received.
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The version of the Extension being received.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionValueV2'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Extension metadata V2 get
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions
  : get:
      operationId: ExtensionMetadata_List
      tags:
      - Extensions
      description: Gets all Extension versions based on location, publisher, extensionType
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: location
        in: path
        description: The location of the Extension being received.
        required: true
        schema:
          type: string
      - name: publisher
        in: path
        description: The publisher of the Extension being received.
        required: true
        schema:
          type: string
      - name: extensionType
        in: path
        description: The extensionType of the Extension being received.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionValueListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Extension metadata list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}
  : get:
      operationId: ExtensionMetadata_Get
      tags:
      - Extensions
      description: Gets an Extension Metadata based on location, publisher, extensionType and version
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: location
        in: path
        description: The location of the Extension being received.
        required: true
        schema:
          type: string
      - name: publisher
        in: path
        description: The publisher of the Extension being received.
        required: true
        schema:
          type: string
      - name: extensionType
        in: path
        description: The extensionType of the Extension being received.
        required: true
        schema:
          type: string
      - name: version
        in: path
        description: The version of the Extension being received.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionValue'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Extension metadata get
      x-summary-source: derived
components:
  schemas:
    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: []
    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.
    ExtensionValueProperties:
      type: object
      description: Describes Extension Metadata properties
      properties:
        version:
          type: string
          description: The version of the Extension being received.
          readOnly: true
        extensionType:
          type: string
          description: The type of the Extension being received.
          readOnly: true
        publisher:
          type: string
          description: The publisher of the Extension being received.
          readOnly: true
    ExtensionValueListResultV2:
      type: object
      description: The List Extension Metadata response.
      properties:
        value:
          type: array
          description: The ExtensionValueV2 items on this page
          items:
            $ref: '#/components/schemas/ExtensionValueV2'
          readOnly: true
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExtensionValueV2Properties:
      type: object
      description: Describes Extension Metadata properties.
      properties:
        extensionUris:
          type: array
          description: A list of locations where the extension packages can be found.
          items:
            type: string
            format: uri
          readOnly: true
        extensionSignatureUri:
          type: string
          format: uri
          description: Location of the signature files for the extension.
          readOnly: true
        operatingSystem:
          type: string
          description: The operating system (Windows, Linux, etc.) this extension supports.
          readOnly: true
        architecture:
          type: array
          description: Architectures (x64, arms64, etc.) that this extension supports.
          items:
            type: string
          readOnly: true
      allOf:
      - $ref: '#/components/schemas/ExtensionValueProperties'
    ExtensionValueV2:
      type: object
      description: Describes an Extension Metadata.
      properties:
        properties:
          $ref: '#/components/schemas/ExtensionValueV2Properties'
          description: The single extension based on search criteria.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    ExtensionValue:
      type: object
      description: Describes a Extension Metadata
      properties:
        properties:
          $ref: '#/components/schemas/ExtensionValueProperties'
          description: The single extension based on search criteria
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    ExtensionPublisher:
      type: object
      description: Describes an Extension Publisher.
      properties:
        id:
          type: string
          description: The ID of the extension publisher.
        name:
          type: string
          description: The name of the extension publisher.
    ExtensionValueListResult:
      type: object
      description: The List Extension Metadata response.
      properties:
        value:
          type: array
          description: The list of extension metadata
          items:
            $ref: '#/components/schemas/ExtensionValue'
          readOnly: true
          x-ms-identifiers: []
        nextLink:
          type: string
          format: uri
          description: The URL to get the next set of results.
          readOnly: true
    ExtensionType:
      type: object
      description: Describes an Extension Type.
      properties:
        id:
          type: string
          description: The ID of the extension type.
        name:
          type: string
          description: The name of the extension type.
    ExtensionPublisherListResult:
      type: object
      description: The List of Extension Publishers.
      properties:
        value:
          type: array
          description: The ExtensionPublisher items on this page
          items:
            $ref: '#/components/schemas/ExtensionPublisher'
          readOnly: true
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ExtensionTypeListResult:
      type: object
      description: The List of Extension Types.
      properties:
        value:
          type: array
          description: The ExtensionType items on this page
          items:
            $ref: '#/components/schemas/ExtensionType'
          readOnly: true
        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
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
    LocationParameter:
      name: location
      in: path
      description: The name of the Azure region.
      required: true
      x-ms-parameter-location: method
      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.