Share via

az sentinel metadata

  • 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 metadata command. Learn more about extensions.

Manage metadata with sentinel.

Commands

Name Description Type Status
az sentinel metadata create

Create a Metadata.

 Extension Experimental
az sentinel metadata delete

Delete a Metadata.

 Extension Experimental
az sentinel metadata list

List of all metadata.

 Extension Experimental
az sentinel metadata show

Get a Metadata.

 Extension Experimental
az sentinel metadata update

Update a Metadata.

 Extension Experimental

az sentinel metadata create

Experimental

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

Create a Metadata.

az sentinel metadata create --metadata-name
                            --resource-group
                            --workspace-name
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--icon]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--source]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]

Required Parameters

--metadata-name --name -n

The Metadata name.

--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

--author

The creator of the content item. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--categories

Categories for the solution content item Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--content-id

Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name.

--content-schema-version

Schema version of the content. Can be used to distinguish between different flow based on the schema version.

--custom-version

The custom version of the content. A optional free text.

--dependencies

Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--etag

Etag of the azure resource.

--first-publish-date

First publish date solution content item.

--icon

The icon identifier. this id can later be fetched from the solution template.

--kind

The kind of content the metadata is for.

Accepted values: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate
--last-publish-date

Last publish date for the solution content item.

--parent-id

Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group).

--preview-images

Preview image file names. These will be taken from the solution artifacts Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--preview-images-dark

Preview image file names. These will be taken from the solution artifacts. used for dark theme support Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--providers

Providers for the solution content item Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--source

Source of the content. This is where/how it was created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--support

Support information for the metadata - type, name, contact information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--threat-tactics

The tactics the resource covers Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--threat-techniques

The techniques the resource covers, these have to be aligned with the tactics being used Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--version

Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks.

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 metadata delete

Experimental

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

Delete a Metadata.

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

Optional Parameters

--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.

--metadata-name --name -n

The Metadata name.

--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 metadata list

Experimental

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

List of all metadata.

az sentinel metadata list --resource-group
                          --workspace-name
                          [--filter]
                          [--orderby]
                          [--skip]
                          [--top]

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.

Optional Parameters

--filter

Filters the results, based on a Boolean condition. Optional.

--orderby

Sorts the results. Optional.

--skip

Used to skip n elements in the OData query (offset). Returns a nextLink to the next page of results if there are any left.

--top

Returns only the first n results. Optional.

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 metadata show

Experimental

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

Get a Metadata.

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

Optional Parameters

--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.

--metadata-name --name -n

The Metadata name.

--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 metadata update

Experimental

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

Update a Metadata.

az sentinel metadata update [--add]
                            [--author]
                            [--categories]
                            [--content-id]
                            [--content-schema-version]
                            [--custom-version]
                            [--dependencies]
                            [--etag]
                            [--first-publish-date]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--icon]
                            [--ids]
                            [--kind {AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate}]
                            [--last-publish-date]
                            [--metadata-name]
                            [--parent-id]
                            [--preview-images]
                            [--preview-images-dark]
                            [--providers]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--source]
                            [--subscription]
                            [--support]
                            [--threat-tactics]
                            [--threat-techniques]
                            [--version]
                            [--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>.

--author

The creator of the content item. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--categories

Categories for the solution content item Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--content-id

Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name.

--content-schema-version

Schema version of the content. Can be used to distinguish between different flow based on the schema version.

--custom-version

The custom version of the content. A optional free text.

--dependencies

Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--etag

Etag of the azure resource.

--first-publish-date

First publish date solution content item.

--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
--icon

The icon identifier. this id can later be fetched from the solution template.

--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.

--kind

The kind of content the metadata is for.

Accepted values: AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate
--last-publish-date

Last publish date for the solution content item.

--metadata-name --name -n

The Metadata name.

--parent-id

Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group).

--preview-images

Preview image file names. These will be taken from the solution artifacts Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--preview-images-dark

Preview image file names. These will be taken from the solution artifacts. used for dark theme support Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--providers

Providers for the solution content item Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--source

Source of the content. This is where/how it was created. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--subscription

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

--support

Support information for the metadata - type, name, contact information Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--threat-tactics

The tactics the resource covers Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--threat-techniques

The techniques the resource covers, these have to be aligned with the tactics being used Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--version

Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks.

--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.