Azure Arc

Azure Arc Settings API

The Settings API from Azure Arc — 1 operation(s) for settings.

GitHub OpenAPI

Operations 3

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName} Settings get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName} Settings update #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName} Settings patch #

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-arc/openapi/microsoft-azure-arc-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-arc/json-schema/microsoft-azure-arc-settings-schema.json

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-settings-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.

GitHub Google LinkedIn

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

OpenAPI Specification

microsoft-azure-arc-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HybridComputeManagementClient Settings 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: Settings
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName}
  : get:
      operationId: Settings_Get
      tags:
      - Settings
      description: Returns the base Settings for the target resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: baseProvider
        in: path
        description: The name of the base Resource Provider.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: baseResourceType
        in: path
        description: The name of the base Resource Type.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: baseResourceName
        in: path
        description: The name of the base resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: settingsResourceName
        in: path
        description: The name of the settings resource.
        required: true
        schema:
          type: string
          pattern: default
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Settings get
      x-summary-source: derived
    put:
      operationId: Settings_Update
      tags:
      - Settings
      description: Updates the base Settings of the target resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: baseProvider
        in: path
        description: The name of the base Resource Provider.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: baseResourceType
        in: path
        description: The name of the base Resource Type.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: baseResourceName
        in: path
        description: The name of the base resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: settingsResourceName
        in: path
        description: The name of the settings resource.
        required: true
        schema:
          type: string
          pattern: default
      responses:
        '200':
          description: Resource 'Settings' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
        '201':
          description: Resource 'Settings' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Settings'
        description: Settings details
        required: true
      summary: Settings update
      x-summary-source: derived
    patch:
      operationId: Settings_Patch
      tags:
      - Settings
      description: Update the base Settings of the target resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: baseProvider
        in: path
        description: The name of the base Resource Provider.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: baseResourceType
        in: path
        description: The name of the base Resource Type.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: baseResourceName
        in: path
        description: The name of the base resource.
        required: true
        schema:
          type: string
          pattern: '[a-zA-Z0-9-_\.]+'
      - name: settingsResourceName
        in: path
        description: The name of the settings resource.
        required: true
        schema:
          type: string
          pattern: default
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Settings'
        description: Settings details
        required: true
      summary: Settings patch
      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.
    SettingsGatewayProperties:
      type: object
      description: Settings Gateway properties
      properties:
        gatewayResourceId:
          type: string
          format: arm-id
          description: Associated Gateway Resource Id
          x-ms-arm-id-details:
            allowedResources:
            - type: Microsoft.HybridCompute/gateways
    Settings:
      type: object
      description: Concrete proxy resource types can be created by aliasing this type using a specific property type.
      properties:
        properties:
          $ref: '#/components/schemas/SettingsProperties'
          description: Settings properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    SettingsProperties:
      type: object
      description: Settings properties
      properties:
        tenantId:
          type: string
          description: Azure resource tenant Id
          readOnly: true
        gatewayProperties:
          $ref: '#/components/schemas/SettingsGatewayProperties'
          description: Settings Gateway properties
          x-ms-client-flatten: true
    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: []
    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'
  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
    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
  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.