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 パラメーター

名前	/	必須	型	説明
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 バージョン

応答

名前	型	説明
200 OK	SecuritySubAssessmentList	OK
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	ユーザー アカウントの借用

例

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/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/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 scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const assessmentName = "82e20e14-edc5-4373-bfc4-f13121257c37";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  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": []
        }
      }
    }
  ]
}

定義

名前	説明
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 リソースの詳細

名前	型	説明
id	string	評価されたリソースの Azure リソース ID
source	string: Azure	評価されたリソースが存在するプラットフォーム

CloudError

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager 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	エラーのターゲット。

ContainerRegistryVulnerabilityProperties

コンテナー レジストリの脆弱性評価の追加のコンテキスト フィールド

名前	型	説明
assessedResourceType	string: ContainerRegistryVulnerability	サブ評価リソースの種類
cve	CVE[]	CVE の一覧
cvss	<string,  CVSS>	cvss バージョンから cvss details オブジェクトへの辞書
imageDigest	string	脆弱なイメージのダイジェスト
patchable	boolean	パッチが使用可能かどうかを示します
publishedTime	string	公開時刻
repositoryName	string	脆弱なイメージが属するリポジトリの名前
type	string	脆弱性の種類。 例: 脆弱性、潜在的な脆弱性、収集された情報、脆弱性
vendorReferences	VendorReference[]	ベンダーリファレンス

CVE

CVE の詳細

名前	型	説明
link	string	リンク URL
title	string	CVE タイトル

CVSS

CVSS の詳細

名前	型	説明
base	number	CVSS ベース

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

OnPremiseResourceDetails

評価されたオンプレミス リソースの詳細

名前	型	説明
machineName	string	マシンの名前
source	string: OnPremise	評価されたリソースが存在するプラットフォーム
sourceComputerId	string	マシンにインストールされている oms エージェント ID
vmuuid	string	マシンの一意の ID
workspaceId	string	マシンがアタッチされているワークスペースの Azure リソース ID

OnPremiseSqlResourceDetails

評価されたオンプレミス Sql リソースの詳細

名前	型	説明
databaseName	string	マシンにインストールされている Sql データベース名
machineName	string	マシンの名前
serverName	string	マシンにインストールされている SQL サーバー名
source	string: OnPremiseSql	評価されたリソースが存在するプラットフォーム
sourceComputerId	string	マシンにインストールされている oms エージェント ID
vmuuid	string	マシンの一意の ID
workspaceId	string	マシンがアタッチされているワークスペースの Azure リソース ID

SecuritySubAssessment

リソースのセキュリティ サブ評価

名前	型	説明
id	string	リソース ID
name	string	リソース名
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	サブ評価の詳細
properties.category	string	サブ評価のカテゴリ
properties.description	string	人間が判読できる評価状態の説明
properties.displayName	string	サブ評価のわかりやすい表示名
properties.id	string	脆弱性 ID
properties.impact	string	このサブ評価の影響の説明
properties.remediation	string	このサブ評価を修復する方法に関する情報
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	評価されたリソースの詳細
properties.status	SubAssessmentStatus	サブ評価の状態
properties.timeGenerated	string	サブ評価が生成された日時
type	string	リソースの種類

SecuritySubAssessmentList

セキュリティ サブ評価の一覧

名前	型	説明
nextLink	string	次のページをフェッチするための URI。
value	SecuritySubAssessment[]	リソースのセキュリティ サブ評価

ServerVulnerabilityProperties

サーバーの脆弱性評価のための追加のコンテキスト フィールド

名前	型	説明
assessedResourceType	string: ServerVulnerabilityAssessment	サブ評価リソースの種類
cve	CVE[]	CVE の一覧
cvss	<string,  CVSS>	cvss バージョンから cvss details オブジェクトへの辞書
patchable	boolean	パッチが使用可能かどうかを示します
publishedTime	string	公開時刻
threat	string	脅威名
type	string	脆弱性の種類。 例: 脆弱性、潜在的な脆弱性、収集された情報
vendorReferences	VendorReference[]	ベンダーリファレンス

severity

サブ評価の重大度レベル

名前	型	説明
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

評価されたリソースの詳細

名前	型	説明
assessedResourceType	string: SqlServerVulnerability	サブ評価リソースの種類
query	string	特定のチェックを実行するために SQL データベースで実行される T-SQL クエリ
type	string	サブ評価がリソースの詳細で参照するリソースの種類

SubAssessmentStatus

サブ評価の状態

名前	型	説明
cause	string	評価状態の原因のプログラム コード
code	SubAssessmentStatusCode	評価の状態のプログラム コード
description	string	人間が判読できる評価状態の説明
severity	severity	サブ評価の重大度レベル

SubAssessmentStatusCode

評価の状態のプログラム コード

名前	型	説明
Healthy	string	リソースが正常である
NotApplicable	string	このリソースの評価が行われませんでした
Unhealthy	string	リソースに対処する必要があるセキュリティの問題がある

VendorReference

ベンダーリファレンス

名前	型	説明
link	string	リンク URL
title	string	リンク タイトル