Sub Assessments - List

Service:

Defender for Cloud

API Version:

2019-01-01-preview

取得範圍內所有掃描資源的安全性子評量

GET https://management.azure.com/{scope}/providers/Microsoft.Security/assessments/{assessmentName}/subAssessments?api-version=2019-01-01-preview

URI 參數

名稱	位於	必要	類型	Description
assessmentName	path	True	string	評定金鑰 - 評量類型的唯一索引鍵
scope	path	True	string	查詢的範圍可以是訂用帳戶 (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) 或管理群組 (/providers/Microsoft.Management/managementGroups/mgName) 。
api-version	query	True	string	作業的 API 版本

回應

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

範例

List security sub-assessments

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/assessments/82e20e14-edc5-4373-bfc4-f13121257c37/subAssessments?api-version=2019-01-01-preview

Java

/**
 * Samples for SubAssessments List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/SubAssessments/
     * ListSubAssessments_example.json
     */
    /**
     * Sample code: List security sub-assessments.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listSecuritySubAssessments(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.subAssessments().list("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
            "82e20e14-edc5-4373-bfc4-f13121257c37", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b43974e07d3204c4b6f8396627f5430994a7f7c9/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/SubAssessments/ListSubAssessments_example.json
func ExampleSubAssessmentsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSubAssessmentsClient().NewListPager("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "82e20e14-edc5-4373-bfc4-f13121257c37", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SubAssessmentList = armsecurity.SubAssessmentList{
		// 	Value: []*armsecurity.SubAssessment{
		// 		{
		// 			Name: to.Ptr("8fbe5054-e97c-3a7a-fda7-c8308ca8d3cf"),
		// 			Type: to.Ptr("Microsoft.Security/assessments/subAssessments"),
		// 			ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/ascdemoRG/providers/Microsoft.Sql/servers/sqlserver1demo/providers/Microsoft.Security/assessments/82e20e14-edc5-4373-bfc4-f13121257c37/subassessments/8fbe5054-e97c-3a7a-fda7-c8308ca8d3cf"),
		// 			Properties: &armsecurity.SubAssessmentProperties{
		// 				Description: to.Ptr("The Azure SQL Database-level firewall helps protect your data by preventing all access to your database until you specify which IP addresses have permission. Database-level firewall rules grant access to the specific database based on the originating IP address of each request.\n\nDatabase-level firewall rules for master"),
		// 				AdditionalData: &armsecurity.SQLServerVulnerabilityProperties{
		// 					AssessedResourceType: to.Ptr(armsecurity.AssessedResourceTypeSQLServerVulnerability),
		// 					Type: to.Ptr("AzureDatabase"),
		// 					Query: to.Ptr("SELECT name\n    ,start_ip_address\n    ,end_ip_address\nFROM sys.database_firewall_rules"),
		// 				},
		// 				Category: to.Ptr("SurfaceAreaReduction"),
		// 				DisplayName: to.Ptr("Database-level firewall rules should be tracked and maintained at a strict minimum"),
		// 				ID: to.Ptr("VA2064"),
		// 				Impact: to.Ptr("Firewall rules should be strictly configured to allow access only to client computers that have a valid need to connect to the database. Any superfluous entries in the firewall may pose a threat by allowing an unauthorized source access to your database."),
		// 				Remediation: to.Ptr("Evaluate each of the database-level firewall rules. Remove any rules that grant unnecessary access and set the rest as a baseline. Deviations from the baseline will be identified and brought to your attention in subsequent scans."),
		// 				ResourceDetails: &armsecurity.AzureResourceDetails{
		// 					Source: to.Ptr(armsecurity.SourceAzure),
		// 					ID: to.Ptr("/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ascdemoRG/providers/Microsoft.Sql/servers/sqlserver1demo/databases/database1"),
		// 				},
		// 				Status: &armsecurity.SubAssessmentStatus{
		// 					Cause: to.Ptr("Unknown"),
		// 					Code: to.Ptr(armsecurity.SubAssessmentStatusCodeHealthy),
		// 					Severity: to.Ptr(armsecurity.SeverityHigh),
		// 				},
		// 				TimeGenerated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-06-23T12:20:08.764Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get security sub-assessments on all your scanned resources inside a scope
 *
 * @summary Get security sub-assessments on all your scanned resources inside a scope
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/SubAssessments/ListSubAssessments_example.json
 */
async function listSecuritySubAssessments() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const assessmentName = "82e20e14-edc5-4373-bfc4-f13121257c37";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.subAssessments.list(scope, assessmentName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/SubAssessments/ListSubAssessments_example.json
// this example is just showing the usage of "SubAssessments_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SecurityAssessmentResource created on azure
// for more information of creating SecurityAssessmentResource, please refer to the document of SecurityAssessmentResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string assessmentName = "82e20e14-edc5-4373-bfc4-f13121257c37";
ResourceIdentifier securityAssessmentResourceId = SecurityAssessmentResource.CreateResourceIdentifier(scope, assessmentName);
SecurityAssessmentResource securityAssessment = client.GetSecurityAssessmentResource(securityAssessmentResourceId);

// get the collection of this SecuritySubAssessmentResource
SecuritySubAssessmentCollection collection = securityAssessment.GetSecuritySubAssessments();

// invoke the operation and iterate over the result
await foreach (SecuritySubAssessmentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SecuritySubAssessmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/ascdemoRG/providers/Microsoft.Sql/servers/sqlserver1demo/providers/Microsoft.Security/assessments/82e20e14-edc5-4373-bfc4-f13121257c37/subassessments/8fbe5054-e97c-3a7a-fda7-c8308ca8d3cf",
      "name": "8fbe5054-e97c-3a7a-fda7-c8308ca8d3cf",
      "type": "Microsoft.Security/assessments/subAssessments",
      "properties": {
        "id": "VA2064",
        "displayName": "Database-level firewall rules should be tracked and maintained at a strict minimum",
        "status": {
          "code": "Healthy",
          "severity": "High",
          "cause": "Unknown"
        },
        "remediation": "Evaluate each of the database-level firewall rules. Remove any rules that grant unnecessary access and set the rest as a baseline. Deviations from the baseline will be identified and brought to your attention in subsequent scans.",
        "impact": "Firewall rules should be strictly configured to allow access only to client computers that have a valid need to connect to the database. Any superfluous entries in the firewall may pose a threat by allowing an unauthorized source access to your database.",
        "category": "SurfaceAreaReduction",
        "description": "The Azure SQL Database-level firewall helps protect your data by preventing all access to your database until you specify which IP addresses have permission. Database-level firewall rules grant access to the specific database based on the originating IP address of each request.\n\nDatabase-level firewall rules for master",
        "timeGenerated": "2019-06-23T12:20:08.7644808Z",
        "resourceDetails": {
          "source": "Azure",
          "id": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/ascdemoRG/providers/Microsoft.Sql/servers/sqlserver1demo/databases/database1"
        },
        "additionalData": {
          "assessedResourceType": "SqlServerVulnerability",
          "type": "AzureDatabase",
          "query": "SELECT name\n    ,start_ip_address\n    ,end_ip_address\nFROM sys.database_firewall_rules",
          "benchmarks": []
        }
      }
    }
  ]
}

定義

名稱	Description
AzureResourceDetails	已評估的 Azure 資源詳細數據
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。 (這也會遵循 OData 錯誤回應格式。) 。
CloudErrorBody	錯誤詳細數據。
ContainerRegistryVulnerabilityProperties	容器登錄弱點評估的其他內容欄位
CVE	CVE 詳細數據
CVSS	CVSS 詳細數據
ErrorAdditionalInfo	資源管理錯誤其他資訊。
OnPremiseResourceDetails	已評估的內部部署資源詳細數據
OnPremiseSqlResourceDetails	已評估的內部部署 Sql 資源詳細數據
SecuritySubAssessment	資源的安全性子評量
SecuritySubAssessmentList	安全性子評量清單
ServerVulnerabilityProperties	伺服器弱點評估的其他內容欄位
severity	子評量嚴重性層級
SqlServerVulnerabilityProperties	已評估之資源的詳細數據
SubAssessmentStatus	子評量的狀態
SubAssessmentStatusCode	評估狀態的程序代碼
VendorReference	廠商參考

AzureResourceDetails

已評估的 Azure 資源詳細數據

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

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	錯誤目標。

ContainerRegistryVulnerabilityProperties

容器登錄弱點評估的其他內容欄位

名稱	類型	Description
assessedResourceType	string: ContainerRegistryVulnerability	子評量資源類型
cve	CVE[]	CVE 清單
cvss	<string,  CVSS>	從 cvss 版本到 cvss 詳細數據的字典物件
imageDigest	string	易受攻擊影像的摘要
patchable	boolean	指出是否有可用的修補程式
publishedTime	string	發佈時間
repositoryName	string	易受攻擊映像所屬的存放庫名稱
type	string	弱點類型。 例如：弱點、潛在弱點、收集的資訊、弱點
vendorReferences	VendorReference[]	廠商參考

CVE

CVE 詳細數據

名稱	類型	Description
link	string	連結 URL
title	string	CVE 標題

CVSS

CVSS 詳細數據

名稱	類型	Description
base	number	CVSS 基底

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	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 資源識別碼

SecuritySubAssessment

資源的安全性子評量

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	子評量的詳細數據
properties.category	string	子評量類別
properties.description	string	評估狀態的人類可讀描述
properties.displayName	string	子評定的用戶易記顯示名稱
properties.id	string	弱點標識碼
properties.impact	string	此子評量影響的描述
properties.remediation	string	如何補救此子評估的相關信息
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	已評估之資源的詳細數據
properties.status	SubAssessmentStatus	子評量的狀態
properties.timeGenerated	string	產生子評估的日期和時間
type	string	資源類型

SecuritySubAssessmentList

安全性子評量清單

名稱	類型	Description
nextLink	string	要擷取下一頁的 URI。
value	SecuritySubAssessment[]	資源的安全性子評量

ServerVulnerabilityProperties

伺服器弱點評估的其他內容欄位

名稱	類型	Description
assessedResourceType	string: ServerVulnerabilityAssessment	子評量資源類型
cve	CVE[]	CVE 清單
cvss	<string,  CVSS>	從 cvss 版本到 cvss 詳細數據的字典物件
patchable	boolean	指出是否有可用的修補程式
publishedTime	string	發佈時間
threat	string	威脅名稱
type	string	弱點類型。 例如：弱點、潛在弱點、收集到的資訊
vendorReferences	VendorReference[]	廠商參考

severity

子評量嚴重性層級

名稱	類型	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

已評估之資源的詳細數據

名稱	類型	Description
assessedResourceType	string: SqlServerVulnerability	子評量資源類型
query	string	在 SQL 資料庫上執行的 T-SQL 查詢，以執行特定檢查
type	string	子評量的資源類型在其資源詳細數據中參考

SubAssessmentStatus

子評量的狀態

名稱	類型	Description
cause	string	評估狀態原因的程序代碼
code	SubAssessmentStatusCode	評估狀態的程序代碼
description	string	評估狀態的人類可讀描述
severity	severity	子評量嚴重性層級

SubAssessmentStatusCode

評估狀態的程序代碼

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

VendorReference

廠商參考

名稱	類型	Description
link	string	連結 URL
title	string	連結標題