hybrid_runbook_workers

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

Overview

Name	hybrid_runbook_workers
Type	Resource
Id	azure.automation.hybrid_runbook_workers

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.
ip	string	Gets or sets the assigned machine IP address.
lastSeenDateTime	string (date-time)	Last Heartbeat from the Worker.
location	string	The geo-location where the resource lives. Required.
registeredDateTime	string (date-time)	Gets or sets the registration time of the worker machine.
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".
vmResourceId	string	Azure Resource Manager Id for a virtual machine.
workerName	string	Name of the HybridWorker.
workerType	string	Type of the HybridWorker. Known values are: "HybridV1" and "HybridV2". (HybridV1, HybridV2)

list_by_hybrid_runbook_worker_group

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.
ip	string	Gets or sets the assigned machine IP address.
lastSeenDateTime	string (date-time)	Last Heartbeat from the Worker.
location	string	The geo-location where the resource lives. Required.
registeredDateTime	string (date-time)	Gets or sets the registration time of the worker machine.
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".
vmResourceId	string	Azure Resource Manager Id for a virtual machine.
workerName	string	Name of the HybridWorker.
workerType	string	Type of the HybridWorker. Known values are: "HybridV1" and "HybridV2". (HybridV1, HybridV2)

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, hybrid_runbook_worker_id, subscription_id		Retrieve a hybrid runbook worker.
list_by_hybrid_runbook_worker_group	select	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, subscription_id	$filter	Retrieve a list of hybrid runbook workers.
create	insert	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, hybrid_runbook_worker_id, subscription_id		Create a hybrid runbook worker.
delete	delete	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, hybrid_runbook_worker_id, subscription_id		Delete a hybrid runbook worker.
patch	exec	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, hybrid_runbook_worker_id, subscription_id		Update a hybrid runbook worker.
move	exec	resource_group_name, automation_account_name, hybrid_runbook_worker_group_name, hybrid_runbook_worker_id, subscription_id		Move a hybrid worker to a different 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.
hybrid_runbook_worker_id	string	The hybrid runbook worker id. 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.

SELECT
id,
name,
ip,
lastSeenDateTime,
location,
registeredDateTime,
systemData,
tags,
type,
vmResourceId,
workerName,
workerType
FROM azure.automation.hybrid_runbook_workers
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 hybrid_runbook_worker_id = '{{ hybrid_runbook_worker_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_hybrid_runbook_worker_group

Retrieve a list of hybrid runbook workers.

SELECT
id,
name,
ip,
lastSeenDateTime,
location,
registeredDateTime,
systemData,
tags,
type,
vmResourceId,
workerName,
workerType
FROM azure.automation.hybrid_runbook_workers
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
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a hybrid runbook worker.

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

Manifest

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

DELETE examples

delete

Delete a hybrid runbook worker.

DELETE FROM azure.automation.hybrid_runbook_workers
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 hybrid_runbook_worker_id = '{{ hybrid_runbook_worker_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

patch

Update a hybrid runbook worker.

EXEC azure.automation.hybrid_runbook_workers.patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@automation_account_name='{{ automation_account_name }}' --required, 
@hybrid_runbook_worker_group_name='{{ hybrid_runbook_worker_group_name }}' --required, 
@hybrid_runbook_worker_id='{{ hybrid_runbook_worker_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

move

Move a hybrid worker to a different group.

EXEC azure.automation.hybrid_runbook_workers.move 
@resource_group_name='{{ resource_group_name }}' --required, 
@automation_account_name='{{ automation_account_name }}' --required, 
@hybrid_runbook_worker_group_name='{{ hybrid_runbook_worker_group_name }}' --required, 
@hybrid_runbook_worker_id='{{ hybrid_runbook_worker_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"hybridRunbookWorkerGroupName": "{{ hybridRunbookWorkerGroupName }}"
}'
;