Hybrid Runbook Worker Group - List By Automation Account

Reference

Service:: Automation

API Version:: 2023-11-01

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=2023-11-01

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: `^[-\w\._]+$`
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.
api-version	query	True	string	Client Api Version.
$filter	query		string	The filter to apply on the operation.

Responses

Name	Type	Description
200 OK	HybridRunbookWorkerGroupsListResult	OK
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List hybrid worker groups by Automation Account

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups/TestHybridGroup",
      "name": "TestHybridGroup",
      "properties": {
        "groupType": "User",
        "credential": {
          "name": "myRunAsCredentialName"
        }
      },
      "systemData": {
        "createdBy": "foo@contoso.com",
        "createdByType": "User",
        "createdAt": "2018-04-24T16:30:55+00:00",
        "lastModifiedBy": "foo@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-04-24T16:30:55+00:00"
      }
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorResponse	Error response of an operation failure
GroupTypeEnum	Type of the HybridWorkerGroup.
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.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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

HybridRunbookWorkerGroup

Definition of hybrid runbook worker group.

Name	Type	Description
id	string	Fully qualified resource Id for the resource
name	string	The name of the resource
properties.credential	RunAsCredentialAssociationProperty	Sets the credential of a worker group.
properties.groupType	GroupTypeEnum	Type of the HybridWorkerGroup.
systemData	systemData	Resource system metadata.
type	string	The type of the resource.

HybridRunbookWorkerGroupsListResult

The response model for the list hybrid runbook worker groups.

Name	Type	Description
nextLink	string	Gets or sets the next link.
value	HybridRunbookWorkerGroup[]	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.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.