Azure Arc

Azure Arc REST API

Azure Arc REST API enables management of servers, Kubernetes clusters, and data services running outside Azure. It supports onboarding hybrid resources, applying Azure policies, enabling monitoring, and extending Azure management capabilities to on-premises and multi-cloud environments.

GitHub OpenAPI

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/hybridcompute/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-arc/refs/heads/main/openapi/microsoft-azure-arc-openapi.yml

OpenAPI Specification

microsoft-azure-arc-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Azure Arc Hybrid Compute REST API
  description: Azure Arc extends Azure management to servers, Kubernetes clusters, and data services running
    anywhere. The Hybrid Compute REST API manages Arc-enabled servers (machines), extensions, and private
    link scopes.
  version: '2024-01-01'
externalDocs:
  description: Azure Arc Hybrid Compute REST API Documentation
  url: https://learn.microsoft.com/en-us/rest/api/hybridcompute/
servers:
- url: https://management.azure.com
  description: Azure Resource Manager
tags:
- name: Machines
  description: Machines operations
- name: Extensions
  description: Extensions operations
- name: Private Link Scopes
  description: Private Link Scopes operations
- name: Operations
  description: Operations operations
security:
- azure_auth:
  - user_impersonation
paths:
  /providers/Microsoft.HybridCompute/operations:
    get:
      operationId: listOperations
      summary: Azure Arc Hybrid Compute REST API List operations
      description: Lists all available REST API operations for Microsoft.HybridCompute.
      tags:
      - Operations
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Operations list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines:
    get:
      operationId: listMachinesBySubscription
      summary: Azure Arc Hybrid Compute REST API List by subscription
      description: Lists all machines resources within the specified subscription.
      tags:
      - Machines
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Resource list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines:
    get:
      operationId: listMachinesByResourceGroup
      summary: Azure Arc Hybrid Compute REST API List by resource group
      description: Lists all machines resources within the specified resource group.
      tags:
      - Machines
      parameters:
      - $ref: '#/components/parameters/subscriptionId'
      - $ref: '#/components/parameters/resourceGroupName'
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: Resource list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}:
    parameters:
    - $ref: '#/components/parameters/subscriptionId'
    - $ref: '#/components/parameters/resourceGroupName'
    - name: name
      in: path
      required: true
      description: Name of the resource.
      schema:
        type: string
    - $ref: '#/components/parameters/apiVersion'
    get:
      operationId: getMachines
      summary: Azure Arc Hybrid Compute REST API Get resource
      description: Gets a specific machines resource.
      tags:
      - Machines
      responses:
        '200':
          description: Resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '404':
          description: Not found
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: createOrUpdateMachines
      summary: Azure Arc Hybrid Compute REST API Create or update resource
      description: Creates or updates a machines resource.
      tags:
      - Machines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resource'
      responses:
        '200':
          description: Resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        '201':
          description: Resource created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      operationId: updateMachines
      summary: Azure Arc Hybrid Compute REST API Update resource
      description: Updates a machines resource.
      tags:
      - Machines
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Resource updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteMachines
      summary: Azure Arc Hybrid Compute REST API Delete resource
      description: Deletes a machines resource.
      tags:
      - Machines
      responses:
        '200':
          description: Resource deleted
        '202':
          description: Deletion accepted
        '204':
          description: Resource not found or already deleted
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    subscriptionId:
      name: subscriptionId
      in: path
      required: true
      description: The ID of the target subscription.
      schema:
        type: string
    resourceGroupName:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group.
      schema:
        type: string
    apiVersion:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
  schemas:
    Resource:
      type: object
      properties:
        id:
          type: string
          description: Resource ID.
        name:
          type: string
          description: Resource name.
        type:
          type: string
          description: Resource type.
        location:
          type: string
          description: Resource location.
        tags:
          type: object
          additionalProperties:
            type: string
        properties:
          type: object
          description: Resource-specific properties.
    ResourceList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Resource'
        nextLink:
          type: string
          description: URL to the next page of results.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            target:
              type: string
    Operation:
      type: object
      properties:
        name:
          type: string
        display:
          type: object
          properties:
            provider:
              type: string
            resource:
              type: string
            operation:
              type: string
            description:
              type: string
        isDataAction:
          type: boolean
    OperationList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
        nextLink:
          type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      description: Azure Active Directory OAuth2 Flow.
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: Impersonate your user account
x-generated-from: https://learn.microsoft.com/en-us/rest/api/hybridcompute/
x-generated-by: claude-crawl-2026-05-08