bookmark_relations

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

Overview

Name	bookmark_relations
Type	Resource
Id	azure.security_insight.bookmark_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.
etag	string	Etag of the azure resource.
relatedResourceId	string	The resource ID of the related resource. Required.
relatedResourceKind	string	The resource kind of the related resource.
relatedResourceName	string	The name of the related resource.
relatedResourceType	string	The resource type of the related resource.
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.
relatedResourceId	string	The resource ID of the related resource. Required.
relatedResourceKind	string	The resource kind of the related resource.
relatedResourceName	string	The name of the related resource.
relatedResourceType	string	The resource type of the related resource.
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, bookmark_id, relation_name, subscription_id		Gets a bookmark relation.
list	select	resource_group_name, workspace_name, bookmark_id, subscription_id	$filter, $orderby, $top, $skipToken	Gets all bookmark relations.
create_or_update	insert	resource_group_name, workspace_name, bookmark_id, relation_name, subscription_id		Creates the bookmark relation.
create_or_update	replace	resource_group_name, workspace_name, bookmark_id, relation_name, subscription_id		Creates the bookmark relation.
delete	delete	resource_group_name, workspace_name, bookmark_id, relation_name, subscription_id		Delete the bookmark 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
bookmark_id	string	Bookmark ID. Required.
relation_name	string	Relation Name. 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 bookmark relation.

SELECT
id,
name,
etag,
relatedResourceId,
relatedResourceKind,
relatedResourceName,
relatedResourceType,
systemData,
type
FROM azure.security_insight.bookmark_relations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND bookmark_id = '{{ bookmark_id }}' -- required
AND relation_name = '{{ relation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all bookmark relations.

SELECT
id,
name,
etag,
relatedResourceId,
relatedResourceKind,
relatedResourceName,
relatedResourceType,
systemData,
type
FROM azure.security_insight.bookmark_relations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND bookmark_id = '{{ bookmark_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 the bookmark relation.

INSERT INTO azure.security_insight.bookmark_relations (
properties,
etag,
resource_group_name,
workspace_name,
bookmark_id,
relation_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ bookmark_id }}',
'{{ relation_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: bookmark_relations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bookmark_relations resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the bookmark_relations resource.
  - name: bookmark_id
    value: "{{ bookmark_id }}"
    description: Required parameter for the bookmark_relations resource.
  - name: relation_name
    value: "{{ relation_name }}"
    description: Required parameter for the bookmark_relations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bookmark_relations resource.
  - name: properties
    description: |
      Relation properties.
    value:
      relatedResourceId: "{{ relatedResourceId }}"
      relatedResourceName: "{{ relatedResourceName }}"
      relatedResourceType: "{{ relatedResourceType }}"
      relatedResourceKind: "{{ relatedResourceKind }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      Etag of the azure resource.

REPLACE examples

create_or_update

Creates the bookmark relation.

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

DELETE examples

delete

Delete the bookmark relation.

DELETE FROM azure.security_insight.bookmark_relations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND bookmark_id = '{{ bookmark_id }}' --required
AND relation_name = '{{ relation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;