Sub Assessments - List

Služba:

Defender for Cloud

Verze rozhraní API:

2019-01-01-preview

Získání dílčích posouzení zabezpečení u všech zkontrolovaných prostředků v rámci oboru

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
assessmentName	path	True	string	Klíč posouzení – jedinečný klíč pro typ posouzení
scope	path	True	string	Rozsahem dotazu může být předplatné (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) nebo skupina pro správu (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Verze rozhraní API pro operaci

Odpovědi

Name	Typ	Description
200 OK	SecuritySubAssessmentList	OK
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

List security sub-assessments

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AzureResourceDetails	Podrobnosti o prostředku Azure, který byl vyhodnocen
CloudError	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
ContainerRegistryVulnerabilityProperties	Další kontextová pole pro posouzení ohrožení zabezpečení registru kontejnerů
CVE	Podrobnosti CVE
CVSS	Podrobnosti CVSS
ErrorAdditionalInfo	Další informace o chybě správy prostředků
OnPremiseResourceDetails	Podrobnosti o místním prostředku, který byl vyhodnocen
OnPremiseSqlResourceDetails	Podrobnosti o místním prostředku SQL, který byl vyhodnocen
SecuritySubAssessment	Dílčí posouzení zabezpečení prostředku
SecuritySubAssessmentList	Seznam dílčích posouzení zabezpečení
ServerVulnerabilityProperties	Další kontextová pole pro posouzení ohrožení zabezpečení serveru
severity	Úroveň závažnosti dílčího posouzení
SqlServerVulnerabilityProperties	Podrobnosti o prostředku, který byl vyhodnocen
SubAssessmentStatus	Stav dílčího posouzení
SubAssessmentStatusCode	Programový kód pro stav posouzení
VendorReference	Referenční informace o dodavateli

AzureResourceDetails

Podrobnosti o prostředku Azure, který byl vyhodnocen

Name	Typ	Description
id	string	ID prostředku Azure pro vyhodnocený prostředek
source	string: Azure	Platforma, ve které se nachází hodnocený prostředek

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
error.code	string	Kód chyby.
error.details	CloudErrorBody[]	Podrobnosti o chybě.
error.message	string	Chybová zpráva.
error.target	string	Cíl chyby.

CloudErrorBody

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	CloudErrorBody[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ContainerRegistryVulnerabilityProperties

Další kontextová pole pro posouzení ohrožení zabezpečení registru kontejnerů

Name	Typ	Description
assessedResourceType	string: ContainerRegistryVulnerability	Typ prostředku dílčího posouzení
cve	CVE[]	Seznam cves
cvss	<string,  CVSS>	Dictionary from cvss version to cvss details object
imageDigest	string	Přehled ohroženého obrázku
patchable	boolean	Určuje, jestli je oprava k dispozici, nebo ne.
publishedTime	string	Čas publikování
repositoryName	string	Název úložiště, do kterého patří zranitelná image
type	string	Typ ohrožení zabezpečení Například: Ohrožení zabezpečení, Potenciální ohrožení zabezpečení, Shromažďované informace, Ohrožení zabezpečení
vendorReferences	VendorReference[]	Referenční informace o dodavateli

CVE

Podrobnosti CVE

Name	Typ	Description
link	string	Adresa URL odkazu
title	string	NÁZEV CVE

CVSS

Podrobnosti CVSS

Name	Typ	Description
base	number	Základ CVSS

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

OnPremiseResourceDetails

Podrobnosti o místním prostředku, který byl vyhodnocen

Name	Typ	Description
machineName	string	Název počítače
source	string: OnPremise	Platforma, ve které se nachází hodnocený prostředek
sourceComputerId	string	ID agenta oms nainstalovaného na počítači
vmuuid	string	Jedinečné ID počítače
workspaceId	string	ID prostředku Azure pracovního prostoru, ke kterému je počítač připojený

OnPremiseSqlResourceDetails

Podrobnosti o místním prostředku SQL, který byl vyhodnocen

Name	Typ	Description
databaseName	string	Název databáze SQL nainstalovaný na počítači
machineName	string	Název počítače
serverName	string	Název sql serveru nainstalovaný na počítači
source	string: OnPremiseSql	Platforma, ve které se nachází hodnocený prostředek
sourceComputerId	string	ID agenta oms nainstalovaného na počítači
vmuuid	string	Jedinečné ID počítače
workspaceId	string	ID prostředku Azure pracovního prostoru, ke kterému je počítač připojený

SecuritySubAssessment

Dílčí posouzení zabezpečení prostředku

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Podrobnosti dílčího posouzení
properties.category	string	Kategorie dílčího posouzení
properties.description	string	Human readable description of the assessment status
properties.displayName	string	Uživatelsky přívětivý zobrazovaný název dílčího posouzení
properties.id	string	ID ohrožení zabezpečení
properties.impact	string	Popis dopadu tohoto dílčího posouzení
properties.remediation	string	Informace o nápravě tohoto dílčího posouzení
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Podrobnosti o prostředku, který byl vyhodnocen
properties.status	SubAssessmentStatus	Stav dílčího posouzení
properties.timeGenerated	string	Datum a čas vygenerování dílčího posouzení
type	string	Typ prostředku

SecuritySubAssessmentList

Seznam dílčích posouzení zabezpečení

Name	Typ	Description
nextLink	string	Identifikátor URI pro načtení další stránky.
value	SecuritySubAssessment[]	Dílčí posouzení zabezpečení prostředku

ServerVulnerabilityProperties

Další kontextová pole pro posouzení ohrožení zabezpečení serveru

Name	Typ	Description
assessedResourceType	string: ServerVulnerabilityAssessment	Typ prostředku dílčího posouzení
cve	CVE[]	Seznam cves
cvss	<string,  CVSS>	Dictionary from cvss version to cvss details object
patchable	boolean	Určuje, jestli je oprava k dispozici, nebo ne.
publishedTime	string	Čas publikování
threat	string	Název hrozby
type	string	Typ ohrožení zabezpečení Např. ohrožení zabezpečení, potenciální ohrožení zabezpečení, shromažďované informace
vendorReferences	VendorReference[]	Referenční informace o dodavateli

severity

Úroveň závažnosti dílčího posouzení

Name	Typ	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Podrobnosti o prostředku, který byl vyhodnocen

Name	Typ	Description
assessedResourceType	string: SqlServerVulnerability	Typ prostředku dílčího posouzení
query	string	Dotaz T-SQL, který běží v databázi SQL, aby provedl konkrétní kontrolu
type	string	Typ prostředku, na který dílčí posouzení odkazuje v podrobnostech o prostředku.

SubAssessmentStatus

Stav dílčího posouzení

Name	Typ	Description
cause	string	Programový kód pro příčinu stavu posouzení
code	SubAssessmentStatusCode	Programový kód pro stav posouzení
description	string	Human readable description of the assessment status
severity	severity	Úroveň závažnosti dílčího posouzení

SubAssessmentStatusCode

Programový kód pro stav posouzení

Name	Typ	Description
Healthy	string	Prostředek je v pořádku.
NotApplicable	string	Posouzení pro tento prostředek se nestalo.
Unhealthy	string	Prostředek má problém se zabezpečením, který je potřeba vyřešit.

VendorReference

Referenční informace o dodavateli

Name	Typ	Description
link	string	Adresa URL odkazu
title	string	Název odkazu