Sub Assessments - List

Service:

Defender for Cloud

API Version:

2019-01-01-preview

Pobieranie ocen podrzędnych zabezpieczeń na wszystkich zeskanowanych zasobach w zakresie

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
assessmentName	path	True	string	Klucz oceny — unikatowy klucz dla typu oceny
scope	path	True	string	Zakres zapytania może być subskrypcją (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) lub grupą zarządzania (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Wersja interfejsu API dla operacji

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SecuritySubAssessmentList	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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": []
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
AzureResourceDetails	Szczegóły zasobu platformy Azure, który został oceniony
CloudError	Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).
CloudErrorBody	Szczegóły błędu.
ContainerRegistryVulnerabilityProperties	Dodatkowe pola kontekstowe dla oceny luk w zabezpieczeniach rejestru kontenerów
CVE	Szczegóły CVE
CVSS	Szczegóły CVSS
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
OnPremiseResourceDetails	Szczegóły zasobu lokalnego, który został oceniony
OnPremiseSqlResourceDetails	Szczegóły zasobu Lokalnego sql, który został oceniony
SecuritySubAssessment	Ocena podrzędna zabezpieczeń zasobu
SecuritySubAssessmentList	Lista ocen podrzędnych zabezpieczeń
ServerVulnerabilityProperties	Dodatkowe pola kontekstowe do oceny luk w zabezpieczeniach serwera
severity	Poziom ważności oceny podrzędnej
SqlServerVulnerabilityProperties	Szczegóły zasobu, który został oceniony
SubAssessmentStatus	Stan oceny podrzędnej
SubAssessmentStatusCode	Kod programowy stanu oceny
VendorReference	Dokumentacja dostawcy

AzureResourceDetails

Szczegóły zasobu platformy Azure, który został oceniony

Nazwa	Typ	Opis
id	string	Identyfikator zasobu platformy Azure dla ocenianego zasobu
source	string: Azure	Platforma, na której znajduje się oceniony zasób

CloudError

Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ContainerRegistryVulnerabilityProperties

Dodatkowe pola kontekstowe dla oceny luk w zabezpieczeniach rejestru kontenerów

Nazwa	Typ	Opis
assessedResourceType	string: ContainerRegistryVulnerability	Typ zasobu oceny podrzędnej
cve	CVE[]	Lista CVE
cvss	<string,  CVSS>	Słownik z wersji cvss do obiektu szczegółów cvss
imageDigest	string	Skrót obrazu podatnego na zagrożenia
patchable	boolean	Wskazuje, czy poprawka jest dostępna, czy nie
publishedTime	string	Czas publikacji
repositoryName	string	Nazwa repozytorium, do którego należy obraz podatny na zagrożenia
type	string	Typ luki w zabezpieczeniach. np. Luka w zabezpieczeniach, potencjalna luka w zabezpieczeniach, zebrane informacje, luka w zabezpieczeniach
vendorReferences	VendorReference[]	Dokumentacja dostawcy

CVE

Szczegóły CVE

Nazwa	Typ	Opis
link	string	Adres URL łącza
title	string	Tytuł CVE

CVSS

Szczegóły CVSS

Nazwa	Typ	Opis
base	number	Baza CVSS

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

OnPremiseResourceDetails

Szczegóły zasobu lokalnego, który został oceniony

Nazwa	Typ	Opis
machineName	string	Nazwa maszyny
source	string: OnPremise	Platforma, na której znajduje się oceniony zasób
sourceComputerId	string	Identyfikator agenta pakietu oms zainstalowany na maszynie
vmuuid	string	Unikatowy identyfikator maszyny
workspaceId	string	Identyfikator zasobu platformy Azure obszaru roboczego, do których jest dołączona maszyna

OnPremiseSqlResourceDetails

Szczegóły zasobu Lokalnego sql, który został oceniony

Nazwa	Typ	Opis
databaseName	string	Nazwa bazy danych Sql zainstalowana na maszynie
machineName	string	Nazwa maszyny
serverName	string	Nazwa serwera SQL zainstalowana na maszynie
source	string: OnPremiseSql	Platforma, na której znajduje się oceniony zasób
sourceComputerId	string	Identyfikator agenta pakietu oms zainstalowany na maszynie
vmuuid	string	Unikatowy identyfikator maszyny
workspaceId	string	Identyfikator zasobu platformy Azure obszaru roboczego, do których jest dołączona maszyna

SecuritySubAssessment

Ocena podrzędna zabezpieczeń zasobu

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa zasobu
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Szczegóły oceny podrzędnej
properties.category	string	Kategoria podsieci oceny
properties.description	string	Czytelny opis stanu oceny przez człowieka
properties.displayName	string	Przyjazna dla użytkownika nazwa wyświetlana oceny podrzędnej
properties.id	string	Identyfikator luki w zabezpieczeniach
properties.impact	string	Opis wpływu tej oceny podrzędnej
properties.remediation	string	Informacje na temat korygowania tej oceny podrzędnej
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Szczegóły zasobu, który został oceniony
properties.status	SubAssessmentStatus	Stan oceny podrzędnej
properties.timeGenerated	string	Data i godzina wygenerowania oceny podrzędnej
type	string	Typ zasobu

SecuritySubAssessmentList

Lista ocen podrzędnych zabezpieczeń

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony.
value	SecuritySubAssessment[]	Ocena podrzędna zabezpieczeń zasobu

ServerVulnerabilityProperties

Dodatkowe pola kontekstowe do oceny luk w zabezpieczeniach serwera

Nazwa	Typ	Opis
assessedResourceType	string: ServerVulnerabilityAssessment	Typ zasobu oceny podrzędnej
cve	CVE[]	Lista CVE
cvss	<string,  CVSS>	Słownik z wersji cvss do obiektu szczegółów cvss
patchable	boolean	Wskazuje, czy poprawka jest dostępna, czy nie
publishedTime	string	Czas publikacji
threat	string	Nazwa zagrożenia
type	string	Typ luki w zabezpieczeniach. np. Luka w zabezpieczeniach, potencjalna luka w zabezpieczeniach, zebrane informacje
vendorReferences	VendorReference[]	Dokumentacja dostawcy

severity

Poziom ważności oceny podrzędnej

Nazwa	Typ	Opis
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Szczegóły zasobu, który został oceniony

Nazwa	Typ	Opis
assessedResourceType	string: SqlServerVulnerability	Typ zasobu oceny podrzędnej
query	string	Zapytanie T-SQL uruchamiane w bazie danych SQL w celu wykonania określonego sprawdzenia
type	string	Typ zasobu, do których odnosi się ocena podrzędna, w szczegółach zasobu

SubAssessmentStatus

Stan oceny podrzędnej

Nazwa	Typ	Opis
cause	string	Kod programowy przyczyny stanu oceny
code	SubAssessmentStatusCode	Kod programowy stanu oceny
description	string	Czytelny opis stanu oceny przez człowieka
severity	severity	Poziom ważności oceny podrzędnej

SubAssessmentStatusCode

Kod programowy stanu oceny

Nazwa	Typ	Opis
Healthy	string	Zasób jest w dobrej kondycji
NotApplicable	string	Ocena tego zasobu nie miała miejsca
Unhealthy	string	Zasób ma problem z zabezpieczeniami, który należy rozwiązać

VendorReference

Dokumentacja dostawcy

Nazwa	Typ	Opis
link	string	Adres URL łącza
title	string	Tytuł łącza