Sub Assessments - List

Ссылка

Служба:: Defender for Cloud

Версия API:: 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	ХОРОШО
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List security sub-assessments

Образец запроса

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


/**
 * 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

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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

Пример ответа

Код состояния:: 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	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
CloudErrorBody	Сведения об ошибке.
ContainerRegistryVulnerabilityProperties	Дополнительные поля контекста для оценки уязвимостей реестра контейнеров
CVE	Сведения о CVE
CVSS	Сведения о CVSS
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
OnPremiseResourceDetails	Сведения о локальном ресурсе, который был оценен
OnPremiseSqlResourceDetails	Сведения о ресурсе Локального SQL, который был оценен
SecuritySubAssessment	Подоценка безопасности для ресурса
SecuritySubAssessmentList	Список подоценок безопасности
ServerVulnerabilityProperties	Дополнительные поля контекста для оценки уязвимостей сервера
severity	Уровень серьезности субоценки
SqlServerVulnerabilityProperties	Сведения о ресурсе, который был оценен
SubAssessmentStatus	Состояние подоценки
SubAssessmentStatusCode	Программный код для состояния оценки
VendorReference	Справочник по поставщику

AzureResourceDetails

Object

Сведения о ресурсе Azure, который был оценен

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure для оцененного ресурса
source	string: Azure	Платформа, на которой находится оцененный ресурс

CloudError

Object

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ContainerRegistryVulnerabilityProperties

Object

Дополнительные поля контекста для оценки уязвимостей реестра контейнеров

Имя	Тип	Описание
assessedResourceType	string: ContainerRegistryVulnerability	Тип ресурса подоценки
cve	CVE[]	Список CVEs
cvss	<string, CVSS>	Словарь из версии cvss в объект сведений cvss
imageDigest	string	Дайджест уязвимого образа
patchable	boolean	Указывает, доступен ли исправление или нет
publishedTime	string (date-time)	Время публикации
repositoryName	string	Имя репозитория, к которому принадлежит уязвимый образ
type	string	Тип уязвимости. Например, уязвимость, потенциальная уязвимость, собранная информация, уязвимость
vendorReferences	VendorReference[]	Справочник по поставщику

CVE

Object

Сведения о CVE

Имя	Тип	Описание
link	string	URL-адрес ссылки
title	string	Заголовок CVE

CVSS

Object

Сведения о CVSS

Имя	Тип	Описание
base	number	База CVSS

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

OnPremiseResourceDetails

Object

Сведения о локальном ресурсе, который был оценен

Имя	Тип	Описание
machineName	string	Имя компьютера
source	string: OnPremise	Платформа, на которой находится оцененный ресурс
sourceComputerId	string	Идентификатор агента oms, установленный на компьютере
vmuuid	string	Уникальный идентификатор компьютера
workspaceId	string	Идентификатор ресурса Azure рабочей области, к которому подключен компьютер

OnPremiseSqlResourceDetails

Object

Сведения о ресурсе Локального SQL, который был оценен

Имя	Тип	Описание
databaseName	string	Имя базы данных Sql, установленное на компьютере
machineName	string	Имя компьютера
serverName	string	Имя sql server, установленное на компьютере
source	string: OnPremiseSql	Платформа, на которой находится оцененный ресурс
sourceComputerId	string	Идентификатор агента oms, установленный на компьютере
vmuuid	string	Уникальный идентификатор компьютера
workspaceId	string	Идентификатор ресурса Azure рабочей области, к которому подключен компьютер

SecuritySubAssessment

Object

Подоценка безопасности для ресурса

Имя	Тип	Описание
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 (date-time)	Дата и время создания подоценки
type	string	Тип ресурса

SecuritySubAssessmentList

Object

Список подоценок безопасности

Имя	Тип	Описание
nextLink	string	URI для получения следующей страницы.
value	SecuritySubAssessment[]	Подоценка безопасности для ресурса

ServerVulnerabilityProperties

Object

Дополнительные поля контекста для оценки уязвимостей сервера

Имя	Тип	Описание
assessedResourceType	string: ServerVulnerabilityAssessment	Тип ресурса подоценки
cve	CVE[]	Список CVEs
cvss	<string, CVSS>	Словарь из версии cvss в объект сведений cvss
patchable	boolean	Указывает, доступен ли исправление или нет
publishedTime	string (date-time)	Время публикации
threat	string	Имя угрозы
type	string	Тип уязвимости. например: уязвимость, потенциальная уязвимость, собранная информация
vendorReferences	VendorReference[]	Справочник по поставщику

severity

Перечисление

Уровень серьезности субоценки

Значение	Описание
High
Low
Medium

SqlServerVulnerabilityProperties

Object

Сведения о ресурсе, который был оценен

Имя	Тип	Описание
assessedResourceType	string: SqlServerVulnerability	Тип ресурса подоценки
query	string	Запрос T-SQL, который выполняется в базе данных SQL для выполнения конкретной проверки
type	string	Тип ресурса, на который ссылается подоценка, ссылается на сведения о ресурсе.

SubAssessmentStatus

Object

Состояние подоценки

Имя	Тип	Описание
cause	string	Программный код для причины состояния оценки
code	SubAssessmentStatusCode	Программный код для состояния оценки
description	string	Удобочитаемое описание состояния оценки
severity	severity	Уровень серьезности субоценки

SubAssessmentStatusCode

Перечисление

Программный код для состояния оценки

Значение	Описание
Healthy	Ресурс работоспособный
NotApplicable	Оценка этого ресурса не произошла
Unhealthy	Ресурс имеет проблему безопасности, которую необходимо устранить

VendorReference

Object

Справочник по поставщику

Имя	Тип	Описание
link	string	URL-адрес ссылки
title	string	Заголовок ссылки

Поделиться через

Sub Assessments - List

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

List security sub-assessments

Образец запроса

Пример ответа

Определения

AzureResourceDetails

CloudError

CloudErrorBody

ContainerRegistryVulnerabilityProperties

CVE

CVSS

ErrorAdditionalInfo

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecuritySubAssessment

SecuritySubAssessmentList

ServerVulnerabilityProperties

severity

SqlServerVulnerabilityProperties

SubAssessmentStatus

SubAssessmentStatusCode

VendorReference

Дополнительные ресурсы