activities
Creates, updates, deletes, gets or lists an activities
resource.
Overview
Name | activities |
Type | Resource |
Id | azure.automation.activities |
Fields
The following fields are returned by SELECT
queries:
- get
- list_by_module
Name | Datatype | Description |
---|---|---|
id | string | Gets or sets the id of the resource. |
name | string | Gets the name of the activity. |
properties | object | Gets or sets the properties of the activity. |
Name | Datatype | Description |
---|---|---|
id | string | Gets or sets the id of the resource. |
name | string | Gets the name of the activity. |
properties | object | Gets or sets the properties of the activity. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | resourceGroupName , automationAccountName , moduleName , activityName , subscriptionId | Retrieve the activity in the module identified by module name and activity name. | |
list_by_module | select | resourceGroupName , automationAccountName , moduleName , subscriptionId | Retrieve a list of activities in the module identified by module name. |
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 |
---|---|---|
activityName | string | The name of activity. |
automationAccountName | string | The name of the automation account. |
moduleName | string | The name of module. |
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
- list_by_module
Retrieve the activity in the module identified by module name and activity name.
SELECT
id,
name,
properties
FROM azure.automation.activities
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND moduleName = '{{ moduleName }}' -- required
AND activityName = '{{ activityName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Retrieve a list of activities in the module identified by module name.
SELECT
id,
name,
properties
FROM azure.automation.activities
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND automationAccountName = '{{ automationAccountName }}' -- required
AND moduleName = '{{ moduleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;