activity

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

Overview

Name	activity
Type	Resource
Id	azure.automation.activity

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the id of the resource.
name	string	Gets the name of the activity.
creationTime	string (date-time)	Gets or sets the creation time.
definition	string	Gets or sets the user name of the activity.
description	string	Gets or sets the description.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
outputTypes	array	Gets or sets the output types of the activity.
parameterSets	array	Gets or sets the parameter sets of the activity.

list_by_module

Name	Datatype	Description
id	string	Gets or sets the id of the resource.
name	string	Gets the name of the activity.
creationTime	string (date-time)	Gets or sets the creation time.
definition	string	Gets or sets the user name of the activity.
description	string	Gets or sets the description.
lastModifiedTime	string (date-time)	Gets or sets the last modified time.
outputTypes	array	Gets or sets the output types of the activity.
parameterSets	array	Gets or sets the parameter sets of the activity.

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, module_name, activity_name, subscription_id		Retrieve the activity in the module identified by module name and activity name.
list_by_module	select	resource_group_name, automation_account_name, module_name, subscription_id		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
activity_name	string	The name of activity. Required.
automation_account_name	string	The name of the automation account. Required.
module_name	string	The module name. 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 activity in the module identified by module name and activity name.

SELECT
id,
name,
creationTime,
definition,
description,
lastModifiedTime,
outputTypes,
parameterSets
FROM azure.automation.activity
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND module_name = '{{ module_name }}' -- required
AND activity_name = '{{ activity_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_module

Retrieve a list of activities in the module identified by module name.

SELECT
id,
name,
creationTime,
definition,
description,
lastModifiedTime,
outputTypes,
parameterSets
FROM azure.automation.activity
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND automation_account_name = '{{ automation_account_name }}' -- required
AND module_name = '{{ module_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;