hunt_relations

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

Overview

Name	hunt_relations
Type	Resource
Id	azure.security_insight.hunt_relations

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.
labels	array	List of labels relevant to this hunt.
relatedResourceId	string	The id of the related resource. Required.
relatedResourceKind	string	The resource that the relation is related to.
relatedResourceName	string	The name of the related resource.
relationType	string	The type of the hunt relation.
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.
labels	array	List of labels relevant to this hunt.
relatedResourceId	string	The id of the related resource. Required.
relatedResourceKind	string	The resource that the relation is related to.
relatedResourceName	string	The name of the related resource.
relationType	string	The type of the hunt relation.
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_relation_id, subscription_id		Gets a hunt relation.
list	select	resource_group_name, workspace_name, hunt_id, subscription_id	$filter, $orderby, $top, $skipToken	Gets all hunt relations.
create_or_update	insert	resource_group_name, workspace_name, hunt_id, hunt_relation_id, subscription_id		Creates or updates a hunt relation.
create_or_update	replace	resource_group_name, workspace_name, hunt_id, hunt_relation_id, subscription_id		Creates or updates a hunt relation.
delete	delete	resource_group_name, workspace_name, hunt_id, hunt_relation_id, subscription_id		Delete a hunt relation.

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_id	string	The hunt id (GUID). Required.
hunt_relation_id	string	The hunt relation 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 relation.

SELECT
id,
name,
labels,
relatedResourceId,
relatedResourceKind,
relatedResourceName,
relationType,
systemData,
type
FROM azure.security_insight.hunt_relations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND hunt_id = '{{ hunt_id }}' -- required
AND hunt_relation_id = '{{ hunt_relation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all hunt relations.

SELECT
id,
name,
labels,
relatedResourceId,
relatedResourceKind,
relatedResourceName,
relationType,
systemData,
type
FROM azure.security_insight.hunt_relations
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_relations (
properties,
resource_group_name,
workspace_name,
hunt_id,
hunt_relation_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ hunt_id }}',
'{{ hunt_relation_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: hunt_relations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the hunt_relations resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the hunt_relations resource.
  - name: hunt_id
    value: "{{ hunt_id }}"
    description: Required parameter for the hunt_relations resource.
  - name: hunt_relation_id
    value: "{{ hunt_relation_id }}"
    description: Required parameter for the hunt_relations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the hunt_relations resource.
  - name: properties
    description: |
      Hunt Relation properties.
    value:
      relatedResourceId: "{{ relatedResourceId }}"
      relatedResourceName: "{{ relatedResourceName }}"
      relationType: "{{ relationType }}"
      relatedResourceKind: "{{ relatedResourceKind }}"
      labels:
        - "{{ labels }}"

REPLACE examples

create_or_update

Creates or updates a hunt relation.

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

DELETE examples

delete

Delete a hunt relation.

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