Hybrid Runbook Worker Group - List By Automation Account

Retrieve a list of hybrid runbook worker groups.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups?api-version=2015-10-31
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups?$filter={$filter}&api-version=2015-10-31

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

Name of an Azure Resource group.

Regex pattern: ^[-\w\._]+$

automationAccountName
path True
  • string

The name of the automation account.

$filter
query
  • string

The filter to apply on the operation.

api-version
query True
  • string

Client Api Version.

Responses

Name Type Description
200 OK

OK

Other Status Codes

Automation error response describing why the operation failed.

Examples

List hybrid worker groups by Automation Account

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/udtest/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups?api-version=2015-10-31

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/udtest/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups/TestWorkerGroup",
      "name": "TestWorkerGroup",
      "hybridRunbookWorkers": [
        {
          "name": "TestMachine",
          "ip": "134.1.1.1",
          "registrationTime": "2017-03-24T19:43:43.053855+00:00"
        }
      ],
      "credential": {
        "name": "myRunAsCredentialName"
      }
    }
  ]
}

Definitions

ErrorResponse

Error response of an operation failure

GroupTypeEnum

Type of the HybridWorkerGroup.

HybridRunbookWorker

Definition of hybrid runbook worker.

HybridRunbookWorkerGroup

Definition of hybrid runbook worker group.

HybridRunbookWorkerGroupsListResult

The response model for the list hybrid runbook worker groups.

RunAsCredentialAssociationProperty

Definition of runas credential to use for hybrid worker.

ErrorResponse

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

GroupTypeEnum

Type of the HybridWorkerGroup.

Name Type Description
System
  • string
User
  • string

HybridRunbookWorker

Definition of hybrid runbook worker.

Name Type Description
ip
  • string

Gets or sets the assigned machine IP address.

lastSeenDateTime
  • string

Last Heartbeat from the Worker

name
  • string

Gets or sets the worker machine name.

registrationTime
  • string

Gets or sets the registration time of the worker machine.

HybridRunbookWorkerGroup

Definition of hybrid runbook worker group.

Name Type Description
credential

Sets the credential of a worker group.

groupType

Type of the HybridWorkerGroup.

hybridRunbookWorkers

Gets or sets the list of hybrid runbook workers.

id
  • string

Gets or sets the id of the resource.

name
  • string

Gets or sets the name of the group.

HybridRunbookWorkerGroupsListResult

The response model for the list hybrid runbook worker groups.

Name Type Description
nextLink
  • string

Gets or sets the next link.

value

Gets or sets a list of hybrid runbook worker groups.

RunAsCredentialAssociationProperty

Definition of runas credential to use for hybrid worker.

Name Type Description
name
  • string

Gets or sets the name of the credential.