incident_tasks

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

Overview

Name	incident_tasks
Type	Resource
Id	azure.security_insight.incident_tasks

Fields

The following fields are returned by SELECT queries:

get

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.
createdBy	object	Information on the client (user or application) that made some action.
createdTimeUtc	string (date-time)	The time the task was created.
description	string	The description of the task.
etag	string	Etag of the azure resource.
lastModifiedBy	object	Information on the client (user or application) that made some action.
lastModifiedTimeUtc	string (date-time)	The last time the task was updated.
status	string	The status of the task. Required. Known values are: "New" and "Completed". (New, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	The title of the task. Required.
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.
createdBy	object	Information on the client (user or application) that made some action.
createdTimeUtc	string (date-time)	The time the task was created.
description	string	The description of the task.
etag	string	Etag of the azure resource.
lastModifiedBy	object	Information on the client (user or application) that made some action.
lastModifiedTimeUtc	string (date-time)	The last time the task was updated.
status	string	The status of the task. Required. Known values are: "New" and "Completed". (New, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	The title of the task. Required.
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	select	resource_group_name, workspace_name, incident_id, incident_task_id, subscription_id		Gets an incident task.
list	select	resource_group_name, workspace_name, incident_id, subscription_id		Gets all incident tasks.
create_or_update	insert	resource_group_name, workspace_name, incident_id, incident_task_id, subscription_id, properties		Creates or updates the incident task.
create_or_update	replace	resource_group_name, workspace_name, incident_id, incident_task_id, subscription_id, properties		Creates or updates the incident task.
delete	delete	resource_group_name, workspace_name, incident_id, incident_task_id, subscription_id		Delete the incident task.

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
incident_id	string	Incident ID. Required.
incident_task_id	string	Incident task ID. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the monitor workspace. Required.

SELECT examples

get

Gets an incident task.

SELECT
id,
name,
createdBy,
createdTimeUtc,
description,
etag,
lastModifiedBy,
lastModifiedTimeUtc,
status,
systemData,
title,
type
FROM azure.security_insight.incident_tasks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND incident_id = '{{ incident_id }}' -- required
AND incident_task_id = '{{ incident_task_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all incident tasks.

SELECT
id,
name,
createdBy,
createdTimeUtc,
description,
etag,
lastModifiedBy,
lastModifiedTimeUtc,
status,
systemData,
title,
type
FROM azure.security_insight.incident_tasks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND incident_id = '{{ incident_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the incident task.

INSERT INTO azure.security_insight.incident_tasks (
properties,
etag,
resource_group_name,
workspace_name,
incident_id,
incident_task_id,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ etag }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ incident_id }}',
'{{ incident_task_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: incident_tasks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the incident_tasks resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the incident_tasks resource.
  - name: incident_id
    value: "{{ incident_id }}"
    description: Required parameter for the incident_tasks resource.
  - name: incident_task_id
    value: "{{ incident_task_id }}"
    description: Required parameter for the incident_tasks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the incident_tasks resource.
  - name: properties
    description: |
      Describes the properties of an incident task. Required.
    value:
      title: "{{ title }}"
      description: "{{ description }}"
      status: "{{ status }}"
      createdTimeUtc: "{{ createdTimeUtc }}"
      lastModifiedTimeUtc: "{{ lastModifiedTimeUtc }}"
      createdBy:
        email: "{{ email }}"
        name: "{{ name }}"
        objectId: "{{ objectId }}"
        userPrincipalName: "{{ userPrincipalName }}"
      lastModifiedBy:
        email: "{{ email }}"
        name: "{{ name }}"
        objectId: "{{ objectId }}"
        userPrincipalName: "{{ userPrincipalName }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.

REPLACE examples

create_or_update

Creates or updates the incident task.

REPLACE azure.security_insight.incident_tasks
SET 
properties = '{{ properties }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND incident_id = '{{ incident_id }}' --required
AND incident_task_id = '{{ incident_task_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
type;

DELETE examples

delete

Delete the incident task.

DELETE FROM azure.security_insight.incident_tasks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND incident_id = '{{ incident_id }}' --required
AND incident_task_id = '{{ incident_task_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;