Azure Automation Agent Registration Information API

The AgentRegistrationInformation API from Azure Automation — 2 operation(s) for agentregistrationinformation.

Documentation GitHub OpenAPI

Operations 2

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation Agent registration information get #

POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey Agent registration information regenerate key #

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/rest/api/automation/

Specifications

⚙

OpenAPI

https://artifacts.apis.io/microsoft-azure-automation/openapi/microsoft-azure-automation-agentregistrationinformation-api-openapi.yml

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-automation:microsoft-azure-automation-agentregistrationinformation-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

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Agent Registration Information…
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged AgentRegistrationInformation across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: AgentRegistrationInformation
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation
  : get:
      operationId: AgentRegistrationInformation_Get
      tags:
      - AgentRegistrationInformation
      description: Retrieve the automation agent registration information.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/agentregistrationoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get the agent registration information:
          $ref: ./examples/getAgentRegistration.json
      summary: Agent registration information get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey
  : post:
      operationId: AgentRegistrationInformation_RegenerateKey
      tags:
      - AgentRegistrationInformation
      description: Regenerate a primary or secondary agent registration key
      externalDocs:
        url: http://aka.ms/azureautomationsdk/agentregistrationoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRegistration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Regenerate registration key:
          $ref: ./examples/regenerateAgentRegistrationKey.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRegistrationRegenerateKeyParameter'
        description: The name of the agent registration key to be regenerated
        required: true
      summary: Agent registration information regenerate key
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    AgentRegistrationKeyName:
      type: string
      description: Gets or sets the agent registration key name - primary or secondary.
      enum:
      - primary
      - secondary
      x-ms-enum:
        name: AgentRegistrationKeyName
        modelAsString: true
        values:
        - name: primary
          value: primary
          description: primary
        - name: secondary
          value: secondary
          description: secondary
    AgentRegistrationRegenerateKeyParameter:
      type: object
      description: The parameters supplied to the regenerate keys operation.
      properties:
        keyName:
          $ref: '#/components/schemas/AgentRegistrationKeyName'
          description: Gets or sets the agent registration key name - primary or secondary.
      required:
      - keyName
    AgentRegistration:
      type: object
      description: Definition of the agent registration information type.
      properties:
        dscMetaConfiguration:
          type: string
          description: Gets or sets the dsc meta configuration.
        endpoint:
          type: string
          description: Gets or sets the dsc server endpoint.
        keys:
          $ref: '#/components/schemas/AgentRegistrationKeys'
          description: Gets or sets the agent registration keys.
        id:
          type: string
          description: Gets or sets the id.
    AgentRegistrationKeys:
      type: object
      description: Definition of the agent registration keys.
      properties:
        primary:
          type: string
          description: Gets or sets the primary key.
        secondary:
          type: string
          description: Gets or sets the secondary key.
  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.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml