Sub Assessments - List

Service:

Defender for Cloud

API Version:

2019-01-01-preview

Obtenir des sous-évaluations de sécurité sur toutes vos ressources analysées à l’intérieur d’une étendue

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
assessmentName	path	True	string	La clé d’évaluation : clé unique pour le type d’évaluation
scope	path	True	string	L’étendue de la requête peut être un abonnement (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) ou un groupe d’administration (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Version de l’API pour l’opération

Réponses

Nom	Type	Description
200 OK	SecuritySubAssessmentList	Ok
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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/b43974e07d3204c4b6f8396627f5430994a7f7c9/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 subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const assessmentName = "82e20e14-edc5-4373-bfc4-f13121257c37";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  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": []
        }
      }
    }
  ]
}

Définitions

Nom	Description
AzureResourceDetails	Détails de la ressource Azure évaluée
CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
CloudErrorBody	Détail de l’erreur.
ContainerRegistryVulnerabilityProperties	Champs de contexte supplémentaires pour l’évaluation des vulnérabilités du registre de conteneurs
CVE	Détails CVE
CVSS	Détails de CVSS
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
OnPremiseResourceDetails	Détails de la ressource locale évaluée
OnPremiseSqlResourceDetails	Détails de la ressource Sql locale qui a été évaluée
SecuritySubAssessment	Sous-évaluation de la sécurité sur une ressource
SecuritySubAssessmentList	Liste des sous-évaluations de sécurité
ServerVulnerabilityProperties	Champs de contexte supplémentaires pour l’évaluation des vulnérabilités du serveur
severity	Niveau de gravité de la sous-évaluation
SqlServerVulnerabilityProperties	Détails de la ressource évaluée
SubAssessmentStatus	État de la sous-évaluation
SubAssessmentStatusCode	Code programmatique pour le status de l’évaluation
VendorReference	Référence du fournisseur

AzureResourceDetails

Détails de la ressource Azure évaluée

Nom	Type	Description
id	string	ID de ressource Azure de la ressource évaluée
source	string: Azure	Plateforme où réside la ressource évaluée

CloudError

Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Détails de l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible d’erreur.

CloudErrorBody

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	CloudErrorBody[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ContainerRegistryVulnerabilityProperties

Champs de contexte supplémentaires pour l’évaluation des vulnérabilités du registre de conteneurs

Nom	Type	Description
assessedResourceType	string: ContainerRegistryVulnerability	Type de ressource de sous-évaluation
cve	CVE[]	Liste des CVC
cvss	<string,  CVSS>	Dictionnaire de la version de cvss à l’objet détails de cvss
imageDigest	string	Synthèse de l’image vulnérable
patchable	boolean	Indique si un correctif est disponible ou non
publishedTime	string	Heure de publication
repositoryName	string	Nom du dépôt auquel appartient l’image vulnérable
type	string	Type de vulnérabilité. par exemple : Vulnérabilité, Vulnérabilité potentielle, Informations collectées, Vulnérabilité
vendorReferences	VendorReference[]	Référence du fournisseur

CVE

Détails CVE

Nom	Type	Description
link	string	URL du lien
title	string	Titre CVE

CVSS

Détails de CVSS

Nom	Type	Description
base	number	Base CVSS

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

OnPremiseResourceDetails

Détails de la ressource locale évaluée

Nom	Type	Description
machineName	string	Nom de la machine
source	string: OnPremise	Plateforme où réside la ressource évaluée
sourceComputerId	string	ID de l’agent OMS installé sur l’ordinateur
vmuuid	string	ID unique de la machine
workspaceId	string	ID de ressource Azure de l’espace de travail auquel la machine est attachée

OnPremiseSqlResourceDetails

Détails de la ressource Sql locale qui a été évaluée

Nom	Type	Description
databaseName	string	Nom de la base de données Sql installée sur l’ordinateur
machineName	string	Nom de la machine
serverName	string	Nom du serveur Sql installé sur l’ordinateur
source	string: OnPremiseSql	Plateforme où réside la ressource évaluée
sourceComputerId	string	ID de l’agent OMS installé sur l’ordinateur
vmuuid	string	ID unique de la machine
workspaceId	string	ID de ressource Azure de l’espace de travail auquel la machine est attachée

SecuritySubAssessment

Sous-évaluation de la sécurité sur une ressource

Nom	Type	Description
id	string	ID de ressource
name	string	Nom de la ressource
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Détails de la sous-évaluation
properties.category	string	Catégorie de la sous-évaluation
properties.description	string	Description lisible par l’homme de l’état d’évaluation
properties.displayName	string	Nom d’affichage convivial de la sous-évaluation
properties.id	string	ID de vulnérabilité
properties.impact	string	Description de l’impact de cette sous-évaluation
properties.remediation	string	Informations sur la façon de corriger cette sous-évaluation
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Détails de la ressource évaluée
properties.status	SubAssessmentStatus	État de la sous-évaluation
properties.timeGenerated	string	Date et heure de génération de la sous-évaluation
type	string	Type de ressource

SecuritySubAssessmentList

Liste des sous-évaluations de sécurité

Nom	Type	Description
nextLink	string	URI pour extraire la page suivante.
value	SecuritySubAssessment[]	Sous-évaluation de la sécurité sur une ressource

ServerVulnerabilityProperties

Champs de contexte supplémentaires pour l’évaluation des vulnérabilités du serveur

Nom	Type	Description
assessedResourceType	string: ServerVulnerabilityAssessment	Type de ressource de sous-évaluation
cve	CVE[]	Liste des CVC
cvss	<string,  CVSS>	Dictionnaire de la version de cvss à l’objet détails de cvss
patchable	boolean	Indique si un correctif est disponible ou non
publishedTime	string	Heure de publication
threat	string	Nom de la menace
type	string	Type de vulnérabilité. par exemple : vulnérabilité, vulnérabilité potentielle, informations collectées
vendorReferences	VendorReference[]	Référence du fournisseur

severity

Niveau de gravité de la sous-évaluation

Nom	Type	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Détails de la ressource évaluée

Nom	Type	Description
assessedResourceType	string: SqlServerVulnerability	Type de ressource de sous-évaluation
query	string	Requête T-SQL qui s’exécute sur votre base de données SQL pour effectuer le case activée particulier
type	string	Type de ressource auquel la sous-évaluation fait référence dans ses détails de ressource

SubAssessmentStatus

État de la sous-évaluation

Nom	Type	Description
cause	string	Code programmatique pour la cause de l’évaluation status
code	SubAssessmentStatusCode	Code programmatique pour le status de l’évaluation
description	string	Description lisible par l’homme de l’état d’évaluation
severity	severity	Niveau de gravité de la sous-évaluation

SubAssessmentStatusCode

Code programmatique pour le status de l’évaluation

Nom	Type	Description
Healthy	string	La ressource est saine
NotApplicable	string	L’évaluation de cette ressource n’a pas eu lieu
Unhealthy	string	La ressource présente un problème de sécurité qui doit être résolu

VendorReference

Référence du fournisseur

Nom	Type	Description
link	string	URL du lien
title	string	Titre du lien