通过

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

Microsoft.Security assessmentMetadata 2020-01-01

  • 项目

Bicep 资源定义

assessmentMetadata 资源类型是 扩展资源，这意味着你可以将其应用到另一个资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 Bicep 中设置扩展资源的范围。

可以使用面向以下操作部署 assessmentMetadata 资源类型：

可以在以下级别将此资源类型引用为只读资源： 租户

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Security/assessmentMetadata 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Security/assessmentMetadata@2020-01-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    assessmentType: 'string'
    categories: [
      'string'
    ]
    description: 'string'
    displayName: 'string'
    implementationEffort: 'string'
    partnerData: {
      partnerName: 'string'
      productName: 'string'
      secret: 'string'
    }
    preview: bool
    remediationDescription: 'string'
    severity: 'string'
    threats: [
      'string'
    ]
    userImpact: 'string'
  }
}

属性值

assessmentMetadata

名称 说明 值
name 资源名称 字符串 (必需)

字符限制：1-260

有效字符：
字母数字、下划线字符和连字符。
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 Bicep，请将此属性设置为资源的符号名称以应用 扩展资源。
properties 描述评估元数据的属性。 SecurityAssessmentMetadataProperties

SecurityAssessmentMetadataProperties

名称 说明 值
assessmentType 如果基于内置Azure Policy定义的评估，则为 BuiltIn;如果评估基于自定义Azure Policy定义，则为 Custom “BuiltIn”
“CustomPolicy”
“CustomerManaged”
“VerifiedPartner” (必需)
Categories 包含任意项的字符串数组：
“计算”
“数据”
“IdentityAndAccess”
“IoT”
“网络”
description 评估的人工可读说明 字符串
displayName 评估的用户友好显示名称 字符串 (必需)
implementationEffort 修正此评估所需的实现工作 “高”
“低”
“中等”
partnerData 描述创建评估的合作伙伴 SecurityAssessmentMetadataPartnerData
预览 如此 如果此评估处于预览发布状态 bool
remediationDescription 关于缓解此安全问题应执行的操作的人工可读说明 字符串
severity 评估的严重性级别 “高”
“低”
“中等” (必需)
威胁 包含任意项的字符串数组：
“accountBreach”
“dataExfiltration”
“dataSpillage”
“denialOfService”
“elevationOfPrivilege”
“maliciousInsider”
“missingCoverage”
“threatResistance”
userImpact 评估的用户影响 “高”
“低”
“中等”

SecurityAssessmentMetadataPartnerData

名称 说明 值
partnerName 合作伙伴的公司名称 字符串 (必需)
productName 创建评估的合作伙伴的产品的名称 string
secret 用于对合作伙伴进行身份验证并验证其创建评估的机密 - 仅写入 字符串 (必需)

约束：
敏感值。 作为安全参数传入。

ARM 模板资源定义

assessmentMetadata 资源类型是 扩展资源，这意味着你可以将其应用到另一个资源。

scope使用此资源上的 属性可设置此资源的范围。 请参阅 在 ARM 模板中设置扩展资源的范围。

可以使用面向以下操作部署 assessmentMetadata 资源类型：

可以在以下级别将此资源类型引用为只读资源： 租户

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Security/assessmentMetadata 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Security/assessmentMetadata",
  "apiVersion": "2020-01-01",
  "name": "string",
  "scope": "string",
  "properties": {
    "assessmentType": "string",
    "categories": [ "string" ],
    "description": "string",
    "displayName": "string",
    "implementationEffort": "string",
    "partnerData": {
      "partnerName": "string",
      "productName": "string",
      "secret": "string"
    },
    "preview": "bool",
    "remediationDescription": "string",
    "severity": "string",
    "threats": [ "string" ],
    "userImpact": "string"
  }
}

属性值

assessmentMetadata

名称 说明 Value
type 资源类型 “Microsoft.Security/assessmentMetadata”
apiVersion 资源 API 版本 '2020-01-01'
name 资源名称 字符串 (必需)

字符限制：1-260

有效字符：
字母数字、下划线字符和连字符。
scope 在与部署范围不同的范围创建扩展资源时使用 。 目标资源

对于 JSON，请将值设置为要向其应用 扩展资源 的资源的全名。
properties 描述评估元数据的属性。 SecurityAssessmentMetadataProperties

SecurityAssessmentMetadataProperties

名称 说明 值
assessmentType 如果基于内置Azure Policy定义的评估，则为 BuiltIn;如果评估基于自定义Azure Policy定义，则为 Custom “BuiltIn”
“CustomPolicy”
“CustomerManaged”
“VerifiedPartner” (必需)
Categories 包含任意项的字符串数组：
“计算”
“数据”
“IdentityAndAccess”
“IoT”
“网络”
description 评估的人工可读说明 string
displayName 评估的用户友好显示名称 字符串 (必需)
implementationEffort 修正此评估所需的实现工作 “高”
“低”
“中等”
partnerData 描述创建评估的合作伙伴 SecurityAssessmentMetadataPartnerData
预览 如此 如果此评估处于预览发布状态 bool
remediationDescription 关于缓解此安全问题应执行的操作的人工可读说明 字符串
severity 评估的严重性级别 “高”
“低”
“中等” (必需)
威胁 包含任意项的字符串数组：
“accountBreach”
“dataExfiltration”
“dataSpillage”
“denialOfService”
“elevationOfPrivilege”
“maliciousInsider”
“missingCoverage”
“threatResistance”
userImpact 评估的用户影响 “高”
“低”
“中等”

SecurityAssessmentMetadataPartnerData

名称 说明 值
partnerName 合作伙伴的公司名称 字符串 (必需)
productName 创建评估的合作伙伴的产品的名称 string
secret 用于对合作伙伴进行身份验证并验证其创建评估的机密 - 仅写入 字符串 (必需)

约束：
敏感值。 作为安全参数传入。

Terraform (AzAPI 提供程序) 资源定义

assessmentMetadata 资源类型是 扩展资源，这意味着你可以将其应用到另一个资源。

parent_id使用此资源上的 属性可设置此资源的范围。

可以使用面向以下操作部署 assessmentMetadata 资源类型：

  • 订阅

可以在以下级别将此资源类型引用为只读资源： 租户

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Security/assessmentMetadata 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessmentMetadata@2020-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      assessmentType = "string"
      categories = [
        "string"
      ]
      description = "string"
      displayName = "string"
      implementationEffort = "string"
      partnerData = {
        partnerName = "string"
        productName = "string"
        secret = "string"
      }
      preview = bool
      remediationDescription = "string"
      severity = "string"
      threats = [
        "string"
      ]
      userImpact = "string"
    }
  })
}

属性值

assessmentMetadata

名称 说明 Value
type 资源类型 “Microsoft.Security/assessmentMetadata@2020-01-01”
name 资源名称 字符串 (必需)

字符限制：1-260

有效字符：
字母数字、下划线字符和连字符。
parent_id 要向其应用此扩展资源的资源的 ID。 字符串 (必需)
properties 描述评估元数据的属性。 SecurityAssessmentMetadataProperties

SecurityAssessmentMetadataProperties

名称 说明 值
assessmentType 如果基于内置Azure Policy定义的评估，则为 BuiltIn;如果评估基于自定义Azure Policy定义，则为 Custom “BuiltIn”
“CustomPolicy”
“CustomerManaged”
“VerifiedPartner” (必需)
Categories 包含任意项的字符串数组：
“计算”
“数据”
“IdentityAndAccess”
"IoT"
“网络”
description 评估的人工可读说明 字符串
displayName 评估的用户友好显示名称 字符串 (必需)
implementationEffort 修正此评估所需的实现工作 "High"
"Low"
“中等”
partnerData 描述创建评估的合作伙伴 SecurityAssessmentMetadataPartnerData
预览 如此 如果此评估处于预览发布状态 bool
remediationDescription 关于缓解此安全问题应执行的操作的人工可读说明 字符串
severity 评估的严重性级别 "High"
"Low"
需要“中等” ()
威胁 包含任意项的字符串数组：
“accountBreach”
“dataExfiltration”
“dataSpillage”
“denialOfService”
“elevationOfPrivilege”
“maliciousInsider”
“missingCoverage”
“threatResistance”
userImpact 评估的用户影响 "High"
"Low"
“中等”

SecurityAssessmentMetadataPartnerData

名称 说明 值
partnerName 合作伙伴的公司名称 字符串 (必需)
productName 创建评估的合作伙伴的产品名称 字符串
secret 用于对合作伙伴进行身份验证并验证其创建评估的机密 - 仅写入 字符串 (必需)

约束：
敏感值。 作为安全参数传入。