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
name	string	The name of the resource
properties	object	Gets or sets the hybrid worker group properties.
systemData	object	Resource system metadata.
type	string	The type of the resource.

list_by_hybrid_runbook_worker_group

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource
name	string	The name of the resource
properties	object	Gets or sets the hybrid worker group properties.
systemData	object	Resource system metadata.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, automationAccountName, hybridRunbookWorkerGroupName, hybridRunbookWorkerId, subscriptionId		Retrieve a hybrid runbook worker.
list_by_hybrid_runbook_worker_group	select	resourceGroupName, automationAccountName, hybridRunbookWorkerGroupName, subscriptionId	$filter	Retrieve a list of hybrid runbook workers.
create	insert	resourceGroupName, automationAccountName, hybridRunbookWorkerGroupName, hybridRunbookWorkerId, subscriptionId, data__properties		Create a hybrid runbook worker.
delete	delete	resourceGroupName, automationAccountName, hybridRunbookWorkerGroupName, hybridRunbookWorkerId, subscriptionId		Delete a hybrid runbook worker.
move	exec	resourceGroupName, automationAccountName, hybridRunbookWorkerGroupName, hybridRunbookWorkerId, subscriptionId		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
automationAccountName	string	The name of the automation account.
hybridRunbookWorkerGroupName	string	The hybrid runbook worker group name
hybridRunbookWorkerId	string	The hybrid runbook worker id
resourceGroupName	string	Name of an Azure Resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$filter	string	The filter to apply on the operation.

SELECT examples

get

Retrieve a hybrid runbook worker.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.automation.hybrid_runbook_workers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND hybridRunbookWorkerGroupName = '{{ hybridRunbookWorkerGroupName }}' -- required
AND hybridRunbookWorkerId = '{{ hybridRunbookWorkerId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_hybrid_runbook_worker_group

Retrieve a list of hybrid runbook workers.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.automation.hybrid_runbook_workers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND hybridRunbookWorkerGroupName = '{{ hybridRunbookWorkerGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a hybrid runbook worker.

INSERT INTO azure.automation.hybrid_runbook_workers (
data__properties,
data__name,
resourceGroupName,
automationAccountName,
hybridRunbookWorkerGroupName,
hybridRunbookWorkerId,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}',
'{{ resourceGroupName }}',
'{{ automationAccountName }}',
'{{ hybridRunbookWorkerGroupName }}',
'{{ hybridRunbookWorkerId }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: hybrid_runbook_workers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the hybrid_runbook_workers resource.
    - name: automationAccountName
      value: string
      description: Required parameter for the hybrid_runbook_workers resource.
    - name: hybridRunbookWorkerGroupName
      value: string
      description: Required parameter for the hybrid_runbook_workers resource.
    - name: hybridRunbookWorkerId
      value: string
      description: Required parameter for the hybrid_runbook_workers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the hybrid_runbook_workers resource.
    - name: properties
      value: object
      description: |
        Gets or sets hybrid runbook worker group create or update properties.
    - name: name
      value: string
      description: |
        Gets or sets the name of the resource.

DELETE examples

delete

Delete a hybrid runbook worker.

DELETE FROM azure.automation.hybrid_runbook_workers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND automationAccountName = '{{ automationAccountName }}' --required
AND hybridRunbookWorkerGroupName = '{{ hybridRunbookWorkerGroupName }}' --required
AND hybridRunbookWorkerId = '{{ hybridRunbookWorkerId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

move

Move a hybrid worker to a different group.

EXEC azure.automation.hybrid_runbook_workers.move 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required, 
@hybridRunbookWorkerGroupName='{{ hybridRunbookWorkerGroupName }}' --required, 
@hybridRunbookWorkerId='{{ hybridRunbookWorkerId }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"hybridRunbookWorkerGroupName": "{{ hybridRunbookWorkerGroupName }}"
}'
;