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 | resource_group_name, automation_account_name, subscription_id | Retrieve the automation agent registration information. | |
regenerate_key | exec | resource_group_name, automation_account_name, subscription_id, 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 |
|---|---|---|
automation_account_name | string | The name of the automation account. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string |
SELECT examples​
- get
Retrieve the automation agent registration information.
SELECT
id,
dscMetaConfiguration,
endpoint,
keys
FROM azure.automation.agent_registration_information
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Lifecycle Methods​
- regenerate_key
Regenerate a primary or secondary agent registration key.
EXEC azure.automation.agent_registration_information.regenerate_key
@resource_group_name='{{ resource_group_name }}' --required,
@automation_account_name='{{ automation_account_name }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"keyName": "{{ keyName }}"
}'
;