bookmarks

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

Overview

Name	bookmarks
Type	Resource
Id	azure.sentinel.bookmarks

Fields

The following fields are returned by SELECT queries:

get

OK, Operation successfully completed

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	Bookmark properties

list

OK, Operation successfully completed

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	Bookmark properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, bookmarkId		Gets a bookmark.
list	select	subscriptionId, resourceGroupName, workspaceName		Gets all bookmarks.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, bookmarkId		Creates or updates the bookmark.
delete	delete	subscriptionId, resourceGroupName, workspaceName, bookmarkId		Delete the bookmark.

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
bookmarkId	string	Bookmark ID
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a bookmark.

SELECT
etag,
properties
FROM azure.sentinel.bookmarks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND bookmarkId = '{{ bookmarkId }}' -- required
;

list

Gets all bookmarks.

SELECT
etag,
properties
FROM azure.sentinel.bookmarks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the bookmark.

INSERT INTO azure.sentinel.bookmarks (
data__etag,
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
bookmarkId
)
SELECT 
'{{ etag }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ bookmarkId }}'
RETURNING
etag,
properties
;

Manifest

# Description fields are for documentation purposes
- name: bookmarks
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the bookmarks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the bookmarks resource.
    - name: workspaceName
      value: string
      description: Required parameter for the bookmarks resource.
    - name: bookmarkId
      value: string
      description: Required parameter for the bookmarks resource.
    - name: etag
      value: string
      description: |
        Etag of the azure resource
    - name: properties
      value: object
      description: |
        Bookmark properties

DELETE examples

delete

Delete the bookmark.

DELETE FROM azure.sentinel.bookmarks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND bookmarkId = '{{ bookmarkId }}' --required
;