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

Microsoft.Security assessments 2020-01-01

• 最新
• 2021-06-01
• 2020-01-01
• 2019-01-01-preview

Bicep 资源定义

可以使用目标操作部署评估资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.Security/assessments@2020-01-01' = {
  name: 'string'
  properties: {
    additionalData: {
      {customized property}: 'string'
    }
    metadata: {
      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'
    }
    partnersData: {
      partnerName: 'string'
      secret: 'string'
    }
    resourceDetails: {
      source: 'string'
      // For remaining properties, see ResourceDetails objects
    }
    status: {
      cause: 'string'
      code: 'string'
      description: 'string'
    }
  }
}

ResourceDetails 对象

设置 源 属性以指定对象的类型。

对于 Azure，请使用：

{
  source: 'Azure'
}

对于 OnPremiseSql，请使用：

{
  databaseName: 'string'
  machineName: 'string'
  serverName: 'string'
  source: 'OnPremiseSql'
  sourceComputerId: 'string'
  vmuuid: 'string'
  workspaceId: 'string'
}

属性值

AssessmentStatus

名字	描述	价值
原因	评估状态原因的编程代码	字符串
法典	评估状态的编程代码	“正常” “NotApplicable” “不正常”（必需）
描述	评估状态的人工可读说明	字符串

AzureResourceDetails

名字	描述	价值
源	评估资源所在的平台	“Azure”（必需）

Microsoft.Security/assessments

名字	描述	价值
名字	资源名称	string （必需）
性能	描述评估的属性。	SecurityAssessmentProperties

OnPremiseSqlResourceDetails

名字	描述	价值
databaseName	计算机上安装的 Sql 数据库名称	string （必需）
machineName	计算机的名称	string （必需）
serverName	计算机上安装的 Sql Server 名称	string （必需）
源	评估资源所在的平台	“OnPremiseSql”（必需）
sourceComputerId	计算机上安装的 oms 代理 ID	string （必需）
vmuuid	计算机的唯一 ID	string （必需）
workspaceId	计算机附加到的工作区的 Azure 资源 ID	string （必需）

ResourceDetails

名字	描述	价值
源	对于 AzureResourceDetails，请设置为“Azure”。 对于 onPremiseSqlResourceDetails，请设置为“OnPremiseSql”类型。	“Azure” “OnPremiseSql”（必需）

SecurityAssessmentMetadataPartnerData

名字	描述	价值
partnerName	合作伙伴公司的名称	string （必需）
productName	创建评估的合作伙伴的产品的名称	字符串
秘密	对合作伙伴进行身份验证并验证其是否创建了评估的机密 - 仅写入	字符串 约束： 敏感值。 以安全参数的形式传入。 （必需）

SecurityAssessmentMetadataProperties

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

SecurityAssessmentPartnerData

名字	描述	价值
partnerName	合作伙伴公司的名称	string （必需）
秘密	用于对合作伙伴进行身份验证的机密 - 仅写入	字符串 约束： 敏感值。 以安全参数的形式传入。 （必需）

SecurityAssessmentProperties

名字	描述	价值
additionalData	有关评估的其他数据	SecurityAssessmentPropertiesAdditionalData
元数据	描述评估元数据的属性。	SecurityAssessmentMetadataProperties
partnersData	有关第三方合作伙伴集成的数据	SecurityAssessmentPartnerData
resourceDetails	已评估的资源的详细信息	ResourceDetails （必需）
地位	评估结果	AssessmentStatus （必需）

SecurityAssessmentPropertiesAdditionalData

名字	描述	价值

ARM 模板资源定义

可以使用目标操作部署评估资源类型：

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

资源格式

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

{
  "type": "Microsoft.Security/assessments",
  "apiVersion": "2020-01-01",
  "name": "string",
  "properties": {
    "additionalData": {
      "{customized property}": "string"
    },
    "metadata": {
      "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"
    },
    "partnersData": {
      "partnerName": "string",
      "secret": "string"
    },
    "resourceDetails": {
      "source": "string"
      // For remaining properties, see ResourceDetails objects
    },
    "status": {
      "cause": "string",
      "code": "string",
      "description": "string"
    }
  }
}

ResourceDetails 对象

设置 源 属性以指定对象的类型。

对于 Azure，请使用：

{
  "source": "Azure"
}

对于 OnPremiseSql，请使用：

{
  "databaseName": "string",
  "machineName": "string",
  "serverName": "string",
  "source": "OnPremiseSql",
  "sourceComputerId": "string",
  "vmuuid": "string",
  "workspaceId": "string"
}

属性值

AssessmentStatus

名字	描述	价值
原因	评估状态原因的编程代码	字符串
法典	评估状态的编程代码	“正常” “NotApplicable” “不正常”（必需）
描述	评估状态的人工可读说明	字符串

AzureResourceDetails

名字	描述	价值
源	评估资源所在的平台	“Azure”（必需）

Microsoft.Security/assessments

名字	描述	价值
apiVersion	API 版本	'2020-01-01'
名字	资源名称	string （必需）
性能	描述评估的属性。	SecurityAssessmentProperties
类型	资源类型	“Microsoft.Security/assessments”

OnPremiseSqlResourceDetails

名字	描述	价值
databaseName	计算机上安装的 Sql 数据库名称	string （必需）
machineName	计算机的名称	string （必需）
serverName	计算机上安装的 Sql Server 名称	string （必需）
源	评估资源所在的平台	“OnPremiseSql”（必需）
sourceComputerId	计算机上安装的 oms 代理 ID	string （必需）
vmuuid	计算机的唯一 ID	string （必需）
workspaceId	计算机附加到的工作区的 Azure 资源 ID	string （必需）

ResourceDetails

名字	描述	价值
源	对于 AzureResourceDetails，请设置为“Azure”。 对于 onPremiseSqlResourceDetails，请设置为“OnPremiseSql”类型。	“Azure” “OnPremiseSql”（必需）

SecurityAssessmentMetadataPartnerData

名字	描述	价值
partnerName	合作伙伴公司的名称	string （必需）
productName	创建评估的合作伙伴的产品的名称	字符串
秘密	对合作伙伴进行身份验证并验证其是否创建了评估的机密 - 仅写入	字符串 约束： 敏感值。 以安全参数的形式传入。 （必需）

SecurityAssessmentMetadataProperties

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

SecurityAssessmentPartnerData

名字	描述	价值
partnerName	合作伙伴公司的名称	string （必需）
秘密	用于对合作伙伴进行身份验证的机密 - 仅写入	字符串 约束： 敏感值。 以安全参数的形式传入。 （必需）

SecurityAssessmentProperties

名字	描述	价值
additionalData	有关评估的其他数据	SecurityAssessmentPropertiesAdditionalData
元数据	描述评估元数据的属性。	SecurityAssessmentMetadataProperties
partnersData	有关第三方合作伙伴集成的数据	SecurityAssessmentPartnerData
resourceDetails	已评估的资源的详细信息	ResourceDetails （必需）
地位	评估结果	AssessmentStatus （必需）

SecurityAssessmentPropertiesAdditionalData

名字	描述	价值

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署评估资源类型：

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/assessments@2020-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      additionalData = {
        {customized property} = "string"
      }
      metadata = {
        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"
      }
      partnersData = {
        partnerName = "string"
        secret = "string"
      }
      resourceDetails = {
        source = "string"
        // For remaining properties, see ResourceDetails objects
      }
      status = {
        cause = "string"
        code = "string"
        description = "string"
      }
    }
  })
}

ResourceDetails 对象

设置 源 属性以指定对象的类型。

对于 Azure，请使用：

{
  source = "Azure"
}

对于 OnPremiseSql，请使用：

{
  databaseName = "string"
  machineName = "string"
  serverName = "string"
  source = "OnPremiseSql"
  sourceComputerId = "string"
  vmuuid = "string"
  workspaceId = "string"
}

属性值

AssessmentStatus

名字	描述	价值
原因	评估状态原因的编程代码	字符串
法典	评估状态的编程代码	“正常” “NotApplicable” “不正常”（必需）
描述	评估状态的人工可读说明	字符串

AzureResourceDetails

名字	描述	价值
源	评估资源所在的平台	“Azure”（必需）

Microsoft.Security/assessments

名字	描述	价值
名字	资源名称	string （必需）
性能	描述评估的属性。	SecurityAssessmentProperties
类型	资源类型	“Microsoft.Security/assessments@2020-01-01”

OnPremiseSqlResourceDetails

名字	描述	价值
databaseName	计算机上安装的 Sql 数据库名称	string （必需）
machineName	计算机的名称	string （必需）
serverName	计算机上安装的 Sql Server 名称	string （必需）
源	评估资源所在的平台	“OnPremiseSql”（必需）
sourceComputerId	计算机上安装的 oms 代理 ID	string （必需）
vmuuid	计算机的唯一 ID	string （必需）
workspaceId	计算机附加到的工作区的 Azure 资源 ID	string （必需）

ResourceDetails

名字	描述	价值
源	对于 AzureResourceDetails，请设置为“Azure”。 对于 onPremiseSqlResourceDetails，请设置为“OnPremiseSql”类型。	“Azure” “OnPremiseSql”（必需）

SecurityAssessmentMetadataPartnerData

名字	描述	价值
partnerName	合作伙伴公司的名称	string （必需）
productName	创建评估的合作伙伴的产品的名称	字符串
秘密	对合作伙伴进行身份验证并验证其是否创建了评估的机密 - 仅写入	字符串 约束： 敏感值。 以安全参数的形式传入。 （必需）

SecurityAssessmentMetadataProperties

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

SecurityAssessmentPartnerData

名字	描述	价值
partnerName	合作伙伴公司的名称	string （必需）
秘密	用于对合作伙伴进行身份验证的机密 - 仅写入	字符串 约束： 敏感值。 以安全参数的形式传入。 （必需）

SecurityAssessmentProperties

名字	描述	价值
additionalData	有关评估的其他数据	SecurityAssessmentPropertiesAdditionalData
元数据	描述评估元数据的属性。	SecurityAssessmentMetadataProperties
partnersData	有关第三方合作伙伴集成的数据	SecurityAssessmentPartnerData
resourceDetails	已评估的资源的详细信息	ResourceDetails （必需）
地位	评估结果	AssessmentStatus （必需）

SecurityAssessmentPropertiesAdditionalData

名字	描述	价值