你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az sentinel metadata

Note

This reference is part of the sentinel extension for the Azure CLI (version 2.37.0 or higher). 该扩展会在首次运行 az sentinel metadata 命令时自动安装。 Learn more about extensions.

使用 sentinel 管理元数据。

命令

名称	说明	类型	Status
az sentinel metadata create	创建元数据。	Extension	Experimental
az sentinel metadata delete	删除元数据。	Extension	Experimental
az sentinel metadata list	所有元数据的列表。	Extension	Experimental
az sentinel metadata show	获取元数据。	Extension	Experimental
az sentinel metadata update	更新元数据。	Extension	Experimental

az sentinel metadata create

实验

此命令是实验性的，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

创建元数据。

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]

必需参数

--metadata-name --name -n

元数据名称。

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--workspace-name -w

实验

工作区的名称。

可选参数

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

--author

内容项的创建者。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--categories

解决方案内容项的类别支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--content-id

内容的静态 ID。用于标识解决方案或社区提供的依赖项和内容。现装内容和解决方案的硬编码/静态。用户创建的动态。这是资源名称。

属性	值
Parameter group:	Properties Arguments

--content-schema-version

内容的架构版本。可用于根据架构版本区分不同的流。

属性	值
Parameter group:	Properties Arguments

--custom-version

内容的自定义版本。可选的自由文本。

属性	值
Parameter group:	Properties Arguments

--dependencies

内容项的依赖项，它需要哪些其他内容项才能正常工作。可以使用递归/嵌套结构描述更复杂的依赖项。对于单个依赖项，可以提供 ID/kind/version 或复杂格式的运算符/条件。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--etag

Azure 资源的 Etag。

属性	值
Parameter group:	Metadata Arguments

--first-publish-date

首先发布日期解决方案内容项。

属性	值
Parameter group:	Properties Arguments

--icon

图标标识符。稍后可以从解决方案模板中提取此 ID。

属性	值
Parameter group:	Properties Arguments

--kind

元数据所针对的内容类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate

--last-publish-date

解决方案内容项的最后发布日期。

属性	值
Parameter group:	Properties Arguments

--parent-id

元数据要用于的内容项的完整父资源 ID。这是完整的资源 ID，包括范围（订阅和资源组）。

属性	值
Parameter group:	Properties Arguments

--preview-images

预览图像文件名。这些内容将取自解决方案项目支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--preview-images-dark

预览图像文件名。这些内容将从解决方案项目中提取。用于深色主题支持支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--providers

解决方案内容项的提供程序支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--source

内容的源。这是创建位置/方式。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--support

元数据的支持信息 - 类型、名称、联系信息支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--threat-tactics

资源的策略涵盖支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--threat-techniques

资源涵盖的技术，这些技术必须与正在使用的策略保持一致，支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--version

内容的版本。默认格式和建议的格式为数字（例如 1、1.0、1.0.0、1.0.0.0），遵循 ARM 模板最佳做法。也可以是任何字符串，但我们无法保证任何版本检查。

属性	值
Parameter group:	Properties Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az sentinel metadata delete

实验

此命令是实验性的，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

删除元数据。

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

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--metadata-name --name -n

元数据名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--workspace-name -w

实验

工作区的名称。

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az sentinel metadata list

实验

此命令是实验性的，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

所有元数据的列表。

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

必需参数

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

--workspace-name -w

实验

工作区的名称。

可选参数

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

--filter

根据布尔条件筛选结果。 Optional.

--orderby

对结果进行排序。 Optional.

--skip

用于跳过 OData 查询中的 n 个元素（偏移量）。如果还剩任何结果，则返回下一页结果的 nextLink。

--top

仅返回前 n 个结果。 Optional.

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az sentinel metadata show

实验

此命令是实验性的，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

获取元数据。

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

可选参数

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

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--metadata-name --name -n

元数据名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--workspace-name -w

实验

工作区的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az sentinel metadata update

实验

此命令是实验性的，正在开发中。参考和支持级别：https://aka.ms/CLI_refstatus

更新元数据。

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]

可选参数

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

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

--author

内容项的创建者。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--categories

解决方案内容项的类别支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--content-id

内容的静态 ID。用于标识解决方案或社区提供的依赖项和内容。现装内容和解决方案的硬编码/静态。用户创建的动态。这是资源名称。

属性	值
Parameter group:	Properties Arguments

--content-schema-version

内容的架构版本。可用于根据架构版本区分不同的流。

属性	值
Parameter group:	Properties Arguments

--custom-version

内容的自定义版本。可选的自由文本。

属性	值
Parameter group:	Properties Arguments

--dependencies

属性	值
Parameter group:	Properties Arguments

--etag

Azure 资源的 Etag。

属性	值
Parameter group:	Metadata Arguments

--first-publish-date

首先发布日期解决方案内容项。

属性	值
Parameter group:	Properties Arguments

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--icon

图标标识符。稍后可以从解决方案模板中提取此 ID。

属性	值
Parameter group:	Properties Arguments

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--kind

元数据所针对的内容类型。

属性	值
Parameter group:	Properties Arguments
接受的值:	AnalyticsRule, AnalyticsRuleTemplate, AutomationRule, AzureFunction, DataConnector, DataType, HuntingQuery, InvestigationQuery, LogicAppsCustomConnector, Parser, Playbook, PlaybookTemplate, Solution, Watchlist, WatchlistTemplate, Workbook, WorkbookTemplate

--last-publish-date

解决方案内容项的最后发布日期。

属性	值
Parameter group:	Properties Arguments

--metadata-name --name -n

元数据名称。

属性	值
Parameter group:	Resource Id Arguments

--parent-id

元数据要用于的内容项的完整父资源 ID。这是完整的资源 ID，包括范围（订阅和资源组）。

属性	值
Parameter group:	Properties Arguments

--preview-images

预览图像文件名。这些内容将取自解决方案项目支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--preview-images-dark

预览图像文件名。这些内容将从解决方案项目中提取。用于深色主题支持支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--providers

解决方案内容项的提供程序支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--remove

从列表中删除属性或元素。示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

属性	值
Parameter group:	Generic Update Arguments

--source

内容的源。这是创建位置/方式。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--support

元数据的支持信息 - 类型、名称、联系信息支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--threat-tactics

资源的策略涵盖支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--threat-techniques

资源涵盖的技术，这些技术必须与正在使用的策略保持一致，支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--version

属性	值
Parameter group:	Properties Arguments

--workspace-name -w

实验

工作区的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

通过

az sentinel metadata

命令

az sentinel metadata create

必需参数

可选参数

az sentinel metadata delete

可选参数

az sentinel metadata list

必需参数

可选参数

az sentinel metadata show

可选参数

az sentinel metadata update

可选参数

反馈