hybrid_runbook_worker_group

Creates, updates, deletes, gets or lists a hybrid_runbook_worker_group resource.

Overview

Name	hybrid_runbook_worker_group
Type	Resource
Id	azure.automation.hybrid_runbook_worker_group

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
credential	object	Sets the credential of a worker group.
groupType	string	Type of the HybridWorkerGroup. Known values are: "User" and "System". (User, System)
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_automation_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
credential	object	Sets the credential of a worker group.
groupType	string	Type of the HybridWorkerGroup. Known values are: "User" and "System". (User, System)
location	string	The geo-location where the resource lives. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, subscription_id		Retrieve a hybrid runbook worker group.
list_by_automation_account	select	resource_group_name, automation_account_name, subscription_id	$filter	Retrieve a list of hybrid runbook worker groups.
create	insert	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, subscription_id		Create a hybrid runbook worker group.
update	update	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, subscription_id		Update a hybrid runbook worker group.
delete	delete	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, subscription_id		Delete a hybrid runbook worker group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
automation_account_name	string	The name of the automation account. Required.
hybrid_runbook_worker_group_name	string	The hybrid runbook worker group name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. Default value is None.

SELECT examples

get

Retrieve a hybrid runbook worker group.

SELECT
id,
name,
credential,
groupType,
location,
systemData,
tags,
type
FROM azure.automation.hybrid_runbook_worker_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND hybrid_runbook_worker_group_name = '{{ hybrid_runbook_worker_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_automation_account

Retrieve a list of hybrid runbook worker groups.

SELECT
id,
name,
credential,
groupType,
location,
systemData,
tags,
type
FROM azure.automation.hybrid_runbook_worker_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a hybrid runbook worker group.

INSERT INTO azure.automation.hybrid_runbook_worker_group (
properties,
name,
resource_group_name,
automation_account_name,
hybrid_runbook_worker_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ automation_account_name }}',
'{{ hybrid_runbook_worker_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: hybrid_runbook_worker_group
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hybrid_runbook_worker_group resource.
  - name: automation_account_name
    value: "{{ automation_account_name }}"
    description: Required parameter for the hybrid_runbook_worker_group resource.
  - name: hybrid_runbook_worker_group_name
    value: "{{ hybrid_runbook_worker_group_name }}"
    description: Required parameter for the hybrid_runbook_worker_group resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hybrid_runbook_worker_group resource.
  - name: properties
    description: |
      Gets or sets hybrid runbook worker group create or update properties.
    value:
      credential:
        name: "{{ name }}"
  - name: name
    value: "{{ name }}"
    description: |
      Gets or sets the name of the resource.

UPDATE examples

update

Update a hybrid runbook worker group.

UPDATE azure.automation.hybrid_runbook_worker_group
SET 
properties = '{{ properties }}',
name = '{{ name }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND hybrid_runbook_worker_group_name = '{{ hybrid_runbook_worker_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a hybrid runbook worker group.

DELETE FROM azure.automation.hybrid_runbook_worker_group
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND automation_account_name = '{{ automation_account_name }}' --required
AND hybrid_runbook_worker_group_name = '{{ hybrid_runbook_worker_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;