Hybrid Runbook Worker Group - List By Automation Account

Service:

Automation

API Version:

2022-02-22

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=2022-02-22

With optional parameters:

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

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=2022-02-22

Java

import com.azure.core.util.Context;

/** Samples for HybridRunbookWorkerGroup ListByAutomationAccount. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2022-02-22/examples/listHybridRunbookWorkerGroup.json
     */
    /**
     * Sample code: List hybrid worker groups by Automation Account.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void listHybridWorkerGroupsByAutomationAccount(
        com.azure.resourcemanager.automation.AutomationManager manager) {
        manager.hybridRunbookWorkerGroups().listByAutomationAccount("rg", "testaccount", null, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/automation/resource-manager/Microsoft.Automation/stable/2022-02-22/examples/listHybridRunbookWorkerGroup.json
func ExampleHybridRunbookWorkerGroupClient_NewListByAutomationAccountPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewHybridRunbookWorkerGroupClient().NewListByAutomationAccountPager("rg", "testaccount", &armautomation.HybridRunbookWorkerGroupClientListByAutomationAccountOptions{Filter: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.HybridRunbookWorkerGroupsListResult = armautomation.HybridRunbookWorkerGroupsListResult{
		// 	Value: []*armautomation.HybridRunbookWorkerGroup{
		// 		{
		// 			Name: to.Ptr("TestHybridGroup"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups/TestHybridGroup"),
		// 			Properties: &armautomation.HybridRunbookWorkerGroupProperties{
		// 				Credential: &armautomation.RunAsCredentialAssociationProperty{
		// 					Name: to.Ptr("myRunAsCredentialName"),
		// 				},
		// 				GroupType: to.Ptr(armautomation.GroupTypeEnumUser),
		// 			},
		// 			SystemData: &armautomation.SystemData{
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55+00:00"); return t}()),
		// 				CreatedBy: to.Ptr("foo@contoso.com"),
		// 				CreatedByType: to.Ptr(armautomation.CreatedByTypeUser),
		// 				LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-04-24T16:30:55+00:00"); return t}()),
		// 				LastModifiedBy: to.Ptr("foo@contoso.com"),
		// 				LastModifiedByType: to.Ptr(armautomation.CreatedByTypeUser),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieve a list of hybrid runbook worker groups.
 *
 * @summary Retrieve a list of hybrid runbook worker groups.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2022-02-22/examples/listHybridRunbookWorkerGroup.json
 */
async function listHybridWorkerGroupsByAutomationAccount() {
  const subscriptionId = process.env["AUTOMATION_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "rg";
  const automationAccountName = "testaccount";
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.hybridRunbookWorkerGroupOperations.listByAutomationAccount(
    resourceGroupName,
    automationAccountName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Automation;
using Azure.ResourceManager.Automation.Models;

// Generated from example definition: specification/automation/resource-manager/Microsoft.Automation/stable/2022-02-22/examples/listHybridRunbookWorkerGroup.json
// this example is just showing the usage of "HybridRunbookWorkerGroup_ListByAutomationAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AutomationAccountResource created on azure
// for more information of creating AutomationAccountResource, please refer to the document of AutomationAccountResource
string subscriptionId = "subid";
string resourceGroupName = "rg";
string automationAccountName = "testaccount";
ResourceIdentifier automationAccountResourceId = AutomationAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName);
AutomationAccountResource automationAccount = client.GetAutomationAccountResource(automationAccountResourceId);

// get the collection of this HybridRunbookWorkerGroupResource
HybridRunbookWorkerGroupCollection collection = automationAccount.GetHybridRunbookWorkerGroups();

// invoke the operation and iterate over the result
await foreach (HybridRunbookWorkerGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    HybridRunbookWorkerGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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.