Azure Arc Subscriptions API

The Subscriptions API from Azure Arc — 5 operation(s) for subscriptions.

GitHub OpenAPI

Operations 8

GET /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId} Private link scopes get validation details #
GET /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes Private link scopes list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current Private link scopes get validation details for machine #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes Private link scopes list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName} Private link scopes get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName} Private link scopes create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName} Private link scopes update tags #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName} Private link scopes delete #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-arc:microsoft-azure-arc-subscriptions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-arc-subscriptions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: HybridComputeManagementClient Subscriptions 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: Subscriptions
paths:
  ? /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}
  : get:
      operationId: PrivateLinkScopes_GetValidationDetails
      description: Returns a Azure Arc PrivateLinkScope's validation details.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/TypesLocationParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - name: privateLinkScopeId
        in: path
        description: The id (Guid) of the Azure Arc PrivateLinkScope resource.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateLinkScopeValidationDetails'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Subscriptions
      summary: Private link scopes get validation details
      x-summary-source: derived
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes:
    get:
      operationId: PrivateLinkScopes_List
      description: Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridComputePrivateLinkScopeListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Private link scopes list
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current
  : get:
      operationId: PrivateLinkScopes_GetValidationDetailsForMachine
      description: Returns a Azure Arc PrivateLinkScope's validation details for a given machine.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: machineName
        in: path
        description: The name of the hybrid machine.
        required: true
        schema:
          type: string
          maxLength: 54
          minLength: 1
          pattern: ^[a-zA-Z0-9-_\.]{1,54}$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivateLinkScopeValidationDetails'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Subscriptions
      summary: Private link scopes get validation details for machine
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes:
    get:
      operationId: PrivateLinkScopes_ListByResourceGroup
      description: Gets a list of Azure Arc PrivateLinkScopes within a resource group.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridComputePrivateLinkScopeListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Subscriptions
      summary: Private link scopes list by resource group
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}
  : get:
      operationId: PrivateLinkScopes_Get
      description: Returns a Azure Arc PrivateLinkScope.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: scopeName
        in: path
        description: The name of the Azure Arc PrivateLinkScope resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridComputePrivateLinkScope'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Subscriptions
      summary: Private link scopes get
      x-summary-source: derived
    put:
      operationId: PrivateLinkScopes_CreateOrUpdate
      description: 'Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.'
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: scopeName
        in: path
        description: The name of the Azure Arc PrivateLinkScope resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Resource 'HybridComputePrivateLinkScope' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridComputePrivateLinkScope'
        '201':
          description: Resource 'HybridComputePrivateLinkScope' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridComputePrivateLinkScope'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridComputePrivateLinkScope'
        description: Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.
        required: true
      tags:
      - Subscriptions
      summary: Private link scopes create or update
      x-summary-source: derived
    patch:
      operationId: PrivateLinkScopes_UpdateTags
      description: Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: scopeName
        in: path
        description: The name of the Azure Arc PrivateLinkScope resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridComputePrivateLinkScope'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsResource'
        description: Updated tag information to set into the PrivateLinkScope instance.
        required: true
      tags:
      - Subscriptions
      summary: Private link scopes update tags
      x-summary-source: derived
    delete:
      operationId: PrivateLinkScopes_Delete
      description: Deletes a Azure Arc PrivateLinkScope.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: scopeName
        in: path
        description: The name of the Azure Arc PrivateLinkScope resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
          headers:
            Azure-AsyncOperation:
              description: A link to the status monitor
              schema:
                type: string
                format: uri
            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
      tags:
      - Subscriptions
      summary: Private link scopes delete
      x-summary-source: derived
components:
  schemas:
    PrivateEndpointProperty:
      type: object
      description: Private endpoint which the connection belongs to.
      properties:
        id:
          type: string
          description: Resource id of the private endpoint.
    PrivateLinkScopeValidationDetails:
      type: object
      properties:
        id:
          type: string
          description: Azure resource Id
          readOnly: true
        publicNetworkAccess:
          type: string
          description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
          default: Disabled
          enum:
          - Enabled
          - Disabled
          x-ms-enum:
            name: PublicNetworkAccessType
            modelAsString: true
            values:
            - name: Enabled
              value: Enabled
              description: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints.
            - name: Disabled
              value: Disabled
              description: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.
        connectionDetails:
          type: array
          description: List of Private Endpoint Connection details.
          items:
            $ref: '#/components/schemas/ConnectionDetail'
    PrivateLinkServiceConnectionStateProperty:
      type: object
      description: State of the private endpoint connection.
      properties:
        status:
          type: string
          description: The private link service connection status.
        description:
          type: string
          description: The private link service connection description.
        actionsRequired:
          type: string
          description: The actions required for private link service connection.
          readOnly: true
      required:
      - status
      - description
    ServiceExtensionPublicNetworkAccess:
      type: string
      description: The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints.
      enum:
      - Enabled
      - Disabled
      x-ms-enum:
        name: ServiceExtensionPublicNetworkAccess
        modelAsString: true
        values:
        - name: Enabled
          value: Enabled
          description: Allows Azure Arc Extension agents to communicate with Azure Arc services over both public (internet) and private endpoints.
        - name: Disabled
          value: Disabled
          description: Does not allow Azure Arc Extension agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.
    PrivateEndpointConnectionProperties:
      type: object
      description: Properties of a private endpoint connection.
      properties:
        privateEndpoint:
          $ref: '#/components/schemas/PrivateEndpointProperty'
          description: Private endpoint which the connection belongs to.
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/PrivateLinkServiceConnectionStateProperty'
          description: Connection state of the private endpoint connection.
        provisioningState:
          type: string
          description: State of the private endpoint connection.
          readOnly: true
        groupIds:
          type: array
          description: List of group IDs.
          items:
            type: string
          readOnly: true
    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'
    ConnectionDetail:
      type: object
      properties:
        id:
          type: string
          description: Azure resource Id
          readOnly: true
        privateIpAddress:
          type: string
          description: The private endpoint connection private ip address
          readOnly: true
        linkIdentifier:
          type: string
          description: The private endpoint connection link identifier
          readOnly: true
        groupId:
          type: string
          description: The private endpoint connection group id
          readOnly: true
        memberName:
          type: string
          description: The private endpoint connection member name
          readOnly: true
    ServiceExtension:
      type: object
      description: Enable private link validation for an Azure Arc Extension
      properties:
        serviceExtensionType:
          $ref: '#/components/schemas/ServiceExtensionType'
          description: The name of the Azure Arc Extension.
        serviceExtensionPublicNetworkAccess:
          $ref: '#/components/schemas/ServiceExtensionPublicNetworkAccess'
          description: The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints.
    ServiceExtensionType:
      type: string
    HybridComputePrivateLinkScope:
      type: object
      description: An Azure Arc PrivateLinkScope definition.
      properties:
        properties:
          $ref: '#/components/schemas/HybridComputePrivateLinkScopeProperties'
          description: Properties that define a Azure Arc PrivateLinkScope resource.
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    HybridComputePrivateLinkScopeProperties:
      type: object
      description: Properties that define a Azure Arc PrivateLinkScope resource.
      properties:
        publicNetworkAccess:
          type: string
          description: Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
          default: Disabled
          enum:
          - Enabled
          - Disabled
          x-ms-enum:
            name: PublicNetworkAccessType
            modelAsString: true
            values:
            - name: Enabled
              value: Enabled
              description: Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints.
            - name: Disabled
              value: Disabled
              description: Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link.
        provisioningState:
          type: string
          description: 'Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.'
          readOnly: true
        privateLinkScopeId:
          type: string
          description: The Guid id of the private link scope.
          readOnly: true
        privateEndpointConnections:
          type: array
          description: The collection of associated Private Endpoint Connections.
          items:
            $ref: '#/components/schemas/PrivateEndpointConnectionDataModel'
          readOnly: true
        serviceExtensions:
          type: array
          description: Enable private link validation for an Azure Arc Extension.
          items:
            $ref: '#/components/schemas/ServiceExtension'
    PrivateEndpointConnectionDataModel:
      type: object
      description: The Data Model for a Private Endpoint Connection associated with a Private Link Scope
      properties:
        id:
          type: string
          description: The ARM Resource Id of the Private Endpoint.
          readOnly: true
        name:
          type: string
          description: The Name of the Private Endpoint.
          readOnly: true
        type:
          type: string
          description: Azure resource type
          readOnly: true
        properties:
          $ref: '#/components/schemas/PrivateEndpointConnectionProperties'
          description: The Private Endpoint Connection properties.
    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.
    TagsResource:
      type: object
      description: A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.
      properties:
        tags:
          type: object
          description: Resource tags
          additionalProperties:
            type: string
    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: []
    HybridComputePrivateLinkScopeListResult:
      type: object
      description: The response of a HybridComputePrivateLinkScope list operation.
      properties:
        value:
          type: array
          description: The HybridComputePrivateLinkScope items on this page
          items:
            $ref: '#/components/schemas/HybridComputePrivateLinkScope'
        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
    TypesLocationParameter:
      name: location
      in: path
      description: The name of the Azure region.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        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.