Assessments - Get

參考

Service:: Defender for Cloud

API Version:: 2020-01-01

取得掃描資源的安全性評估

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
assessmentName	path	True	string	評定金鑰 - 評量類型的唯一索引鍵
resourceId	path	True	string	資源的標識碼。
api-version	query	True	string	作業的 API 版本
$expand	query		ExpandEnum	OData 展開。選擇性。

回應

名稱	類型	Description
200 OK	SecurityAssessment	確定
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	模擬您的用戶帳戶

範例

Get security recommendation task from security data location

Get security recommendation task from security data location with expand parameter

Get security recommendation task from security data location

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"
    },
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "status": {
      "code": "NotApplicable",
      "cause": "OffByPolicy",
      "description": "The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"
    },
    "additionalData": {
      "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
    }
  }
}

Get security recommendation task from security data location with expand parameter

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01&$expand=links

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"
    },
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "status": {
      "code": "NotApplicable",
      "cause": "OffByPolicy",
      "description": "The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"
    },
    "additionalData": {
      "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
    },
    "links": {
      "azurePortalUri": "https://www.portal.azure.com/?fea#blade/Microsoft_Azure_Security/RecommendationsBlade/assessmentKey/21300918-b2e3-0346-785f-c77ff57d243b"
    }
  }
}

定義

名稱	Description
AssessmentLinks	與評量相關的連結
AssessmentStatus	評量的結果
AssessmentStatusCode	評估狀態的程式代碼程式代碼
assessmentType	BuiltIn 如果以內建 Azure 原則定義為基礎的評定，則為 Custom，如果根據自定義 Azure 原則定義進行評量，則為 Custom
AzureResourceDetails	已評估的 Azure 資源詳細數據
categories
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式.) 。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ExpandEnum	OData 展開。選擇性。
implementationEffort	補救此評估所需的實作工作
OnPremiseResourceDetails	已評估的內部部署資源詳細數據
OnPremiseSqlResourceDetails	已評估的內部部署 Sql 資源詳細數據
SecurityAssessment	資源的安全性評估
SecurityAssessmentMetadataPartnerData	描述建立評定的合作夥伴
SecurityAssessmentMetadataProperties	描述評量元數據的屬性。
SecurityAssessmentPartnerData	第三方合作夥伴整合的相關數據
severity	評定的嚴重性層級
threats
userImpact	評估的用戶影響

AssessmentLinks

與評量相關的連結

名稱	類型	Description
azurePortalUri	string	Azure 入口網站中評定的連結

AssessmentStatus

評量的結果

名稱	類型	Description
cause	string	評估狀態原因的程式設計程序代碼
code	AssessmentStatusCode	評估狀態的程式代碼程式代碼
description	string	評估狀態的人類可讀描述

AssessmentStatusCode

評估狀態的程式代碼程式代碼

名稱	類型	Description
Healthy	string	資源狀況良好
NotApplicable	string	此資源的評量未發生
Unhealthy	string	資源有需要解決的安全性問題

assessmentType

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

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

AzureResourceDetails

已評估的 Azure 資源詳細數據

名稱	類型	Description
id	string	已評估資源的 Azure 資源識別碼
source	string: Azure	評估資源所在的平臺

名稱	類型	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	其他信息類型。

ExpandEnum

OData 展開。選擇性。

名稱	類型	Description
links	string	與評量相關聯的所有連結
metadata	string	評定元數據

implementationEffort

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

名稱	類型	Description
High	string
Low	string
Moderate	string

OnPremiseResourceDetails

已評估的內部部署資源詳細數據

名稱	類型	Description
machineName	string	計算機的名稱
source	string: OnPremise	評估資源所在的平臺
sourceComputerId	string	計算機上安裝的 oms 代理程式識別碼
vmuuid	string	計算機的唯一標識碼
workspaceId	string	機器所連結工作區的 Azure 資源識別碼

OnPremiseSqlResourceDetails

已評估的內部部署 Sql 資源詳細數據

名稱	類型	Description
databaseName	string	計算機上安裝的 Sql 資料庫名稱
machineName	string	計算機的名稱
serverName	string	計算機上安裝的 Sql Server 名稱
source	string: OnPremiseSql	評估資源所在的平臺
sourceComputerId	string	計算機上安裝的 oms 代理程式識別碼
vmuuid	string	計算機的唯一標識碼
workspaceId	string	機器所連結工作區的 Azure 資源識別碼

SecurityAssessment

資源的安全性評估

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.additionalData	object	關於評量的其他數據
properties.displayName	string	評估的使用者易記顯示名稱
properties.links	AssessmentLinks	與評量相關的連結
properties.metadata	SecurityAssessmentMetadataProperties	描述評量元數據的屬性。
properties.partnersData	SecurityAssessmentPartnerData	第三方合作夥伴整合的相關數據
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	已評估之資源的詳細數據
properties.status	AssessmentStatus	評量的結果
type	string	資源類型

SecurityAssessmentMetadataPartnerData

描述建立評定的合作夥伴

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

SecurityAssessmentMetadataProperties

描述評量元數據的屬性。

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

SecurityAssessmentPartnerData

第三方合作夥伴整合的相關數據

名稱	類型	Description
partnerName	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 - Get

URI 參數

回應

安全性

azure_auth

Scopes

範例

Get security recommendation task from security data location

Sample Request

Sample Response

Get security recommendation task from security data location with expand parameter

Sample Request

Sample Response

定義

AssessmentLinks

AssessmentStatus

AssessmentStatusCode

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

ExpandEnum

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessment

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

severity

threats

userImpact

其他資源