Azure Automation Hybrid Runbook Worker API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Hybrid Runbook Worker API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged HybridRunbookWorker 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: HybridRunbookWorker
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers
  : get:
      operationId: HybridRunbookWorkers_ListByHybridRunbookWorkerGroup
      tags:
      - HybridRunbookWorker
      description: Retrieve a list of hybrid runbook workers.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations
      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
      - 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/HybridRunbookWorkersListResult'
        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 workers by hybrid runbook worker group:
          $ref: ./examples/listHybridRunbookWorker.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Hybrid runbook workers list by hybrid runbook worker group
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}
  : get:
      operationId: HybridRunbookWorkers_Get
      tags:
      - HybridRunbookWorker
      description: Retrieve a hybrid runbook worker.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations
      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
      - name: hybridRunbookWorkerId
        in: path
        description: The hybrid runbook worker id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorker'
        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 V2 hybrid runbook worker:
          $ref: ./examples/getHybridRunbookWorker.json
      summary: Hybrid runbook workers get
      x-summary-source: derived
    put:
      operationId: HybridRunbookWorkers_Create
      tags:
      - HybridRunbookWorker
      description: Create a hybrid runbook worker.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations
      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
      - name: hybridRunbookWorkerId
        in: path
        description: The hybrid runbook worker id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'HybridRunbookWorker' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorker'
        '201':
          description: Resource 'HybridRunbookWorker' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorker'
        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 V2 hybrid runbook worker:
          $ref: ./examples/putHybridRunbookWorker.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridRunbookWorkerCreateParameters'
        description: The create or update parameters for hybrid runbook worker.
        required: true
      summary: Hybrid runbook workers create
      x-summary-source: derived
    patch:
      operationId: HybridRunbookWorkers_Patch
      tags:
      - HybridRunbookWorker
      description: Update a hybrid runbook worker.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations
      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
      - name: hybridRunbookWorkerId
        in: path
        description: The hybrid runbook worker id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridRunbookWorker'
        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 V2 hybrid runbook worker:
          $ref: ./examples/patchHybridRunbookWorker.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridRunbookWorkerCreateParameters'
        description: The create or update parameters for hybrid runbook worker.
      summary: Hybrid runbook workers patch
      x-summary-source: derived
    delete:
      operationId: HybridRunbookWorkers_Delete
      tags:
      - HybridRunbookWorker
      description: Delete a hybrid runbook worker.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations
      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
      - name: hybridRunbookWorkerId
        in: path
        description: The hybrid runbook worker id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete a V2 hybrid runbook worker:
          $ref: ./examples/deleteHybridRunbookWorker.json
      summary: Hybrid runbook workers delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}/hybridRunbookWorkers/{hybridRunbookWorkerId}/move
  : post:
      operationId: HybridRunbookWorkers_Move
      tags:
      - HybridRunbookWorker
      description: Move a hybrid worker to a different group.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations
      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
      - name: hybridRunbookWorkerId
        in: path
        description: The hybrid runbook worker id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Move a V2 hybrid worker to a different group:
          $ref: ./examples/moveHybridRunbookWorker.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridRunbookWorkerMoveParameters'
        description: The hybrid runbook worker move parameters
        required: true
      summary: Hybrid runbook workers move
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    HybridRunbookWorkerCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update hybrid runbook worker operation.
      properties:
        vmResourceId:
          type: string
          description: Azure Resource Manager Id for a virtual machine.
    HybridRunbookWorkerProperties:
      type: object
      description: Definition of hybrid runbook worker property.
      properties:
        ip:
          type: string
          description: Gets or sets the assigned machine IP address.
        registeredDateTime:
          type: string
          format: date-time
          description: Gets or sets the registration time of the worker machine.
        lastSeenDateTime:
          type: string
          format: date-time
          description: Last Heartbeat from the Worker
        vmResourceId:
          type: string
          description: Azure Resource Manager Id for a virtual machine.
        workerType:
          $ref: '#/components/schemas/WorkerType'
          description: Type of the HybridWorker.
        workerName:
          type: string
          description: Name of the HybridWorker.
    HybridRunbookWorker:
      type: object
      description: Definition of hybrid runbook worker.
      properties:
        properties:
          $ref: '#/components/schemas/HybridRunbookWorkerProperties'
          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
    HybridRunbookWorkerMoveParameters:
      type: object
      description: Parameters supplied to move hybrid worker operation.
      properties:
        hybridRunbookWorkerGroupName:
          type: string
          description: Gets or sets the target hybrid runbook worker group.
    HybridRunbookWorkerCreateParameters:
      type: object
      description: The parameters supplied to the create hybrid runbook worker operation.
      properties:
        properties:
          $ref: '#/components/schemas/HybridRunbookWorkerCreateOrUpdateParameters'
          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.
          readOnly: true
    HybridRunbookWorkersListResult:
      type: object
      description: The response of a HybridRunbookWorker list operation.
      properties:
        value:
          type: array
          description: The HybridRunbookWorker items on this page
          items:
            $ref: '#/components/schemas/HybridRunbookWorker'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    WorkerType:
      type: string
      description: Type of the HybridWorker.
      enum:
      - HybridV1
      - HybridV2
      x-ms-enum:
        name: WorkerType
        modelAsString: true
        values:
        - name: HybridV1
          value: HybridV1
          description: HybridV1
        - name: HybridV2
          value: HybridV2
          description: HybridV2
  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