Sub Assessments - List

Dienst:

Defender for Cloud

API-Version:

2019-01-01-preview

Abrufen von Sicherheitsunterbewertungen für alle gescannten Ressourcen innerhalb eines Bereichs

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
assessmentName	path	True	string	Der Bewertungsschlüssel – Eindeutiger Schlüssel für den Bewertungstyp
scope	path	True	string	Der Umfang der Abfrage kann abonnement (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) oder Verwaltungsgruppe (/providers/Microsoft.Management/managementGroups/mgName) sein.
api-version	query	True	string	API-Version für den Vorgang

Antworten

Name	Typ	Beschreibung
200 OK	SecuritySubAssessmentList	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List security sub-assessments

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AzureResourceDetails	Details der Azure-Ressource, die bewertet wurde
CloudError	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
CloudErrorBody	Das Fehlerdetails.
ContainerRegistryVulnerabilityProperties	Zusätzliche Kontextfelder für die Bewertung von Sicherheitsrisiken in der Containerregistrierung
CVE	CVE-Details
CVSS	CVSS-Details
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
OnPremiseResourceDetails	Details der lokalen Ressource, die bewertet wurde
OnPremiseSqlResourceDetails	Details der lokalen Sql-Ressource, die bewertet wurde
SecuritySubAssessment	Sicherheitsunterbewertung für eine Ressource
SecuritySubAssessmentList	Liste der Sicherheitsunterbewertungen
ServerVulnerabilityProperties	Zusätzliche Kontextfelder für die Serverrisikobewertung
severity	Schweregrad der Unterbewertung
SqlServerVulnerabilityProperties	Details der Ressource, die bewertet wurde
SubAssessmentStatus	Status der Unterbewertung
SubAssessmentStatusCode	Programmgesteuerter Code für den Status der Bewertung
VendorReference	Lieferantenreferenz

AzureResourceDetails

Details der Azure-Ressource, die bewertet wurde

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID der bewerteten Ressource
source	string: Azure	Die Plattform, auf der sich die bewertete Ressource befindet

CloudError

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error.additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Die Fehlerdetails.
error.message	string	Die Fehlermeldung.
error.target	string	Das Fehlerziel.

CloudErrorBody

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	CloudErrorBody[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ContainerRegistryVulnerabilityProperties

Zusätzliche Kontextfelder für die Bewertung von Sicherheitsrisiken in der Containerregistrierung

Name	Typ	Beschreibung
assessedResourceType	string: ContainerRegistryVulnerability	Ressourcentyp der Unterbewertung
cve	CVE[]	Liste der CVEs
cvss	<string,  CVSS>	Wörterbuch aus cvss-Version zu cvss details-Objekt
imageDigest	string	Digest des anfälligen Bilds
patchable	boolean	Gibt an, ob ein Patch verfügbar ist oder nicht.
publishedTime	string	Veröffentlichungszeit
repositoryName	string	Name des Repositorys, zu dem das anfällige Bild gehört
type	string	Sicherheitsrisikotyp. z. B. Sicherheitsanfälligkeit, potenzielle Sicherheitsanfälligkeit, gesammelte Informationen, Sicherheitsanfälligkeit
vendorReferences	VendorReference[]	Lieferantenreferenz

CVE

CVE-Details

Name	Typ	Beschreibung
link	string	Link-URL
title	string	CVE-Titel

CVSS

CVSS-Details

Name	Typ	Beschreibung
base	number	CVSS-Basis

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

OnPremiseResourceDetails

Details der lokalen Ressource, die bewertet wurde

Name	Typ	Beschreibung
machineName	string	Der Name des Computers
source	string: OnPremise	Die Plattform, auf der sich die bewertete Ressource befindet
sourceComputerId	string	Die oms-Agent-ID, die auf dem Computer installiert ist
vmuuid	string	Die eindeutige ID des Computers
workspaceId	string	Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist

OnPremiseSqlResourceDetails

Details der lokalen Sql-Ressource, die bewertet wurde

Name	Typ	Beschreibung
databaseName	string	Der sql-Datenbankname, der auf dem Computer installiert ist
machineName	string	Der Name des Computers
serverName	string	Der auf dem Computer installierte Sql Server-Name
source	string: OnPremiseSql	Die Plattform, auf der sich die bewertete Ressource befindet
sourceComputerId	string	Die oms-Agent-ID, die auf dem Computer installiert ist
vmuuid	string	Die eindeutige ID des Computers
workspaceId	string	Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist

SecuritySubAssessment

Sicherheitsunterbewertung für eine Ressource

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Ressourcenname
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Details zur Unterbewertung
properties.category	string	Kategorie der Unterbewertung
properties.description	string	Lesbare Beschreibung des Bewertungsstatus
properties.displayName	string	Benutzerfreundlicher Anzeigename der Unterbewertung
properties.id	string	Sicherheitsrisiko-ID
properties.impact	string	Beschreibung der Auswirkungen dieser Unterbewertung
properties.remediation	string	Informationen zur Behebung dieser Unterbewertung
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Details der Ressource, die bewertet wurde
properties.status	SubAssessmentStatus	Status der Unterbewertung
properties.timeGenerated	string	Datum und Uhrzeit der Unterbewertung
type	string	Ressourcentyp

SecuritySubAssessmentList

Liste der Sicherheitsunterbewertungen

Name	Typ	Beschreibung
nextLink	string	Der URI zum Abrufen der nächsten Seite.
value	SecuritySubAssessment[]	Sicherheitsunterbewertung für eine Ressource

ServerVulnerabilityProperties

Zusätzliche Kontextfelder für die Serverrisikobewertung

Name	Typ	Beschreibung
assessedResourceType	string: ServerVulnerabilityAssessment	Ressourcentyp der Unterbewertung
cve	CVE[]	Liste der CVEs
cvss	<string,  CVSS>	Wörterbuch aus cvss-Version zu cvss details-Objekt
patchable	boolean	Gibt an, ob ein Patch verfügbar ist oder nicht.
publishedTime	string	Veröffentlichungszeit
threat	string	Bedrohungsname
type	string	Sicherheitsrisikotyp. z. B. Sicherheitsanfälligkeit, potenzielle Sicherheitsanfälligkeit, gesammelte Informationen
vendorReferences	VendorReference[]	Lieferantenreferenz

severity

Schweregrad der Unterbewertung

Name	Typ	Beschreibung
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Details der Ressource, die bewertet wurde

Name	Typ	Beschreibung
assessedResourceType	string: SqlServerVulnerability	Ressourcentyp der Unterbewertung
query	string	Die T-SQL-Abfrage, die in Ihrer SQL-Datenbank ausgeführt wird, um die jeweilige Überprüfung durchzuführen
type	string	Der Ressourcentyp, auf den sich die Unterbewertung in seinen Ressourcendetails bezieht

SubAssessmentStatus

Status der Unterbewertung

Name	Typ	Beschreibung
cause	string	Programmgesteuerter Code für die Ursache des Bewertungsstatus
code	SubAssessmentStatusCode	Programmgesteuerter Code für den Status der Bewertung
description	string	Lesbare Beschreibung des Bewertungsstatus
severity	severity	Schweregrad der Unterbewertung

SubAssessmentStatusCode

Programmgesteuerter Code für den Status der Bewertung

Name	Typ	Beschreibung
Healthy	string	Die Ressource ist fehlerfrei.
NotApplicable	string	Die Bewertung für diese Ressource ist nicht aufgetreten.
Unhealthy	string	Die Ressource weist ein Sicherheitsproblem auf, das behoben werden muss

VendorReference

Lieferantenreferenz

Name	Typ	Beschreibung
link	string	Link-URL
title	string	Linktitel