tasks

Creates, updates, deletes, gets or lists a tasks resource.

Overview

Name	tasks
Type	Resource
Id	azure.security.tasks

Fields

The following fields are returned by SELECT queries:

get_resource_group_level_task

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTimeUtc	string (date-time)	The time this task was discovered in UTC.
lastStateChangeTimeUtc	string (date-time)	The time this task's details were last changed in UTC.
securityTaskParameters	object	Changing set of properties, depending on the task type that is derived from the name field.
state	string	State of the task (Active, Resolved etc.).
subState	string	Additional data on the state of the task.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTimeUtc	string (date-time)	The time this task was discovered in UTC.
lastStateChangeTimeUtc	string (date-time)	The time this task's details were last changed in UTC.
securityTaskParameters	object	Changing set of properties, depending on the task type that is derived from the name field.
state	string	State of the task (Active, Resolved etc.).
subState	string	Additional data on the state of the task.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_subscription_level_task

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTimeUtc	string (date-time)	The time this task was discovered in UTC.
lastStateChangeTimeUtc	string (date-time)	The time this task's details were last changed in UTC.
securityTaskParameters	object	Changing set of properties, depending on the task type that is derived from the name field.
state	string	State of the task (Active, Resolved etc.).
subState	string	Additional data on the state of the task.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_home_region

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTimeUtc	string (date-time)	The time this task was discovered in UTC.
lastStateChangeTimeUtc	string (date-time)	The time this task's details were last changed in UTC.
securityTaskParameters	object	Changing set of properties, depending on the task type that is derived from the name field.
state	string	State of the task (Active, Resolved etc.).
subState	string	Additional data on the state of the task.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTimeUtc	string (date-time)	The time this task was discovered in UTC.
lastStateChangeTimeUtc	string (date-time)	The time this task's details were last changed in UTC.
securityTaskParameters	object	Changing set of properties, depending on the task type that is derived from the name field.
state	string	State of the task (Active, Resolved etc.).
subState	string	Additional data on the state of the task.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_resource_group_level_task	select	resource_group_name, asc_location, task_name, subscription_id		Recommended tasks that will help improve the security of the subscription proactively.
list_by_resource_group	select	resource_group_name, asc_location, subscription_id	$filter	Recommended tasks that will help improve the security of the subscription proactively.
get_subscription_level_task	select	asc_location, task_name, subscription_id		Recommended tasks that will help improve the security of the subscription proactively.
list_by_home_region	select	asc_location, subscription_id	$filter	Recommended tasks that will help improve the security of the subscription proactively.
list	select	subscription_id	$filter	Recommended tasks that will help improve the security of the subscription proactively.
update_resource_group_level_task_state	exec	resource_group_name, asc_location, task_name, task_update_action_type, subscription_id		Recommended tasks that will help improve the security of the subscription proactively.
update_subscription_level_task_state	exec	asc_location, task_name, task_update_action_type, subscription_id		Recommended tasks that will help improve the security of the subscription proactively.

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
asc_location	string	The location where ASC stores the data of the subscription. can be retrieved from Get locations. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
task_name	string	Name of the task object, will be a GUID. Required.
task_update_action_type	string	Type of the action to do on the task. Known values are: "Activate", "Dismiss", "Start", "Resolve", and "Close". Required.
$filter	string	OData filter. Optional. Default value is None.

SELECT examples

get_resource_group_level_task

Recommended tasks that will help improve the security of the subscription proactively.

SELECT
id,
name,
creationTimeUtc,
lastStateChangeTimeUtc,
securityTaskParameters,
state,
subState,
systemData,
type
FROM azure.security.tasks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND asc_location = '{{ asc_location }}' -- required
AND task_name = '{{ task_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Recommended tasks that will help improve the security of the subscription proactively.

SELECT
id,
name,
creationTimeUtc,
lastStateChangeTimeUtc,
securityTaskParameters,
state,
subState,
systemData,
type
FROM azure.security.tasks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND asc_location = '{{ asc_location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

get_subscription_level_task

Recommended tasks that will help improve the security of the subscription proactively.

SELECT
id,
name,
creationTimeUtc,
lastStateChangeTimeUtc,
securityTaskParameters,
state,
subState,
systemData,
type
FROM azure.security.tasks
WHERE asc_location = '{{ asc_location }}' -- required
AND task_name = '{{ task_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_home_region

Recommended tasks that will help improve the security of the subscription proactively.

SELECT
id,
name,
creationTimeUtc,
lastStateChangeTimeUtc,
securityTaskParameters,
state,
subState,
systemData,
type
FROM azure.security.tasks
WHERE asc_location = '{{ asc_location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

list

Recommended tasks that will help improve the security of the subscription proactively.

SELECT
id,
name,
creationTimeUtc,
lastStateChangeTimeUtc,
securityTaskParameters,
state,
subState,
systemData,
type
FROM azure.security.tasks
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

update_resource_group_level_task_state

Recommended tasks that will help improve the security of the subscription proactively.

EXEC azure.security.tasks.update_resource_group_level_task_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@asc_location='{{ asc_location }}' --required, 
@task_name='{{ task_name }}' --required, 
@task_update_action_type='{{ task_update_action_type }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_subscription_level_task_state

Recommended tasks that will help improve the security of the subscription proactively.

EXEC azure.security.tasks.update_subscription_level_task_state 
@asc_location='{{ asc_location }}' --required, 
@task_name='{{ task_name }}' --required, 
@task_update_action_type='{{ task_update_action_type }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;