agent_registration_information

Creates, updates, deletes, gets or lists an agent_registration_information resource.

Overview

Name	agent_registration_information
Type	Resource
Id	azure.automation.agent_registration_information

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the id.
dscMetaConfiguration	string	Gets or sets the dsc meta configuration.
endpoint	string	Gets or sets the dsc server endpoint.
keys	object	Gets or sets the agent registration keys.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, automationAccountName		Retrieve the automation agent registration information.
regenerate_key	exec	subscriptionId, resourceGroupName, automationAccountName, keyName		Regenerate a primary or secondary agent registration key

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.
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.

SELECT examples

get

Retrieve the automation agent registration information.

SELECT
id,
dscMetaConfiguration,
endpoint,
keys
FROM azure.automation.agent_registration_information
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
;

Lifecycle Methods

regenerate_key

Regenerate a primary or secondary agent registration key

EXEC azure.automation.agent_registration_information.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@automationAccountName='{{ automationAccountName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;