Azure Automation Hybrid Runbook Worker Group API

The HybridRunbookWorkerGroup API from Azure Automation — 2 operation(s) for hybridrunbookworkergroup.

Documentation GitHub OpenAPI

Operations 4

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups Hybrid runbook worker group list by automation account #

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName} Hybrid runbook worker group get #

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName} Hybrid runbook worker group create #

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName} Hybrid runbook worker group update #

Documentation

📖

Documentation

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

Specifications

⚙

OpenAPI

https://artifacts.apis.io/microsoft-azure-automation/openapi/microsoft-azure-automation-hybridrunbookworkergroup-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-hybridrunbookworkergroup-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 Hybrid Runbook Worker Group API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged HybridRunbookWorkerGroup 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: HybridRunbookWorkerGroup
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups
  : get:
      operationId: HybridRunbookWorkerGroup_ListByAutomationAccount
      tags:
      - HybridRunbookWorkerGroup
      description: Retrieve a list of hybrid runbook worker groups.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations
      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
      - name: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorkerGroupsListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List hybrid worker groups by Automation Account:
          $ref: ./examples/listHybridRunbookWorkerGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Hybrid runbook worker group list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}
  : get:
      operationId: HybridRunbookWorkerGroup_Get
      tags:
      - HybridRunbookWorkerGroup
      description: Retrieve a hybrid runbook worker group.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations
      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
      - name: hybridRunbookWorkerGroupName
        in: path
        description: The hybrid runbook worker group name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorkerGroup'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a hybrid worker group:
          $ref: ./examples/getHybridRunbookWorkerGroup.json
      summary: Hybrid runbook worker group get
      x-summary-source: derived
    put:
      operationId: HybridRunbookWorkerGroup_Create
      tags:
      - HybridRunbookWorkerGroup
      description: Create a hybrid runbook worker group.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations
      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
      - name: hybridRunbookWorkerGroupName
        in: path
        description: The hybrid runbook worker group name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'HybridRunbookWorkerGroup' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorkerGroup'
        '201':
          description: Resource 'HybridRunbookWorkerGroup' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorkerGroup'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create a hybrid worker group:
          $ref: ./examples/putHybridRunbookWorkerGroup.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridRunbookWorkerGroupCreateOrUpdateParameters'
        description: The create or update parameters for hybrid runbook worker group.
        required: true
      summary: Hybrid runbook worker group create
      x-summary-source: derived
    patch:
      operationId: HybridRunbookWorkerGroup_Update
      tags:
      - HybridRunbookWorkerGroup
      description: Update a hybrid runbook worker group.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations
      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
      - name: hybridRunbookWorkerGroupName
        in: path
        description: The hybrid runbook worker group name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorkerGroup'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update hybrid worker group:
          $ref: ./examples/updateHybridRunbookWorkerGroup.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridRunbookWorkerGroupCreateOrUpdateParameters'
        description: The hybrid runbook worker group
        required: true
      summary: Hybrid runbook worker group update
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    RunAsCredentialAssociationProperty:
      type: object
      description: Definition of RunAs credential to use for hybrid worker.
      properties:
        name:
          type: string
          description: Gets or sets the name of the credential.
    HybridRunbookWorkerGroupProperties:
      type: object
      description: Definition of hybrid runbook worker group property.
      properties:
        groupType:
          $ref: '#/components/schemas/GroupTypeEnum'
          description: Type of the HybridWorkerGroup.
        credential:
          $ref: '#/components/schemas/RunAsCredentialAssociationProperty'
          description: Sets the credential of a worker group.
    GroupTypeEnum:
      type: string
      description: Type of the HybridWorkerGroup.
      enum:
      - User
      - System
      x-ms-enum:
        name: GroupTypeEnum
        modelAsString: true
        values:
        - name: User
          value: User
          description: User
        - name: System
          value: System
          description: System
    HybridRunbookWorkerGroupCreateOrUpdateProperties:
      type: object
      description: The hybrid runbook worker group properties.
      properties:
        credential:
          $ref: '#/components/schemas/RunAsCredentialAssociationProperty'
          description: Sets the credential of a worker group.
    HybridRunbookWorkerGroupCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create hybrid runbook worker group operation.
      properties:
        properties:
          $ref: '#/components/schemas/HybridRunbookWorkerGroupCreateOrUpdateProperties'
          description: Gets or sets hybrid runbook worker group create or update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets the name of the resource.
    HybridRunbookWorkerGroup:
      type: object
      description: Definition of hybrid runbook worker group.
      properties:
        properties:
          $ref: '#/components/schemas/HybridRunbookWorkerGroupProperties'
          description: Gets or sets the hybrid worker group properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    HybridRunbookWorkerGroupsListResult:
      type: object
      description: The response of a HybridRunbookWorkerGroup list operation.
      properties:
        value:
          type: array
          description: The HybridRunbookWorkerGroup items on this page
          items:
            $ref: '#/components/schemas/HybridRunbookWorkerGroup'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  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