แชร์ผ่าน

az sentinel metadata

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--author

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

Property Value
Parameter group: Properties Arguments
--categories

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--content-schema-version

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

Property Value
Parameter group: Properties Arguments
--custom-version

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--etag

Etag of the azure resource.

Property Value
Parameter group: Metadata Arguments
--first-publish-date

First publish date solution content item.

Property Value
Parameter group: Properties Arguments
--icon

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

Property Value
Parameter group: Properties Arguments
--kind

The kind of content the metadata is for.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--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).

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--providers

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

Property Value
Parameter group: Properties Arguments
--source

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

Property Value
Parameter group: Properties Arguments
--support

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

Property Value
Parameter group: Properties Arguments
--threat-tactics

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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 --name]
                            [--resource-group]
                            [--subscription]
                            [--workspace-name]
                            [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--metadata-name --name -n

The Metadata name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

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 --name]
                          [--resource-group]
                          [--subscription]
                          [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Resource Id Arguments
--metadata-name --name -n

The Metadata name.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--author

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

Property Value
Parameter group: Properties Arguments
--categories

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--content-schema-version

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

Property Value
Parameter group: Properties Arguments
--custom-version

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--etag

Etag of the azure resource.

Property Value
Parameter group: Metadata Arguments
--first-publish-date

First publish date solution content item.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--kind

The kind of content the metadata is for.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--metadata-name --name -n

The Metadata name.

Property Value
Parameter group: Resource Id Arguments
--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).

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--providers

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

Property Value
Parameter group: Properties Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--source

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

Property Value
Parameter group: Properties Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--support

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

Property Value
Parameter group: Properties Arguments
--threat-tactics

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--workspace-name -w
Experimental

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False