hunt_comments

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

Overview

Name	hunt_comments
Type	Resource
Id	azure.security_insight.hunt_comments

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.
etag	string	Etag of the azure resource.
message	string	The message for the comment. Required.
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.
etag	string	Etag of the azure resource.
message	string	The message for the comment. Required.
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	select	resource_group_name, workspace_name, hunt_id, hunt_comment_id, subscription_id		Gets a hunt comment.
list	select	resource_group_name, workspace_name, hunt_id, subscription_id	$filter, $orderby, $top, $skipToken	Gets all hunt comments.
create_or_update	insert	resource_group_name, workspace_name, hunt_id, hunt_comment_id, subscription_id		Creates or updates a hunt relation.
create_or_update	replace	resource_group_name, workspace_name, hunt_id, hunt_comment_id, subscription_id		Creates or updates a hunt relation.
delete	delete	resource_group_name, workspace_name, hunt_id, hunt_comment_id, subscription_id		Delete a hunt comment.

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
hunt_comment_id	string	The hunt comment id (GUID). Required.
hunt_id	string	The hunt id (GUID). 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 workspace. Required.
$filter	string	Filters the results, based on a Boolean condition. Optional. Default value is None.
$orderby	string	Sorts the results. Optional. Default value is None.
$skipToken	string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. Default value is None.
$top	integer	Returns only the first n results. Optional. Default value is None.

SELECT examples

get

Gets a hunt comment.

SELECT
id,
name,
etag,
message,
systemData,
type
FROM azure.security_insight.hunt_comments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND hunt_id = '{{ hunt_id }}' -- required
AND hunt_comment_id = '{{ hunt_comment_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all hunt comments.

SELECT
id,
name,
etag,
message,
systemData,
type
FROM azure.security_insight.hunt_comments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND hunt_id = '{{ hunt_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a hunt relation.

INSERT INTO azure.security_insight.hunt_comments (
properties,
etag,
resource_group_name,
workspace_name,
hunt_id,
hunt_comment_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ hunt_id }}',
'{{ hunt_comment_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: hunt_comments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hunt_comments resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the hunt_comments resource.
  - name: hunt_id
    value: "{{ hunt_id }}"
    description: Required parameter for the hunt_comments resource.
  - name: hunt_comment_id
    value: "{{ hunt_comment_id }}"
    description: Required parameter for the hunt_comments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hunt_comments resource.
  - name: properties
    description: |
      Hunt Comment properties.
    value:
      message: "{{ message }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.

REPLACE examples

create_or_update

Creates or updates a hunt relation.

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

DELETE examples

delete

Delete a hunt comment.

DELETE FROM azure.security_insight.hunt_comments
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND hunt_id = '{{ hunt_id }}' --required
AND hunt_comment_id = '{{ hunt_comment_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;