Sub Assessments - Get

Service:

Defender for Cloud

API Version:

2019-01-01-preview

Obtenir une sous-évaluation de sécurité sur votre ressource analysée

GET https://management.azure.com/{scope}/providers/Microsoft.Security/assessments/{assessmentName}/subAssessments/{subAssessmentName}?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).
subAssessmentName	path	True	string	Clé Sub-Assessment - Clé unique pour le type de sous-évaluation
api-version	query	True	string	Version de l’API pour l’opération

Réponses

Nom	Type	Description
200 OK	SecuritySubAssessment	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

Get security recommendation task from security data location

Sample Request

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

Sample Response

Status code:

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

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 du CVSS
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
OnPremiseResourceDetails	Détails de la ressource locale qui a été é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
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 la 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 CVE
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 du 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 qui a été évaluée

Nom	Type	Description
machineName	string	Nom de l’ordinateur
source	string: OnPremise	Plateforme où réside la ressource évaluée
sourceComputerId	string	ID de l’agent OMS installé sur la machine
vmuuid	string	ID unique de l’ordinateur
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 la machine
machineName	string	Nom de l’ordinateur
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 la machine
vmuuid	string	ID unique de l’ordinateur
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 complet 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

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 CVE
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 l’case activée
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 la 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 la 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 a 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