Sub Assessments - List

Service:

Defender for Cloud

API Version:

2019-01-01-preview

Hämta säkerhetsunderutvärderingar för alla genomsökda resurser i ett omfång

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
assessmentName	path	True	string	Utvärderingsnyckeln – unik nyckel för utvärderingstypen
scope	path	True	string	Frågans omfattning kan vara prenumeration (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) eller hanteringsgrupp (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	API-version för åtgärden

Svar

Name	Typ	Description
200 OK	SecuritySubAssessmentList	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
AzureResourceDetails	Information om Azure-resursen som utvärderades
CloudError	Vanliga felsvar för alla Azure Resource Manager API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).
CloudErrorBody	Felinformationen.
ContainerRegistryVulnerabilityProperties	Ytterligare kontextfält för sårbarhetsbedömning av containerregister
CVE	CVE-information
CVSS	CVSS-information
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
OnPremiseResourceDetails	Information om den lokala resurs som utvärderades
OnPremiseSqlResourceDetails	Information om den lokala Sql-resursen som utvärderades
SecuritySubAssessment	Underutvärdering av säkerhet för en resurs
SecuritySubAssessmentList	Lista över säkerhetsunderutvärderingar
ServerVulnerabilityProperties	Ytterligare kontextfält för utvärdering av serversårbarhet
severity	Allvarlighetsgrad för underutvärdering
SqlServerVulnerabilityProperties	Information om resursen som utvärderades
SubAssessmentStatus	Status för underutvärderingen
SubAssessmentStatusCode	Programmatisk kod för utvärderingens status
VendorReference	Leverantörsreferens

AzureResourceDetails

Information om Azure-resursen som utvärderades

Name	Typ	Description
id	string	Azure-resurs-ID för den utvärderade resursen
source	string: Azure	Plattformen där den utvärderade resursen finns

CloudError

Vanliga felsvar för alla Azure Resource Manager API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ContainerRegistryVulnerabilityProperties

Ytterligare kontextfält för sårbarhetsbedömning av containerregister

Name	Typ	Description
assessedResourceType	string: ContainerRegistryVulnerability	Resurstyp för underutvärdering
cve	CVE[]	Lista över CVE:er
cvss	<string,  CVSS>	Ordlista från cvss-version till cvss-informationsobjekt
imageDigest	string	Sammandrag av den sårbara bilden
patchable	boolean	Anger om en korrigering är tillgänglig eller inte
publishedTime	string	Publicerad tid
repositoryName	string	Namnet på den lagringsplats som den sårbara avbildningen tillhör
type	string	Sårbarhetstyp. t.ex. sårbarhet, potentiell sårbarhet, information som samlas in, sårbarhet
vendorReferences	VendorReference[]	Leverantörsreferens

CVE

CVE-information

Name	Typ	Description
link	string	Länk-URL
title	string	CVE-titel

CVSS

CVSS-information

Name	Typ	Description
base	number	CVSS-bas

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

OnPremiseResourceDetails

Information om den lokala resurs som utvärderades

Name	Typ	Description
machineName	string	Namnet på datorn
source	string: OnPremise	Plattformen där den utvärderade resursen finns
sourceComputerId	string	Oms-agent-ID:t som är installerat på datorn
vmuuid	string	Datorns unika ID
workspaceId	string	Azure-resurs-ID för arbetsytan som datorn är ansluten till

OnPremiseSqlResourceDetails

Information om den lokala Sql-resursen som utvärderades

Name	Typ	Description
databaseName	string	Sql-databasnamnet som är installerat på datorn
machineName	string	Namnet på datorn
serverName	string	Sql Server-namnet installerat på datorn
source	string: OnPremiseSql	Plattformen där den utvärderade resursen finns
sourceComputerId	string	Oms-agent-ID:t som är installerat på datorn
vmuuid	string	Datorns unika ID
workspaceId	string	Azure-resurs-ID för arbetsytan som datorn är ansluten till

SecuritySubAssessment

Underutvärdering av säkerhet för en resurs

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Information om underutvärderingen
properties.category	string	Kategori för underutvärderingen
properties.description	string	Mänsklig läsbar beskrivning av utvärderingsstatusen
properties.displayName	string	Användarvänligt visningsnamn för underutvärderingen
properties.id	string	Sårbarhets-ID
properties.impact	string	Beskrivning av effekten av den här underutvärderingen
properties.remediation	string	Information om hur du åtgärdar den här underutvärderingen
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Information om resursen som utvärderades
properties.status	SubAssessmentStatus	Status för underutvärderingen
properties.timeGenerated	string	Datum och tid då underutvärderingen genererades
type	string	Resurstyp

SecuritySubAssessmentList

Lista över säkerhetsunderutvärderingar

Name	Typ	Description
nextLink	string	URI:n för att hämta nästa sida.
value	SecuritySubAssessment[]	Underutvärdering av säkerhet för en resurs

ServerVulnerabilityProperties

Ytterligare kontextfält för utvärdering av serversårbarhet

Name	Typ	Description
assessedResourceType	string: ServerVulnerabilityAssessment	Resurstyp för underutvärdering
cve	CVE[]	Lista över CVE:er
cvss	<string,  CVSS>	Ordlista från cvss-version till cvss-informationsobjekt
patchable	boolean	Anger om en korrigering är tillgänglig eller inte
publishedTime	string	Publicerad tid
threat	string	Hotnamn
type	string	Sårbarhetstyp. t.ex. sårbarhet, potentiell sårbarhet, information som samlas in
vendorReferences	VendorReference[]	Leverantörsreferens

severity

Allvarlighetsgrad för underutvärdering

Name	Typ	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Information om resursen som utvärderades

Name	Typ	Description
assessedResourceType	string: SqlServerVulnerability	Resurstyp för underutvärdering
query	string	T-SQL-frågan som körs på din SQL-databas för att utföra den specifika kontrollen
type	string	Resurstypen som underutvärderingen refererar till i resursinformationen

SubAssessmentStatus

Status för underutvärderingen

Name	Typ	Description
cause	string	Programmatisk kod för orsaken till utvärderingsstatusen
code	SubAssessmentStatusCode	Programmatisk kod för utvärderingens status
description	string	Mänsklig läsbar beskrivning av utvärderingsstatusen
severity	severity	Allvarlighetsgrad för underutvärdering

SubAssessmentStatusCode

Programmatisk kod för utvärderingens status

Name	Typ	Description
Healthy	string	Resursen är felfri
NotApplicable	string	Utvärdering för den här resursen har inte inträffar
Unhealthy	string	Resursen har ett säkerhetsproblem som måste åtgärdas

VendorReference

Leverantörsreferens

Name	Typ	Description
link	string	Länk-URL
title	string	Länkrubrik