az sentinel bookmark

  • Reference

Note

This reference is part of the sentinel extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az sentinel bookmark command. Learn more about extensions.

Manage bookmark with sentinel.

Commands

Name Description Type Status
az sentinel bookmark create

Create the bookmark.

 Extension Experimental
az sentinel bookmark delete

Delete the bookmark.

 Extension Experimental
az sentinel bookmark expand

Expand an bookmark.

 Extension Experimental
az sentinel bookmark list

Get all bookmarks.

 Extension Experimental
az sentinel bookmark relation

Manage bookmark relation with sentinel.

 Extension GA
az sentinel bookmark relation create

Create the bookmark relation.

 Extension Experimental
az sentinel bookmark relation delete

Delete the bookmark relation.

 Extension Experimental
az sentinel bookmark relation list

Get all bookmark relations.

 Extension Experimental
az sentinel bookmark relation show

Get a bookmark relation.

 Extension Experimental
az sentinel bookmark relation update

Update the bookmark relation.

 Extension Experimental
az sentinel bookmark show

Get a bookmark.

 Extension Experimental
az sentinel bookmark update

Update the bookmark.

 Extension Experimental

az sentinel bookmark create

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the bookmark.

az sentinel bookmark create --bookmark-id
                            --resource-group
                            --workspace-name
                            [--created]
                            [--created-by]
                            [--display-name]
                            [--entity-mappings]
                            [--etag]
                            [--event-time]
                            [--incident-info]
                            [--labels]
                            [--notes]
                            [--query-content]
                            [--query-end-time]
                            [--query-result]
                            [--query-start-time]
                            [--tactics]
                            [--techniques]
                            [--updated]
                            [--updated-by]

Required Parameters

--bookmark-id --name -n
Experimental

ID of bookmark.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Experimental

The name of the workspace.

Optional Parameters

--created

The time the bookmark was created.

--created-by

Describes a user that created the bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--display-name

The display name of the bookmark.

--entity-mappings

Describes the entity mappings of the bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--etag

Etag of the azure resource.

--event-time

The bookmark event time.

--incident-info

Describes an incident that relates to bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--labels

List of labels relevant to this bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--notes

The notes of the bookmark.

--query-content
Experimental

The query of the bookmark.

--query-end-time

The end time for the query.

--query-result

The query result of the bookmark.

--query-start-time

The start time for the query.

--tactics

A list of relevant mitre attacks Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--techniques

A list of relevant mitre techniques Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--updated

The last time the bookmark was updated.

--updated-by

Describes a user that updated the bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sentinel bookmark delete

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the bookmark.

az sentinel bookmark delete [--bookmark-id]
                            [--ids]
                            [--resource-group]
                            [--subscription]
                            [--workspace-name]
                            [--yes]

Optional Parameters

--bookmark-id --name -n
Experimental

ID of bookmark.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name -w
Experimental

The name of the workspace.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sentinel bookmark expand

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Expand an bookmark.

az sentinel bookmark expand --bookmark-id
                            --resource-group
                            --workspace-name
                            [--end-time]
                            [--expansion-id]
                            [--start-time]

Required Parameters

--bookmark-id --name -n
Experimental

ID of bookmark.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Experimental

The name of the workspace.

Optional Parameters

--end-time

The end date filter, so the only expansion results returned are before this date.

--expansion-id

The Id of the expansion to perform.

--start-time

The start date filter, so the only expansion results returned are after this date.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sentinel bookmark list

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get all bookmarks.

az sentinel bookmark list --resource-group
                          --workspace-name

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name -w
Experimental

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sentinel bookmark show

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a bookmark.

az sentinel bookmark show [--bookmark-id]
                          [--ids]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

Optional Parameters

--bookmark-id --name -n
Experimental

ID of bookmark.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name -w
Experimental

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az sentinel bookmark update

Experimental

This command is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the bookmark.

az sentinel bookmark update [--add]
                            [--bookmark-id]
                            [--created]
                            [--created-by]
                            [--display-name]
                            [--entity-mappings]
                            [--etag]
                            [--event-time]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--incident-info]
                            [--labels]
                            [--notes]
                            [--query-content]
                            [--query-end-time]
                            [--query-result]
                            [--query-start-time]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--subscription]
                            [--tactics]
                            [--techniques]
                            [--updated]
                            [--updated-by]
                            [--workspace-name]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--bookmark-id --name -n
Experimental

ID of bookmark.

--created

The time the bookmark was created.

--created-by

Describes a user that created the bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--display-name

The display name of the bookmark.

--entity-mappings

Describes the entity mappings of the bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--etag

Etag of the azure resource.

--event-time

The bookmark event time.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--incident-info

Describes an incident that relates to bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--labels

List of labels relevant to this bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--notes

The notes of the bookmark.

--query-content
Experimental

The query of the bookmark.

--query-end-time

The end time for the query.

--query-result

The query result of the bookmark.

--query-start-time

The start time for the query.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tactics

A list of relevant mitre attacks Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--techniques

A list of relevant mitre techniques Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--updated

The last time the bookmark was updated.

--updated-by

Describes a user that updated the bookmark Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--workspace-name -w
Experimental

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.