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

Assessments Metadata - Create In Subscription

Service:

Defender for Cloud

API Version:

2020-01-01

在特定订阅中创建有关评估类型的元数据信息

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}?api-version=2020-01-01

URI 参数

名称	在	必需	类型	说明
assessmentMetadataName	path	True	string	评估键 - 评估类型的唯一键
subscriptionId	path	True	string	Azure 订阅 ID Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	操作的 API 版本

请求正文

名称	必需	类型	说明
properties.assessmentType	True	assessmentType	如果基于内置Azure Policy定义的评估，则为 BuiltIn;如果评估基于自定义Azure Policy定义，则为 Custom
properties.displayName	True	string	评估的用户友好显示名称
properties.severity	True	severity	评估的严重性级别
properties.categories		categories[]	评估不正常时有风险的资源类别
properties.description		string	评估的人工可读说明
properties.implementationEffort		implementationEffort	修正此评估所需的实现工作
properties.partnerData		SecurityAssessmentMetadataPartnerData	描述创建评估的合作伙伴
properties.preview		boolean	如此 如果此评估处于预览发布状态
properties.remediationDescription		string	关于缓解此安全问题应执行的操作的人工可读说明
properties.threats		threats[]	评估的威胁影响
properties.userImpact		userImpact	评估的用户影响

响应

名称	类型	说明
200 OK	SecurityAssessmentMetadata	确定
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Create security assessment metadata for subscription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/0980887d-03d6-408c-9566-532f3456804e/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7?api-version=2020-01-01

{
  "properties": {
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "description": "Install an endpoint protection solution on your virtual machines scale sets, to protect them from threats and vulnerabilities.",
    "remediationDescription": "To install an endpoint protection solution: 1.  <a href=\"https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-faq#how-do-i-turn-on-antimalware-in-my-virtual-machine-scale-set\">Follow the instructions in How do I turn on antimalware in my virtual machine scale set</a>",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Sample Response

Status code:

200

{
  "id": "/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "name": "ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "type": "Microsoft.Security/assessmentMetadata",
  "properties": {
    "displayName": "My organization security assessment",
    "description": "Assessment that my organization created to view our security assessment in Azure Security Center",
    "remediationDescription": "Fix it with these remediation instructions",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

定义

名称	说明
assessmentType	如果基于内置Azure Policy定义的评估，则为 BuiltIn;如果评估基于自定义Azure Policy定义，则为 Custom
categories
CloudError	对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。
CloudErrorBody	错误详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
implementationEffort	修正此评估所需的实现工作
SecurityAssessmentMetadata	安全评估元数据
SecurityAssessmentMetadataPartnerData	描述创建评估的合作伙伴
severity	评估的严重性级别
threats
userImpact	评估的用户影响

assessmentType

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

名称	类型	说明
BuiltIn	string	云托管评估的Microsoft Defender
CustomPolicy	string	从 Azure Policy 自动引入到 Microsoft Defender for Cloud 的用户定义策略
CustomerManaged	string	用户或其他第三方直接推送到 Microsoft Defender for Cloud 的用户评估
VerifiedPartner	string	如果用户将已验证的第三方连接到 ASC，则由已验证的第三方创建的评估

categories

名称	类型	说明
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

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

名称	类型	说明
error.additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
error.code	string	错误代码。
error.details	CloudErrorBody[]	错误详细信息。
error.message	string	错误消息。
error.target	string	错误目标。

CloudErrorBody

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	CloudErrorBody[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

implementationEffort

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

名称	类型	说明
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

安全评估元数据

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties.assessmentType	assessmentType	如果基于内置Azure Policy定义的评估，则为 BuiltIn;如果评估基于自定义Azure Policy定义，则为 Custom
properties.categories	categories[]	评估不正常时有风险的资源类别
properties.description	string	评估的人工可读说明
properties.displayName	string	评估的用户友好显示名称
properties.implementationEffort	implementationEffort	修正此评估所需的实现工作
properties.partnerData	SecurityAssessmentMetadataPartnerData	描述创建评估的合作伙伴
properties.policyDefinitionId	string	启用此评估计算的策略定义的 Azure 资源 ID
properties.preview	boolean	如此 如果此评估处于预览发布状态
properties.remediationDescription	string	关于缓解此安全问题应执行的操作的人工可读说明
properties.severity	severity	评估的严重性级别
properties.threats	threats[]	评估的威胁影响
properties.userImpact	userImpact	评估的用户影响
type	string	资源类型

SecurityAssessmentMetadataPartnerData

描述创建评估的合作伙伴

名称	类型	说明
partnerName	string	合作伙伴的公司名称
productName	string	创建评估的合作伙伴的产品的名称
secret	string	用于对合作伙伴进行身份验证并验证其创建评估的机密 - 仅写入

severity

评估的严重性级别

名称	类型	说明
High	string
Low	string
Medium	string

threats

名称	类型	说明
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

评估的用户影响

名称	类型	说明
High	string
Low	string
Moderate	string