Azure Arc Gateways API

The gateways API from Azure Arc — 3 operation(s) for gateways.

GitHub OpenAPI

Operations 6

GET /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/gateways Gateways list by subscription #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways Gateways list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName} Gateways get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName} Gateways create or update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName} Gateways update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName} Gateways 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-gateways-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-gateways-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: HybridComputeManagementClient Gateways 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: Gateways
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/gateways:
    get:
      operationId: Gateways_ListBySubscription
      tags:
      - Gateways
      description: The operation to get all gateways 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/GatewaysListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Gateways list by subscription
      x-summary-source: derived
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways:
    get:
      operationId: Gateways_ListByResourceGroup
      tags:
      - Gateways
      description: The operation to get all gateways 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/GatewaysListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Gateways list by resource group
      x-summary-source: derived
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}
  : get:
      operationId: Gateways_Get
      tags:
      - Gateways
      description: Retrieves information about the view of a gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: gatewayName
        in: path
        description: The name of the Gateway.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Gateways get
      x-summary-source: derived
    put:
      operationId: Gateways_CreateOrUpdate
      tags:
      - Gateways
      description: The operation to create or update a gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: gatewayName
        in: path
        description: The name of the Gateway.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Resource 'Gateway' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        '201':
          description: Resource 'Gateway' create operation succeeded
          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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        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/Gateway'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Gateway'
        description: Parameters supplied to the Create gateway operation.
        required: true
      summary: Gateways create or update
      x-summary-source: derived
    patch:
      operationId: Gateways_Update
      tags:
      - Gateways
      description: The operation to update a gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: gatewayName
        in: path
        description: The name of the Gateway.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Gateway'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewayUpdate'
        description: Parameters supplied to the Update gateway operation.
        required: true
      summary: Gateways update
      x-summary-source: derived
    delete:
      operationId: Gateways_Delete
      tags:
      - Gateways
      description: The operation to delete a gateway.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: gatewayName
        in: path
        description: The name of the Gateway.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      responses:
        '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
      summary: Gateways delete
      x-summary-source: derived
components:
  schemas:
    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.
    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
    GatewayType:
      type: string
      description: The type of the Gateway resource.
      enum:
      - Public
      x-ms-enum:
        name: GatewayType
        modelAsString: true
        values:
        - name: Public
          value: Public
          description: Public
    Gateway:
      type: object
      description: Describes an Arc Gateway.
      properties:
        properties:
          $ref: '#/components/schemas/GatewayProperties'
          description: Hybrid Compute Gateway properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/TrackedResource'
    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'
    GatewayUpdateProperties:
      type: object
      description: Describes the Update properties of a Gateway Profile.
      properties:
        allowedFeatures:
          type: array
          description: Specifies the list of features that are enabled for this Gateway.
          items:
            type: string
        gatewayBypass:
          type: array
          description: Specifies the list of domain names that should bypass the gateway. Each entry must be a valid DNS hostname.
          items:
            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: []
    ResourceUpdate:
      type: object
      description: The Update Resource model definition.
      properties:
        tags:
          type: object
          description: Resource tags
          additionalProperties:
            type: string
    GatewayProperties:
      type: object
      description: Describes the properties of a Gateway Profile.
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: The provisioning state, which only appears in the response.
          readOnly: true
        gatewayId:
          type: string
          description: A unique, immutable, identifier for the Gateway.
          readOnly: true
        gatewayType:
          $ref: '#/components/schemas/GatewayType'
          description: The type of the Gateway resource.
        gatewayEndpoint:
          type: string
          description: The endpoint fqdn for the Gateway.
          readOnly: true
        allowedFeatures:
          type: array
          description: Specifies the list of features that are enabled for this Gateway.
          items:
            type: string
        gatewayBypass:
          type: array
          description: Specifies the list of domain names that should bypass the gateway. Each entry must be a valid DNS hostname.
          items:
            type: string
    GatewaysListResult:
      type: object
      description: Paged collection of Gateway items
      properties:
        value:
          type: array
          description: The Gateway items on this page
          items:
            $ref: '#/components/schemas/Gateway'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    GatewayUpdate:
      type: object
      description: Describes a Gateway Update.
      properties:
        properties:
          $ref: '#/components/schemas/GatewayUpdateProperties'
          description: Gateway Update properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ResourceUpdate'
  parameters:
    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
    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
  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.