通过

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

Assessments - Create Or Update

  • 参考
服务:
Defender for Cloud
API 版本:
2020-01-01

在资源上创建安全评估。 在插入评估结果之前，必须使用相同的名称预定义描述此评估的评估元数据

PUT https://management.azure.com/{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}?api-version=2020-01-01

URI 参数

名称 在 必需 类型 说明
assessmentName
 path True

string

评估密钥 - 评估类型的唯一键
resourceId
 path True

string

资源的标识符。
api-version
 query True

string

作的 API 版本

请求正文

名称 必需 类型 说明
properties.resourceDetails True ResourceDetails:

已评估的资源的详细信息
properties.status True

AssessmentStatus

评估结果
properties.additionalData

object

有关评估的其他数据
properties.metadata

SecurityAssessmentMetadataProperties

描述评估元数据的属性。
properties.partnersData

SecurityAssessmentPartnerData

有关第三方合作伙伴集成的数据

响应

名称 类型 说明
200 OK

SecurityAssessment

确定 - 已更新
201 Created

SecurityAssessment

已创建
Other Status Codes

CloudError

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create security recommendation task on a resource

示例请求

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e?api-version=2020-01-01

{
  "properties": {
    "resourceDetails": {
      "source": "Azure"
    },
    "status": {
      "code": "Healthy"
    }
  }
}

示例响应

状态代码:
200 
{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "name": "8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"
    },
    "displayName": "Install internal agent on VM",
    "status": {
      "code": "Healthy"
    }
  }
}
状态代码:
201 
{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "name": "8bb8be0a-6010-4789-812f-e4d661c4ed0e",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/providers/Microsoft.Security/assessments/8bb8be0a-6010-4789-812f-e4d661c4ed0e"
    },
    "displayName": "Install internal agent on VM",
    "status": {
      "code": "Healthy"
    }
  }
}

定义

名称 说明
AssessmentLinks

与评估相关的链接
AssessmentStatus

评估结果
AssessmentStatusCode

评估状态的编程代码
assessmentType

如果基于内置 Azure Policy 定义的评估，则 BuiltIn;如果基于自定义 Azure Policy 定义的评估，则为 CustomIn
AzureResourceDetails

已评估的 Azure 资源的详细信息
categories
CloudError

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。 （这也遵循 OData 错误响应格式）。
CloudErrorBody

错误详细信息。
ErrorAdditionalInfo

资源管理错误附加信息。
implementationEffort

修正此评估所需的实施工作
OnPremiseResourceDetails

已评估的本地资源的详细信息
OnPremiseSqlResourceDetails

已评估的本地 Sql 资源的详细信息
SecurityAssessment

对资源进行安全评估
SecurityAssessmentMetadataPartnerData

描述创建评估的合作伙伴
SecurityAssessmentMetadataProperties

描述评估元数据的属性。
SecurityAssessmentPartnerData

有关第三方合作伙伴集成的数据
severity

评估的严重性级别
threats
userImpact

评估的用户影响
Object

与评估相关的链接

名称 类型 说明
azurePortalUri

string

Azure 门户中的评估链接

AssessmentStatus

Object

评估结果

名称 类型 说明
cause

string

评估状态原因的编程代码
code

AssessmentStatusCode

评估状态的编程代码
description

string

评估状态的人工可读说明

AssessmentStatusCode

枚举

评估状态的编程代码

值 说明
Healthy

资源正常
NotApplicable

此资源的评估未发生
Unhealthy

资源存在需要解决的安全问题

assessmentType

枚举

如果基于内置 Azure Policy 定义的评估，则 BuiltIn;如果基于自定义 Azure Policy 定义的评估，则为 CustomIn

值 说明
BuiltIn

Microsoft Defender for Cloud 托管评估
CustomPolicy

从 Azure Policy 自动引入到 Microsoft Defender for Cloud 的用户定义策略
CustomerManaged

用户或其他第三方直接推送到 Microsoft Defender for Cloud 的用户评估
VerifiedPartner

如果用户将其连接到 ASC，则由已验证的第三方创建的评估

AzureResourceDetails

Object

已评估的 Azure 资源的详细信息

名称 类型 说明
id

string

已评估资源的 Azure 资源 ID
source string:

Azure

评估资源所在的平台

categories

枚举
值 说明
Compute
Data
IdentityAndAccess
IoT
Networking

CloudError

Object

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。 （这也遵循 OData 错误响应格式）。

名称 类型 说明
error.additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
error.code

string

错误代码。
error.details

CloudErrorBody[]

错误详细信息。
error.message

string

错误消息。
error.target

string

错误目标。

CloudErrorBody

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

CloudErrorBody[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

implementationEffort

枚举

修正此评估所需的实施工作

值 说明
High
Low
Moderate

OnPremiseResourceDetails

Object

已评估的本地资源的详细信息

名称 类型 说明
machineName

string

计算机的名称
source string:

OnPremise

评估资源所在的平台
sourceComputerId

string

计算机上安装的 oms 代理 ID
vmuuid

string

计算机的唯一 ID
workspaceId

string

计算机附加到的工作区的 Azure 资源 ID

OnPremiseSqlResourceDetails

Object

已评估的本地 Sql 资源的详细信息

名称 类型 说明
databaseName

string

计算机上安装的 Sql 数据库名称
machineName

string

计算机的名称
serverName

string

计算机上安装的 Sql Server 名称
source string:

OnPremiseSql

评估资源所在的平台
sourceComputerId

string

计算机上安装的 oms 代理 ID
vmuuid

string

计算机的唯一 ID
workspaceId

string

计算机附加到的工作区的 Azure 资源 ID

SecurityAssessment

Object

对资源进行安全评估

名称 类型 说明
id

string

资源 ID
name

string

资源名称
properties.additionalData

object

有关评估的其他数据
properties.displayName

string

评估的用户友好显示名称
properties.links

AssessmentLinks

与评估相关的链接
properties.metadata

SecurityAssessmentMetadataProperties

描述评估元数据的属性。
properties.partnersData

SecurityAssessmentPartnerData

有关第三方合作伙伴集成的数据
properties.resourceDetails ResourceDetails:

已评估的资源的详细信息
properties.status

AssessmentStatus

评估结果
type

string

资源类型

SecurityAssessmentMetadataPartnerData

Object

描述创建评估的合作伙伴

名称 类型 说明
partnerName

string

合作伙伴公司的名称
productName

string

创建评估的合作伙伴的产品的名称
secret

string

对合作伙伴进行身份验证并验证其是否创建了评估的机密 - 仅写入

SecurityAssessmentMetadataProperties

Object

描述评估元数据的属性。

名称 类型 说明
assessmentType

assessmentType

如果基于内置 Azure Policy 定义的评估，则 BuiltIn;如果基于自定义 Azure Policy 定义的评估，则为 CustomIn
categories

categories[]

评估不正常时面临风险的资源类别
description

string

评估的人工可读说明
displayName

string

评估的用户友好显示名称
implementationEffort

implementationEffort

修正此评估所需的实施工作
partnerData

SecurityAssessmentMetadataPartnerData

描述创建评估的合作伙伴
policyDefinitionId

string

启用此评估计算的策略定义的 Azure 资源 ID
preview

boolean

如此 如果此评估处于预览版发布状态
remediationDescription

string

人工可读说明应执行的操作以缓解此安全问题
severity

severity

评估的严重性级别
threats

threats[]

评估的威胁影响
userImpact

userImpact

评估的用户影响

SecurityAssessmentPartnerData

Object

有关第三方合作伙伴集成的数据

名称 类型 说明
partnerName

string

合作伙伴公司的名称
secret

string

用于对合作伙伴进行身份验证的机密 - 仅写入

severity

枚举

评估的严重性级别

值 说明
High
Low
Medium

threats

枚举
值 说明
accountBreach
dataExfiltration
dataSpillage
denialOfService
elevationOfPrivilege
maliciousInsider
missingCoverage
threatResistance

userImpact

枚举

评估的用户影响

值 说明
High
Low
Moderate