Sub Assessments - List

Service:

Defender for Cloud

API Version:

2019-01-01-preview

Obter subavaliações de segurança em todos os seus recursos verificados dentro de um escopo

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
assessmentName	path	True	string	A chave de avaliação – chave exclusiva para o tipo de avaliação
scope	path	True	string	O escopo da consulta pode ser assinatura (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) ou grupo de gerenciamento (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	Versão da API para a operação

Respostas

Nome	Tipo	Description
200 OK	SecuritySubAssessmentList	OK
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

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

Definições

Nome	Description
AzureResourceDetails	Detalhes do recurso do Azure que foi avaliado
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	Os detalhes do erro.
ContainerRegistryVulnerabilityProperties	Campos de contexto adicionais para avaliação de vulnerabilidade do registro de contêiner
CVE	Detalhes da CVE
CVSS	Detalhes do CVSS
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
OnPremiseResourceDetails	Detalhes do recurso local que foi avaliado
OnPremiseSqlResourceDetails	Detalhes do recurso sql local que foi avaliado
SecuritySubAssessment	Subavaliação de segurança em um recurso
SecuritySubAssessmentList	Lista de subavaliações de segurança
ServerVulnerabilityProperties	Campos de contexto adicionais para avaliação de vulnerabilidade do servidor
severity	O nível de gravidade da subavaliação
SqlServerVulnerabilityProperties	Detalhes do recurso que foi avaliado
SubAssessmentStatus	Status da subavaliação
SubAssessmentStatusCode	Código programático para o status da avaliação
VendorReference	Referência do fornecedor

AzureResourceDetails

Detalhes do recurso do Azure que foi avaliado

Nome	Tipo	Description
id	string	ID de recurso do Azure do recurso avaliado
source	string: Azure	A plataforma em que o recurso avaliado reside

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ContainerRegistryVulnerabilityProperties

Campos de contexto adicionais para avaliação de vulnerabilidade do registro de contêiner

Nome	Tipo	Description
assessedResourceType	string: ContainerRegistryVulnerability	Tipo de recurso de subavaliação
cve	CVE[]	Lista de CVEs
cvss	<string,  CVSS>	Dicionário da versão CVSS para o objeto de detalhes CVSS
imageDigest	string	Resumo da imagem vulnerável
patchable	boolean	Indica se um patch está disponível ou não
publishedTime	string	Hora da publicação
repositoryName	string	Nome do repositório ao qual a imagem vulnerável pertence
type	string	Tipo de vulnerabilidade. por exemplo: vulnerabilidade, vulnerabilidade potencial, informações coletadas, vulnerabilidade
vendorReferences	VendorReference[]	Referência do fornecedor

CVE

Detalhes da CVE

Nome	Tipo	Description
link	string	URL do link
title	string	Título CVE

CVSS

Detalhes do CVSS

Nome	Tipo	Description
base	number	Base cvss

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

OnPremiseResourceDetails

Detalhes do recurso local que foi avaliado

Nome	Tipo	Description
machineName	string	O nome do computador
source	string: OnPremise	A plataforma em que o recurso avaliado reside
sourceComputerId	string	A ID do agente do oms instalada no computador
vmuuid	string	A ID exclusiva do computador
workspaceId	string	ID de recurso do Azure do workspace ao qual o computador está anexado

OnPremiseSqlResourceDetails

Detalhes do recurso sql local que foi avaliado

Nome	Tipo	Description
databaseName	string	O nome do banco de dados Sql instalado no computador
machineName	string	O nome do computador
serverName	string	O nome do sql server instalado no computador
source	string: OnPremiseSql	A plataforma em que o recurso avaliado reside
sourceComputerId	string	A ID do agente do oms instalada no computador
vmuuid	string	A ID exclusiva do computador
workspaceId	string	ID de recurso do Azure do workspace ao qual o computador está anexado

SecuritySubAssessment

Subavaliação de segurança em um recurso

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Detalhes da subavaliação
properties.category	string	Categoria da subavaliação
properties.description	string	Descrição legível por humanos do status de avaliação
properties.displayName	string	Nome de exibição amigável da subavaliação
properties.id	string	ID da vulnerabilidade
properties.impact	string	Descrição do impacto dessa subavaliação
properties.remediation	string	Informações sobre como corrigir essa subavaliação
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Detalhes do recurso que foi avaliado
properties.status	SubAssessmentStatus	Status da subavaliação
properties.timeGenerated	string	A data e a hora em que a subavaliação foi gerada
type	string	Tipo de recurso

SecuritySubAssessmentList

Lista de subavaliações de segurança

Nome	Tipo	Description
nextLink	string	O URI a ser buscado na próxima página.
value	SecuritySubAssessment[]	Subavaliação de segurança em um recurso

ServerVulnerabilityProperties

Campos de contexto adicionais para avaliação de vulnerabilidade do servidor

Nome	Tipo	Description
assessedResourceType	string: ServerVulnerabilityAssessment	Tipo de recurso de subavaliação
cve	CVE[]	Lista de CVEs
cvss	<string,  CVSS>	Dicionário da versão CVSS para o objeto de detalhes CVSS
patchable	boolean	Indica se um patch está disponível ou não
publishedTime	string	Hora da publicação
threat	string	Nome da ameaça
type	string	Tipo de vulnerabilidade. por exemplo: vulnerabilidade, vulnerabilidade potencial, informações coletadas
vendorReferences	VendorReference[]	Referência do fornecedor

severity

O nível de gravidade da subavaliação

Nome	Tipo	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Detalhes do recurso que foi avaliado

Nome	Tipo	Description
assessedResourceType	string: SqlServerVulnerability	Tipo de recurso de subavaliação
query	string	A consulta T-SQL executada no banco de dados SQL para executar o marcar específico
type	string	O tipo de recurso ao qual a subavaliação se refere nos detalhes do recurso

SubAssessmentStatus

Status da subavaliação

Nome	Tipo	Description
cause	string	Código programático para a causa da avaliação status
code	SubAssessmentStatusCode	Código programático para o status da avaliação
description	string	Descrição legível por humanos do status de avaliação
severity	severity	O nível de gravidade da subavaliação

SubAssessmentStatusCode

Código programático para o status da avaliação

Nome	Tipo	Description
Healthy	string	O recurso está íntegro
NotApplicable	string	A avaliação desse recurso não aconteceu
Unhealthy	string	O recurso tem um problema de segurança que precisa ser resolvido

VendorReference

Referência do fornecedor

Nome	Tipo	Description
link	string	URL do link
title	string	Título do link