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 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	Description
assessmentMetadataName	path	True	string	評定金鑰 - 評量類型的唯一索引鍵
subscriptionId	path	True	string	Azure 訂用帳戶識別碼 Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	作業的 API 版本

assessmentMetadataName

path

True

string

評定金鑰 - 評量類型的唯一索引鍵

subscriptionId

path

True

string

Azure 訂用帳戶識別碼

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

作業的 API 版本

要求本文

名稱	必要	類型	Description
properties.assessmentType	True	assessmentType	BuiltIn 如果以內建 Azure 原則定義為基礎的評定，則為自定義，如果根據自定義 Azure 原則定義進行評量，則為自定義
properties.displayName	True	string	評估的使用者易記顯示名稱
properties.severity	True	severity	評定的嚴重性層級
properties.categories		categories[]	評估狀況不良時，處於風險的資源類別
properties.description		string	評估的人類可讀描述
properties.implementationEffort		implementationEffort	補救此評估所需的實作工作
properties.partnerData		SecurityAssessmentMetadataPartnerData	描述建立評定的合作夥伴
properties.preview		boolean	如果此評估處於預覽版本狀態，則為 True
properties.remediationDescription		string	人類可閱讀的可閱讀說明，以減輕此安全性問題
properties.threats		threats[]	評估的威脅影響
properties.userImpact		userImpact	評估的用戶影響

回應

名稱	類型	Description
200 OK	SecurityAssessmentMetadata	確定
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	Description
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"
  }
}

定義

名稱	Description
assessmentType	BuiltIn 如果以內建 Azure 原則定義為基礎的評定，則為自定義，如果根據自定義 Azure 原則定義進行評量，則為自定義
categories
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式.) 。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
implementationEffort	補救此評估所需的實作工作
SecurityAssessmentMetadata	安全性評估元數據
SecurityAssessmentMetadataPartnerData	描述建立評定的合作夥伴
severity	評定的嚴重性層級
threats
userImpact	評估的用戶影響

assessmentType

BuiltIn 如果以內建 Azure 原則定義為基礎的評定，則為自定義，如果根據自定義 Azure 原則定義進行評量，則為自定義

名稱	類型	Description
BuiltIn	string	雲端受控評量 Microsoft Defender
CustomPolicy	string	自動從 Azure 原則擷取到雲端 Microsoft Defender的使用者定義原則
CustomerManaged	string	使用者或其他第三方直接推送至雲端 Microsoft Defender
VerifiedPartner	string	如果使用者將其連線到 ASC，由已驗證的第三方所建立的評量

名稱	類型	Description
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式.) 。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細資料。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

implementationEffort

補救此評估所需的實作工作

名稱	類型	Description
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

安全性評估元數據

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.assessmentType	assessmentType	BuiltIn 如果以內建 Azure 原則定義為基礎的評定，則為自定義，如果根據自定義 Azure 原則定義進行評量，則為自定義
properties.categories	categories[]	評估狀況不良時，處於風險的資源類別
properties.description	string	評估的人類可讀描述
properties.displayName	string	評估的使用者易記顯示名稱
properties.implementationEffort	implementationEffort	補救此評估所需的實作工作
properties.partnerData	SecurityAssessmentMetadataPartnerData	描述建立評定的合作夥伴
properties.policyDefinitionId	string	開啟此評估計算的原則定義 Azure 資源識別碼
properties.preview	boolean	如果此評估處於預覽版本狀態，則為 True
properties.remediationDescription	string	人類可閱讀的可閱讀說明，以減輕此安全性問題
properties.severity	severity	評定的嚴重性層級
properties.threats	threats[]	評估的威脅影響
properties.userImpact	userImpact	評估的用戶影響
type	string	資源類型

SecurityAssessmentMetadataPartnerData

描述建立評定的合作夥伴

名稱	類型	Description
partnerName	string	合作夥伴公司的名稱
productName	string	建立評量之合作夥伴的產品名稱
secret	string	驗證合作夥伴並確認其已建立評定的秘密 - 僅寫入

severity

評定的嚴重性層級

名稱	類型	Description
High	string
Low	string
Medium	string

threats

名稱	類型	Description
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

評估的用戶影響

名稱	類型	Description
High	string
Low	string
Moderate	string

共用方式為

Assessments Metadata - Create In Subscription

URI 參數

要求本文

回應

安全性

azure_auth

Scopes

範例

Create security assessment metadata for subscription

Sample Request

Sample Response

定義

assessmentType

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

implementationEffort

SecurityAssessmentMetadata

SecurityAssessmentMetadataPartnerData

severity

threats

userImpact

其他資源