你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.SecurityInsights 元数据 2023-02-01-preview
Bicep 资源定义
元数据资源类型是 扩展资源,这意味着你可以将其应用于其他资源。
scope
使用此资源上的 属性可设置此资源的范围。 请参阅 在 Bicep 中设置扩展资源的范围。
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.SecurityInsights/metadata 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.SecurityInsights/metadata@2023-02-01-preview' = {
name: 'string'
scope: resourceSymbolicName
etag: 'string'
properties: {
author: {
email: 'string'
link: 'string'
name: 'string'
}
categories: {
domains: [
'string'
]
verticals: [
'string'
]
}
contentId: 'string'
contentSchemaVersion: 'string'
customVersion: 'string'
dependencies: {
contentId: 'string'
criteria: [
{
kind: 'string'
name: 'string'
operator: 'string'
version: 'string'
}
firstPublishDate: 'string'
icon: 'string'
kind: 'string'
lastPublishDate: 'string'
parentId: 'string'
previewImages: [
'string'
]
previewImagesDark: [
'string'
]
providers: [
'string'
]
source: {
kind: 'string'
name: 'string'
sourceId: 'string'
}
support: {
email: 'string'
link: 'string'
name: 'string'
tier: 'string'
}
threatAnalysisTactics: [
'string'
]
threatAnalysisTechniques: [
'string'
]
version: 'string'
}
}
属性值
metadata
名称 | 说明 | 值 |
---|---|---|
name | 资源名称 | 字符串 (必需) |
scope | 在与部署范围不同的范围创建扩展资源时使用 。 | 目标资源 对于 Bicep,请将此属性设置为资源的符号名称以应用 扩展资源。 |
etag | Azure 资源的 Etag | string |
properties | 元数据属性 | MetadataProperties |
MetadataProperties
名称 | 说明 | 值 |
---|---|---|
author | 内容项的创建者。 | MetadataAuthor |
Categories | 解决方案内容项的类别 | MetadataCategories |
contentId | 内容的静态 ID。 用于识别解决方案或社区中依赖项和内容。 用于现成内容和解决方案的硬编码/静态。 用户创建的动态。 这是资源名称 | 字符串 |
contentSchemaVersion | 内容的架构版本。 可用于根据架构版本区分不同的流 | 字符串 |
customVersion | 内容的自定义版本。 可选自由文本 | 字符串 |
依赖项 | 内容项的依赖项,它需要哪些其他内容项才能工作。 可以使用递归/嵌套结构描述更复杂的依赖项。 对于单个依赖项,可以为复杂格式提供 id/kind/version 或运算符/条件。 | MetadataDependencies |
firstPublishDate | 首次发布日期解决方案内容项 | 字符串 |
icon | 图标标识符。 以后可以从解决方案模板中提取此 ID | 字符串 |
kind | 元数据所针对的内容类型。 | “AnalyticsRule” “AnalyticsRuleTemplate” “AutomationRule” “AzureFunction” “DataConnector” “DataType” “HuntingQuery” “InvestigationQuery” “LogicAppsCustomConnector” “Parser” “Playbook” “PlaybookTemplate” “解决方案” “Watchlist” “WatchlistTemplate” “工作簿” “WorkbookTemplate” (必需的) |
lastPublishDate | 解决方案内容项的上次发布日期 | 字符串 |
parentId | 元数据所针对的内容项的完整父资源 ID。 这是完整的资源 ID,包括范围 (订阅和资源组) | 字符串 (必需) |
previewImages | 预览图像文件名。 这些内容将取自解决方案项目 | string[] |
previewImagesDark | 预览图像文件名。 这些内容将取自解决方案项目。 用于深色主题支持 | string[] |
providers | 解决方案内容项的提供程序 | string[] |
source | 内容的源。 这是创建它的位置/方式。 | MetadataSource |
support | 元数据的支持信息 - 类型、姓名、联系信息 | MetadataSupport |
threatAnalysisTactics | 资源涵盖的策略 | string[] |
threatAnalysisTechniques | 资源涵盖的技术,这些技术必须与所使用的策略保持一致 | string[] |
版本 | 内容的版本。 默认和建议的格式为数字 (例如 1、1.0、1.0.0、1.0.0、1.0.0) ,遵循 ARM 模板最佳做法。 也可以是任何字符串,但我们无法保证任何版本检查 | string |
MetadataAuthor
名称 | 说明 | 值 |
---|---|---|
电子邮件 | 作者联系人Email | string |
链接 | 作者/供应商页面的链接 | string |
name | 作者的名称。 公司或个人。 | 字符串 |
MetadataCategories
名称 | 说明 | 值 |
---|---|---|
domains | 解决方案内容项的域 | string[] |
垂直 | 解决方案内容项的行业垂直 | string[] |
MetadataDependencies
名称 | 说明 | 值 |
---|---|---|
contentId | 我们依赖的内容项的 ID | 字符串 |
条件 | 这是我们必须满足的依赖项列表,根据 AND/OR 运算符 | MetadataDependencies[] |
kind | 我们依赖的内容项的类型 | “AnalyticsRule” “AnalyticsRuleTemplate” “AutomationRule” “AzureFunction” “DataConnector” “DataType” 'HuntingQuery' 'InvestigationQuery' “LogicAppsCustomConnector” “Parser” “Playbook” “PlaybookTemplate” “解决方案” “Watchlist” 'WatchlistTemplate' “Workbook” 'WorkbookTemplate' |
name | 内容项的名称 | 字符串 |
运算符后的表达式 | 用于条件数组中的依赖项列表的运算符。 | “AND” “OR” |
版本 | 我们依赖的内容项的版本。 可以为空、* 或缺失,以指示任何版本满足依赖项。 如果版本与我们定义的数字格式不匹配,则需要完全匹配。 | 字符串 |
MetadataSource
名称 | 说明 | 值 |
---|---|---|
kind | 内容的源类型 | “社区” 'LocalWorkspace' “解决方案” “SourceRepository” (必需) |
name | 内容源的名称。 存储库名称、解决方案名称、LA 工作区名称等。 | 字符串 |
sourceId | 内容源的 ID。 解决方案 ID、工作区 ID 等 | string |
MetadataSupport
名称 | 说明 | 值 |
---|---|---|
电子邮件 | 支持联系人Email | 字符串 |
链接 | 支持帮助链接,例如支持页面以打开票证等。 | string |
name | 支持联系人的姓名。 公司或个人。 | 字符串 |
层 | 对内容项的支持类型 | “社区” “Microsoft” 需要“合作伙伴” () |
ARM 模板资源定义
元数据资源类型是 扩展资源,这意味着你可以将其应用于另一个资源。
scope
使用此资源上的 属性可设置此资源的作用域。 请参阅 在 ARM 模板中设置扩展资源的范围。
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.SecurityInsights/metadata 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.SecurityInsights/metadata",
"apiVersion": "2023-02-01-preview",
"name": "string",
"scope": "string",
"etag": "string",
"properties": {
"author": {
"email": "string",
"link": "string",
"name": "string"
},
"categories": {
"domains": [ "string" ],
"verticals": [ "string" ]
},
"contentId": "string",
"contentSchemaVersion": "string",
"customVersion": "string",
"dependencies": {
"contentId": "string",
"criteria": [
{
"kind": "string",
"name": "string",
"operator": "string",
"version": "string"
},
"firstPublishDate": "string",
"icon": "string",
"kind": "string",
"lastPublishDate": "string",
"parentId": "string",
"previewImages": [ "string" ],
"previewImagesDark": [ "string" ],
"providers": [ "string" ],
"source": {
"kind": "string",
"name": "string",
"sourceId": "string"
},
"support": {
"email": "string",
"link": "string",
"name": "string",
"tier": "string"
},
"threatAnalysisTactics": [ "string" ],
"threatAnalysisTechniques": [ "string" ],
"version": "string"
}
}
属性值
metadata
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.SecurityInsights/metadata” |
apiVersion | 资源 API 版本 | “2023-02-01-preview” |
name | 资源名称 | 字符串 (必需) |
scope | 在不同于部署范围的范围创建扩展资源时使用 。 | 目标资源 对于 JSON,请将值设置为要向其应用 扩展资源的资源 的全名。 |
etag | Azure 资源的 Etag | string |
properties | 元数据属性 | MetadataProperties |
MetadataProperties
名称 | 说明 | 值 |
---|---|---|
author | 内容项的创建者。 | MetadataAuthor |
Categories | 解决方案内容项的类别 | MetadataCategories |
contentId | 内容的静态 ID。 用于标识解决方案或社区的依赖项和内容。 现成内容和解决方案的硬编码/静态。 用户创建的动态。 这是资源名称 | 字符串 |
contentSchemaVersion | 内容的架构版本。 可用于根据架构版本区分不同的流 | 字符串 |
customVersion | 内容的自定义版本。 可选自由文本 | 字符串 |
依赖项 | 内容项的依赖项,它需要哪些其他内容项才能正常工作。 可以使用递归/嵌套结构描述更复杂的依赖项。 对于单个依赖项,可以提供 id/kind/version,或者为复杂格式提供运算符/条件。 | MetadataDependencies |
firstPublishDate | 首次发布日期解决方案内容项 | 字符串 |
icon | 图标标识符。 以后可以从解决方案模板中提取此 ID | 字符串 |
kind | 元数据所针对的内容类型。 | “AnalyticsRule” “AnalyticsRuleTemplate” “AutomationRule” “AzureFunction” “DataConnector” “DataType” “HuntingQuery” “InvestigationQuery” “LogicAppsCustomConnector” “Parser” “Playbook” “PlaybookTemplate” “解决方案” “Watchlist” “WatchlistTemplate” “工作簿” “WorkbookTemplate” (必需的) |
lastPublishDate | 解决方案内容项的上次发布日期 | 字符串 |
parentId | 元数据所针对的内容项的完整父资源 ID。 这是完整的资源 ID,包括范围 (订阅和资源组) | 字符串 (必需) |
previewImages | 预览图像文件名。 这些内容将取自解决方案项目 | string[] |
previewImagesDark | 预览图像文件名。 这些将取自解决方案项目。 用于深色主题支持 | string[] |
providers | 解决方案内容项的提供程序 | string[] |
source | 内容的源。 这是创建它的位置/方式。 | MetadataSource |
support | 元数据的支持信息 - 类型、姓名、联系信息 | MetadataSupport |
threatAnalysisTactics | 资源涵盖的策略 | string[] |
threatAnalysisTechniques | 资源涵盖的技术,这些技术必须与所使用的策略保持一致 | string[] |
版本 | 内容的版本。 默认和建议的格式是数字 (例如 1、1.0、1.0.0、1.0.0、1.0.0) ,遵循 ARM 模板最佳做法。 也可以是任何字符串,但我们无法保证任何版本检查 | string |
MetadataAuthor
名称 | 说明 | 值 |
---|---|---|
电子邮件 | Email作者联系人 | 字符串 |
链接 | 作者/供应商页面的链接 | 字符串 |
name | 作者的姓名。 公司或人员。 | 字符串 |
MetadataCategories
名称 | 说明 | 值 |
---|---|---|
domains | 解决方案内容项的域 | string[] |
垂直 | 解决方案内容项的行业垂直 | string[] |
MetadataDependencies
名称 | 说明 | 值 |
---|---|---|
contentId | 我们依赖的内容项的 ID | 字符串 |
条件 | 根据 AND/OR 运算符,这是我们必须满足的依赖项列表 | MetadataDependencies[] |
kind | 我们依赖的内容项的类型 | “AnalyticsRule” “AnalyticsRuleTemplate” “AutomationRule” “AzureFunction” “DataConnector” “DataType” “HuntingQuery” “InvestigationQuery” “LogicAppsCustomConnector” “Parser” “Playbook” “PlaybookTemplate” “解决方案” “Watchlist” “WatchlistTemplate” “工作簿” “WorkbookTemplate” |
name | 内容项的名称 | 字符串 |
运算符后的表达式 | 运算符用于条件数组中的依赖项列表。 | “AND” “OR” |
版本 | 我们依赖的内容项的版本。 可以为空、* 或缺失,以指示任何版本满足依赖项。 如果版本与定义的数字格式不匹配,则需要完全匹配。 | string |
MetadataSource
名称 | 说明 | 值 |
---|---|---|
kind | 内容的源类型 | “社区” “LocalWorkspace” “解决方案” “SourceRepository” (必需) |
name | 内容源的名称。 存储库名称、解决方案名称、LA 工作区名称等。 | 字符串 |
sourceId | 内容源的 ID。 解决方案 ID、工作区 ID 等 | string |
MetadataSupport
名称 | 说明 | 值 |
---|---|---|
电子邮件 | Email支持联系人 | string |
链接 | 支持帮助的链接,例如支持页面以打开票证等。 | string |
name | 支持联系人的姓名。 公司或人员。 | 字符串 |
层 | 对内容项的支持类型 | “社区” “Microsoft” “Partner” (必需) |
Terraform (AzAPI 提供程序) 资源定义
元数据资源类型是 扩展资源,这意味着你可以将其应用于其他资源。
parent_id
使用此资源上的 属性可设置此资源的范围。
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.SecurityInsights/metadata 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SecurityInsights/metadata@2023-02-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
author = {
email = "string"
link = "string"
name = "string"
}
categories = {
domains = [
"string"
]
verticals = [
"string"
]
}
contentId = "string"
contentSchemaVersion = "string"
customVersion = "string"
dependencies = {
contentId = "string"
criteria = [
{
kind = "string"
name = "string"
operator = "string"
version = "string"
}
firstPublishDate = "string"
icon = "string"
kind = "string"
lastPublishDate = "string"
parentId = "string"
previewImages = [
"string"
]
previewImagesDark = [
"string"
]
providers = [
"string"
]
source = {
kind = "string"
name = "string"
sourceId = "string"
}
support = {
email = "string"
link = "string"
name = "string"
tier = "string"
}
threatAnalysisTactics = [
"string"
]
threatAnalysisTechniques = [
"string"
]
version = "string"
}
etag = "string"
})
}
属性值
metadata
名称 | 说明 | Value |
---|---|---|
type | 资源类型 | “Microsoft.SecurityInsights/metadata@2023-02-01-preview” |
name | 资源名称 | 字符串 (必需) |
parent_id | 要向其应用此扩展资源的资源的 ID。 | 字符串 (必需) |
etag | Azure 资源的 Etag | string |
properties | 元数据属性 | MetadataProperties |
MetadataProperties
名称 | 说明 | 值 |
---|---|---|
author | 内容项的创建者。 | MetadataAuthor |
Categories | 解决方案内容项的类别 | MetadataCategories |
contentId | 内容的静态 ID。 用于识别解决方案或社区中依赖项和内容。 用于现成内容和解决方案的硬编码/静态。 用户创建的动态。 这是资源名称 | string |
contentSchemaVersion | 内容的架构版本。 可用于根据架构版本区分不同的流 | string |
customVersion | 内容的自定义版本。 可选自由文本 | string |
依赖项 | 内容项的依赖项,它需要哪些其他内容项才能工作。 可以使用递归/嵌套结构描述更复杂的依赖项。 对于单个依赖项,可以为复杂格式提供 id/kind/version 或运算符/条件。 | MetadataDependencies |
firstPublishDate | 首次发布日期解决方案内容项 | string |
icon | 图标标识符。 以后可以从解决方案模板中提取此 ID | string |
kind | 元数据所针对的内容类型。 | “AnalyticsRule” “AnalyticsRuleTemplate” “AutomationRule” “AzureFunction” “DataConnector” “DataType” “HuntingQuery” “InvestigationQuery” “LogicAppsCustomConnector” “分析器” “Playbook” “PlaybookTemplate” “解决方案” “Watchlist” “WatchlistTemplate” “工作簿” “WorkbookTemplate” (必需) |
lastPublishDate | 解决方案内容项的上次发布日期 | string |
parentId | 元数据所针对的内容项的完整父资源 ID。 这是完整的资源 ID,包括范围 (订阅和资源组) | 字符串 (必需) |
previewImages | 预览图像文件名。 这些内容将取自解决方案项目 | string[] |
previewImagesDark | 预览图像文件名。 这些将取自解决方案项目。 用于深色主题支持 | string[] |
providers | 解决方案内容项的提供程序 | string[] |
source | 内容的源。 这是创建它的位置/方式。 | MetadataSource |
support | 元数据的支持信息 - 类型、姓名、联系信息 | MetadataSupport |
threatAnalysisTactics | 资源涵盖的策略 | string[] |
threatAnalysisTechniques | 资源涵盖的技术,这些技术必须与所使用的策略保持一致 | string[] |
版本 | 内容的版本。 默认和建议的格式是数字 (例如 1、1.0、1.0.0、1.0.0、1.0.0) ,遵循 ARM 模板最佳做法。 也可以是任何字符串,但我们无法保证任何版本检查 | string |
MetadataAuthor
名称 | 说明 | 值 |
---|---|---|
电子邮件 | Email作者联系人 | string |
链接 | 作者/供应商页面的链接 | string |
name | 作者的姓名。 公司或人员。 | string |
MetadataCategories
名称 | 说明 | 值 |
---|---|---|
domains | 解决方案内容项的域 | string[] |
垂直 | 解决方案内容项的行业垂直 | string[] |
MetadataDependencies
名称 | 说明 | 值 |
---|---|---|
contentId | 我们依赖的内容项的 ID | 字符串 |
条件 | 这是我们必须满足的依赖项列表,根据 AND/OR 运算符 | MetadataDependencies[] |
kind | 我们依赖的内容项的类型 | “AnalyticsRule” “AnalyticsRuleTemplate” “AutomationRule” “AzureFunction” “DataConnector” “DataType” “HuntingQuery” “InvestigationQuery” “LogicAppsCustomConnector” “分析器” “Playbook” “PlaybookTemplate” “解决方案” “Watchlist” “WatchlistTemplate” “Workbook” “WorkbookTemplate” |
name | 内容项的名称 | 字符串 |
运算符后的表达式 | 用于条件数组中的依赖项列表的运算符。 | “AND” “OR” |
版本 | 我们依赖的内容项的版本。 可以为空、* 或缺失,以指示任何版本满足依赖项。 如果版本与我们定义的数字格式不匹配,则需要完全匹配。 | 字符串 |
MetadataSource
名称 | 说明 | 值 |
---|---|---|
kind | 内容的源类型 | “Community” “LocalWorkspace” “解决方案” 需要“SourceRepository” () |
name | 内容源的名称。 存储库名称、解决方案名称、LA 工作区名称等。 | 字符串 |
sourceId | 内容源的 ID。 解决方案 ID、工作区 ID 等 | string |
MetadataSupport
名称 | 说明 | 值 |
---|---|---|
电子邮件 | 支持联系人Email | 字符串 |
链接 | 支持帮助链接,例如支持页面以打开票证等。 | string |
name | 支持联系人的姓名。 公司或个人。 | 字符串 |
层 | 对内容项的支持类型 | “Community” “Microsoft” 需要“合作伙伴” () |