Sub Assessments - Get

Serviço:

Defender for Cloud

Versão da API:

2019-01-01-preview

Obter uma subavaliação de segurança no seu recurso digitalizado

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
assessmentName	path	True	string	A chave de avaliação - Chave única 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).
subAssessmentName	path	True	string	A chave Sub-Assessment - Chave única para o tipo de subavaliação
api-version	query	True	string	Versão da API para a operação

Respostas

Name	Tipo	Description
200 OK	SecuritySubAssessment	OK
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get security recommendation task from security data location

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2/providers/Microsoft.Security/assessments/1195afff-c881-495e-9bc5-1486211ae03f/subAssessments/95f7da9c-a2a4-1322-0758-fcd24ef09b85?api-version=2019-01-01-preview

Java

/**
 * Samples for SubAssessments Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/SubAssessments/
     * GetSubAssessment_example.json
     */
    /**
     * Sample code: Get security recommendation task from security data location.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getSecurityRecommendationTaskFromSecurityDataLocation(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.subAssessments().getWithResponse(
            "subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2",
            "1195afff-c881-495e-9bc5-1486211ae03f", "95f7da9c-a2a4-1322-0758-fcd24ef09b85",
            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/GetSubAssessment_example.json
func ExampleSubAssessmentsClient_Get() {
	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)
	}
	res, err := clientFactory.NewSubAssessmentsClient().Get(ctx, "subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2", "1195afff-c881-495e-9bc5-1486211ae03f", "95f7da9c-a2a4-1322-0758-fcd24ef09b85", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SubAssessment = armsecurity.SubAssessment{
	// 	Name: to.Ptr("95f7da9c-a2a4-1322-0758-fcd24ef09b85"),
	// 	Type: to.Ptr("Microsoft.Security/assessments/subAssessments"),
	// 	ID: to.Ptr("/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2/providers/Microsoft.Security/assessments/1195afff-c881-495e-9bc5-1486211ae03f/subassessments/95f7da9c-a2a4-1322-0758-fcd24ef09b85"),
	// 	Properties: &armsecurity.SubAssessmentProperties{
	// 		Description: to.Ptr("PuTTY ssh_agent_channel_data Function Integer Overflow Vulnerability"),
	// 		AdditionalData: &armsecurity.AdditionalData{
	// 			AssessedResourceType: to.Ptr(armsecurity.AssessedResourceTypeServerVulnerability),
	// 		},
	// 		Category: to.Ptr("Local"),
	// 		DisplayName: to.Ptr("PuTTY ssh_agent_channel_data Function Integer Overflow Vulnerability"),
	// 		ID: to.Ptr("370361"),
	// 		Impact: to.Ptr("Successful exploitation could allow remote attackers to have unspecified impact via a large length value in an agent protocol message."),
	// 		Remediation: to.Ptr("Customers are advised to upgrade toPuTTY 0.68 or later version in order to remediate this vulnerability."),
	// 		ResourceDetails: &armsecurity.AzureResourceDetails{
	// 			Source: to.Ptr(armsecurity.SourceAzure),
	// 			ID: to.Ptr("/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2"),
	// 		},
	// 		Status: &armsecurity.SubAssessmentStatus{
	// 			Code: to.Ptr(armsecurity.SubAssessmentStatusCodeUnhealthy),
	// 			Severity: to.Ptr(armsecurity.SeverityMedium),
	// 		},
	// 		TimeGenerated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-02-02T12:36:50.779Z"); 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 a security sub-assessment on your scanned resource
 *
 * @summary Get a security sub-assessment on your scanned resource
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/SubAssessments/GetSubAssessment_example.json
 */
async function getSecurityRecommendationTaskFromSecurityDataLocation() {
  const scope =
    "subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2";
  const assessmentName = "1195afff-c881-495e-9bc5-1486211ae03f";
  const subAssessmentName = "95f7da9c-a2a4-1322-0758-fcd24ef09b85";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.subAssessments.get(scope, assessmentName, subAssessmentName);
  console.log(result);
}

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.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/GetSubAssessment_example.json
// this example is just showing the usage of "SubAssessments_Get" 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 SecuritySubAssessmentResource created on azure
// for more information of creating SecuritySubAssessmentResource, please refer to the document of SecuritySubAssessmentResource
string scope = "subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2";
string assessmentName = "1195afff-c881-495e-9bc5-1486211ae03f";
string subAssessmentName = "95f7da9c-a2a4-1322-0758-fcd24ef09b85";
ResourceIdentifier securitySubAssessmentResourceId = SecuritySubAssessmentResource.CreateResourceIdentifier(scope, assessmentName, subAssessmentName);
SecuritySubAssessmentResource securitySubAssessment = client.GetSecuritySubAssessmentResource(securitySubAssessmentResourceId);

// invoke the operation
SecuritySubAssessmentResource result = await securitySubAssessment.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

{
  "type": "Microsoft.Security/assessments/subAssessments",
  "id": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2/providers/Microsoft.Security/assessments/1195afff-c881-495e-9bc5-1486211ae03f/subassessments/95f7da9c-a2a4-1322-0758-fcd24ef09b85",
  "name": "95f7da9c-a2a4-1322-0758-fcd24ef09b85",
  "properties": {
    "id": "370361",
    "displayName": "PuTTY ssh_agent_channel_data Function Integer Overflow Vulnerability",
    "status": {
      "code": "Unhealthy",
      "severity": "Medium"
    },
    "remediation": "Customers are advised to upgrade toPuTTY 0.68 or later version in order to remediate this vulnerability.",
    "impact": "Successful exploitation could allow remote attackers to have unspecified impact via a large length value in an agent protocol message.",
    "category": "Local",
    "description": "PuTTY ssh_agent_channel_data Function Integer Overflow Vulnerability",
    "timeGenerated": "2021-02-02T12:36:50.779Z",
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/212f9889-769e-45ae-ab43-6da33674bd26/resourceGroups/DEMORG/providers/Microsoft.Compute/virtualMachines/vm2"
    },
    "additionalData": {
      "assessedResourceType": "ServerVulnerability",
      "type": "VirtualMachine",
      "cvss": {
        "2.0": {
          "base": 7.5
        },
        "3.0": {
          "base": 9.8
        }
      },
      "patchable": true,
      "cve": [
        {
          "title": "CVE-2017-6542",
          "link": "http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-6542"
        }
      ],
      "publishedTime": "2017-04-06T10:58:25",
      "threat": "PuTTY is a client program for the SSH, Telnet and Rlogin network protocols",
      "vendorReferences": [
        {
          "title": "CVE-2017-6542",
          "link": "http://www.chiark.greenend.org.uk/~sgtatham/putty/wishlist/vuln-agent-fwd-overflow.html"
        }
      ]
    }
  }
}

Definições

Name	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 para operações com falha. (Isso também segue o formato de resposta de erro OData.)
CloudErrorBody	O detalhe do erro.
ContainerRegistryVulnerabilityProperties	Campos de contexto adicionais para registro de contêiner Avaliação de vulnerabilidade
CVE	Detalhes CVE
CVSS	Detalhes do CVSS
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
OnPremiseResourceDetails	Detalhes do recurso On Premise que foi avaliado
OnPremiseSqlResourceDetails	Detalhes do recurso On Premise Sql que foi avaliado
SecuritySubAssessment	Subavaliação de segurança em um recurso
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	Situação da subavaliação
SubAssessmentStatusCode	Código programático para o estado da avaliação
VendorReference	Referência do fornecedor

AzureResourceDetails

Detalhes do recurso do Azure que foi avaliado

Name	Tipo	Description
id	string	ID do recurso do Azure do recurso avaliado
source	string: Azure	A plataforma onde reside o recurso avaliado

CloudError

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

Name	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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 registro de contêiner Avaliação de vulnerabilidade

Name	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 cvss details
imageDigest	string	Resumo da imagem vulnerável
patchable	boolean	Indica se um patch está disponível ou não
publishedTime	string	Hora de 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 recolhidas, Vulnerabilidade
vendorReferences	VendorReference[]	Referência do fornecedor

CVE

Detalhes CVE

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

CVSS

Detalhes do CVSS

Name	Tipo	Description
base	number	Base CVSS

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

OnPremiseResourceDetails

Detalhes do recurso On Premise que foi avaliado

Name	Tipo	Description
machineName	string	O nome da máquina
source	string: OnPremise	A plataforma onde reside o recurso avaliado
sourceComputerId	string	O ID do agente oms instalado na máquina
vmuuid	string	O ID único da máquina
workspaceId	string	ID do recurso do Azure do espaço de trabalho ao qual a máquina está anexada

OnPremiseSqlResourceDetails

Detalhes do recurso On Premise Sql que foi avaliado

Name	Tipo	Description
databaseName	string	O nome do banco de dados Sql instalado na máquina
machineName	string	O nome da máquina
serverName	string	O nome do servidor Sql instalado na máquina
source	string: OnPremiseSql	A plataforma onde reside o recurso avaliado
sourceComputerId	string	O ID do agente oms instalado na máquina
vmuuid	string	O ID único da máquina
workspaceId	string	ID do recurso do Azure do espaço de trabalho ao qual a máquina está anexada

SecuritySubAssessment

Subavaliação de segurança em um recurso

Name	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Pormenores da subavaliação
properties.category	string	Categoria da subavaliação
properties.description	string	Descrição legível por humanos do estado da avaliação
properties.displayName	string	Nome de visualização convivial da subavaliação
properties.id	string	ID da vulnerabilidade
properties.impact	string	Descrição do impacto desta subavaliação
properties.remediation	string	Informações sobre como corrigir esta subavaliação
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Detalhes do recurso que foi avaliado
properties.status	SubAssessmentStatus	Situação da subavaliação
properties.timeGenerated	string	Data e hora em que a subavaliação foi gerada
type	string	Tipo de recurso

ServerVulnerabilityProperties

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

Name	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 cvss details
patchable	boolean	Indica se um patch está disponível ou não
publishedTime	string	Hora de publicação
threat	string	Nome da ameaça
type	string	Tipo de vulnerabilidade. Por exemplo: vulnerabilidade, vulnerabilidade potencial, informações recolhidas
vendorReferences	VendorReference[]	Referência do fornecedor

severity

O nível de gravidade da subavaliação

Name	Tipo	Description
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Detalhes do recurso que foi avaliado

Name	Tipo	Description
assessedResourceType	string: SqlServerVulnerability	Tipo de recurso de subavaliação
query	string	A consulta T-SQL que é executada em seu banco de dados SQL para executar a verificação específica
type	string	O tipo de recurso ao qual a subavaliação se refere em seus detalhes de recurso

SubAssessmentStatus

Situação da subavaliação

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

SubAssessmentStatusCode

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

Name	Tipo	Description
Healthy	string	O recurso é saudável
NotApplicable	string	A avaliação para este recurso não aconteceu
Unhealthy	string	O recurso tem um problema de segurança que precisa ser resolvido

VendorReference

Referência do fornecedor

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