Sub Assessments - List

Servicio:

Defender for Cloud

Versión de la API:

2019-01-01-preview

Obtención de subevaluaciones de seguridad en todos los recursos examinados dentro de un ámbito

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
assessmentName	path	True	string	Clave de evaluación: clave única para el tipo de evaluación
scope	path	True	string	El ámbito de la consulta puede ser suscripción (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) o grupo de administración (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Versión de API para la operación

Respuestas

Nombre	Tipo	Description
200 OK	SecuritySubAssessmentList	Aceptar
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

List security sub-assessments

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
AzureResourceDetails	Detalles del recurso de Azure que se evaluó
CloudError	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
CloudErrorBody	Detalle del error.
ContainerRegistryVulnerabilityProperties	Campos de contexto adicionales para la evaluación de vulnerabilidades del registro de contenedor
CVE	Detalles de CVE
CVSS	Detalles de CVSS
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
OnPremiseResourceDetails	Detalles del recurso local que se evaluó
OnPremiseSqlResourceDetails	Detalles del recurso de Sql local que se evaluó
SecuritySubAssessment	Subavaluación de seguridad en un recurso
SecuritySubAssessmentList	Lista de subevaluaciones de seguridad
ServerVulnerabilityProperties	Campos de contexto adicionales para la evaluación de vulnerabilidades del servidor
severity	Nivel de gravedad de la subavaluación
SqlServerVulnerabilityProperties	Detalles del recurso que se evaluó
SubAssessmentStatus	Estado de la subavaluación
SubAssessmentStatusCode	Código mediante programación para el estado de la evaluación
VendorReference	Referencia del proveedor

AzureResourceDetails

Detalles del recurso de Azure que se evaluó

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure del recurso evaluado
source	string: Azure	Plataforma en la que reside el recurso evaluado

CloudError

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
error.code	string	Código de error.
error.details	CloudErrorBody[]	Los detalles del error.
error.message	string	El mensaje de error.
error.target	string	Destino del error.

CloudErrorBody

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CloudErrorBody[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ContainerRegistryVulnerabilityProperties

Campos de contexto adicionales para la evaluación de vulnerabilidades del registro de contenedor

Nombre	Tipo	Description
assessedResourceType	string: ContainerRegistryVulnerability	Tipo de recurso de subavaluación
cve	CVE[]	Lista de CV
cvss	<string,  CVSS>	Diccionario de la versión de CVSS al objeto de detalles CVSS
imageDigest	string	Resumen de la imagen vulnerable
patchable	boolean	Indica si una revisión está disponible o no.
publishedTime	string	Hora de publicación
repositoryName	string	Nombre del repositorio al que pertenece la imagen vulnerable
type	string	Tipo de vulnerabilidad. Por ejemplo: Vulnerabilidad, posible vulnerabilidad, información recopilada, vulnerabilidad
vendorReferences	VendorReference[]	Referencia del proveedor

CVE

Detalles de CVE

Nombre	Tipo	Description
link	string	Dirección URL del vínculo
title	string	Título de CVE

CVSS

Detalles de CVSS

Nombre	Tipo	Description
base	number	Base de CVSS

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

OnPremiseResourceDetails

Detalles del recurso local que se evaluó

Nombre	Tipo	Description
machineName	string	Nombre de la máquina
source	string: OnPremise	Plataforma en la que reside el recurso evaluado
sourceComputerId	string	El identificador del agente oms instalado en la máquina
vmuuid	string	Identificador único de la máquina
workspaceId	string	Identificador de recurso de Azure del área de trabajo a la que está asociada la máquina

OnPremiseSqlResourceDetails

Detalles del recurso de Sql local que se evaluó

Nombre	Tipo	Description
databaseName	string	El nombre de la base de datos SQL instalado en el equipo
machineName	string	Nombre de la máquina
serverName	string	El nombre del servidor SQL instalado en el equipo
source	string: OnPremiseSql	Plataforma en la que reside el recurso evaluado
sourceComputerId	string	El identificador del agente oms instalado en la máquina
vmuuid	string	Identificador único de la máquina
workspaceId	string	Identificador de recurso de Azure del área de trabajo a la que está asociada la máquina

SecuritySubAssessment

Subavaluación de seguridad en un recurso

Nombre	Tipo	Description
id	string	Id. de recurso
name	string	Nombre del recurso
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Detalles de la subavaluación
properties.category	string	Categoría de la subavaluación
properties.description	string	Descripción legible del estado de evaluación
properties.displayName	string	Nombre para mostrar descriptivo de la subavaluación
properties.id	string	Id. de vulnerabilidad
properties.impact	string	Descripción del impacto de esta subevaluación
properties.remediation	string	Información sobre cómo corregir esta subevaluaciones
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Detalles del recurso que se evaluó
properties.status	SubAssessmentStatus	Estado de la subavaluación
properties.timeGenerated	string	Fecha y hora en que se generó la subavaluación
type	string	Tipo de recurso

SecuritySubAssessmentList

Lista de subevaluaciones de seguridad

Nombre	Tipo	Description
nextLink	string	URI para capturar la página siguiente.
value	SecuritySubAssessment[]	Subavaluación de seguridad en un recurso

ServerVulnerabilityProperties

Campos de contexto adicionales para la evaluación de vulnerabilidades del servidor

Nombre	Tipo	Description
assessedResourceType	string: ServerVulnerabilityAssessment	Tipo de recurso de subavaluación
cve	CVE[]	Lista de CV
cvss	<string,  CVSS>	Diccionario de la versión de CVSS al objeto de detalles CVSS
patchable	boolean	Indica si una revisión está disponible o no.
publishedTime	string	Hora de publicación
threat	string	Nombre de amenaza
type	string	Tipo de vulnerabilidad. Por ejemplo, vulnerabilidad, vulnerabilidad potencial, información recopilada
vendorReferences	VendorReference[]	Referencia del proveedor

severity

Nivel de gravedad de la subavaluación

Nombre	Tipo	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Detalles del recurso que se evaluó

Nombre	Tipo	Description
assessedResourceType	string: SqlServerVulnerability	Tipo de recurso de subavaluación
query	string	Consulta T-SQL que se ejecuta en la base de datos SQL para realizar la comprobación determinada
type	string	El tipo de recurso al que hace referencia la subevaluaciones en sus detalles de recursos.

SubAssessmentStatus

Estado de la subavaluación

Nombre	Tipo	Description
cause	string	Código mediante programación para la causa del estado de evaluación
code	SubAssessmentStatusCode	Código mediante programación para el estado de la evaluación
description	string	Descripción legible del estado de evaluación
severity	severity	Nivel de gravedad de la subavaluación

SubAssessmentStatusCode

Código mediante programación para el estado de la evaluación

Nombre	Tipo	Description
Healthy	string	El recurso está en buen estado
NotApplicable	string	No se ha producido la evaluación de este recurso
Unhealthy	string	El recurso tiene un problema de seguridad que debe solucionarse.

VendorReference

Referencia del proveedor

Nombre	Tipo	Description
link	string	Dirección URL del vínculo
title	string	Título del vínculo