Sub Assessments - Get

Referenz

Service:: Defender for Cloud

API Version:: 2019-01-01-preview

Abrufen einer Sicherheitsunterbewertung für Ihre gescannte Ressource

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
assessmentName	path	True	string	Der Bewertungsschlüssel – eindeutiger Schlüssel für den Bewertungstyp
scope	path	True	string	Der Abfragebereich kann ein Abonnement (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) oder eine Verwaltungsgruppe (/providers/Microsoft.Management/managementGroups/mgName) sein.
subAssessmentName	path	True	string	Der Sub-Assessment Schlüssel – Eindeutiger Schlüssel für den Unterbewertungstyp
api-version	query	True	string	API-Version für den Vorgang

Antworten

Name	Typ	Beschreibung
200 OK	SecuritySubAssessment	OK
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get security recommendation task from security data location

Sample Request

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


/**
 * 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

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/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

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 subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  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, subscriptionId);
  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

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

Definitionen

Name	Beschreibung
AzureResourceDetails	Details der bewerteten Azure-Ressource
CloudError	Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)
CloudErrorBody	Die Fehlerdetails.
ContainerRegistryVulnerabilityProperties	Zusätzliche Kontextfelder für die Sicherheitsrisikobewertung der Containerregistrierung
CVE	CVE-Details
CVSS	CVSS-Details
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
OnPremiseResourceDetails	Details zur lokalen Ressource, die bewertet wurde
OnPremiseSqlResourceDetails	Details zur bewerteten lokalen Sql-Ressource
SecuritySubAssessment	Sicherheitsunterbewertung für eine Ressource
ServerVulnerabilityProperties	Zusätzliche Kontextfelder für die Serversicherheitsbewertung
severity	Schweregrad der Unterbewertung
SqlServerVulnerabilityProperties	Details der bewerteten Ressource
SubAssessmentStatus	Status der Teilbewertung
SubAssessmentStatusCode	Programmgesteuerter Code für die status der Bewertung
VendorReference	Herstellerreferenz

AzureResourceDetails

Details der bewerteten Azure-Ressource

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID der bewerteten Ressource
source	string: Azure	Die Plattform, auf der sich die bewertete Ressource befindet

CloudError

Allgemeine Fehlerantwort für alle Azure Resource Manager-APIs, zur Rückgabe von Fehlerdetails für fehlgeschlagene Vorgänge. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error.additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Die Fehlerdetails.
error.message	string	Die Fehlermeldung.
error.target	string	Das Fehlerziel.

CloudErrorBody

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	CloudErrorBody[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ContainerRegistryVulnerabilityProperties

Zusätzliche Kontextfelder für die Sicherheitsrisikobewertung der Containerregistrierung

Name	Typ	Beschreibung
assessedResourceType	string: ContainerRegistryVulnerability	Ressourcentyp der Unterbewertung
cve	CVE[]	Liste der CVEs
cvss	<string, CVSS>	Verzeichnis von cvss-Version zum cvss-Detailobjekt
imageDigest	string	Digest des anfälligen Images
patchable	boolean	Gibt an, ob ein Patch verfügbar ist.
publishedTime	string	Veröffentlichungszeit
repositoryName	string	Name des Repositorys, zu dem das anfällige Image gehört
type	string	Sicherheitsrisikotyp. z.B.: Sicherheitsrisiko, potenzielle Sicherheitsrisiken, gesammelte Informationen, Sicherheitsrisiko
vendorReferences	VendorReference[]	Herstellerreferenz

CVE

CVE-Details

Name	Typ	Beschreibung
link	string	Link-URL
title	string	CVE-Titel

CVSS

CVSS-Details

Name	Typ	Beschreibung
base	number	CVSS-Basis

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

OnPremiseResourceDetails

Details zur lokalen Ressource, die bewertet wurde

Name	Typ	Beschreibung
machineName	string	Der Name des Computers
source	string: OnPremise	Die Plattform, auf der sich die bewertete Ressource befindet
sourceComputerId	string	Die auf dem Computer installierte OMS-Agent-ID
vmuuid	string	Die eindeutige ID des Computers
workspaceId	string	Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist

OnPremiseSqlResourceDetails

Details zur bewerteten lokalen Sql-Ressource

Name	Typ	Beschreibung
databaseName	string	Sql-Datenbankname, der auf dem Computer installiert ist
machineName	string	Der Name des Computers
serverName	string	Der sql Server-Name, der auf dem Computer installiert ist
source	string: OnPremiseSql	Die Plattform, auf der sich die bewertete Ressource befindet
sourceComputerId	string	Die auf dem Computer installierte OMS-Agent-ID
vmuuid	string	Die eindeutige ID des Computers
workspaceId	string	Azure-Ressourcen-ID des Arbeitsbereichs, an den der Computer angefügt ist

SecuritySubAssessment

Sicherheitsunterbewertung für eine Ressource

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Ressourcenname
properties.additionalData	AdditionalData: ContainerRegistryVulnerabilityProperties ServerVulnerabilityProperties SqlServerVulnerabilityProperties	Details zur Teilbewertung
properties.category	string	Kategorie der Unterbewertung
properties.description	string	Für Menschen lesbare Beschreibung des Bewertungsstatus
properties.displayName	string	Benutzerfreundlicher Anzeigename der Teilbewertung
properties.id	string	Sicherheitsrisiko-ID
properties.impact	string	Beschreibung der Auswirkungen dieser Teilbewertung
properties.remediation	string	Informationen zur Behebung dieser Teilbewertung
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Details der bewerteten Ressource
properties.status	SubAssessmentStatus	Status der Teilbewertung
properties.timeGenerated	string	Datum und Uhrzeit der Generierung der Teilbewertung
type	string	Ressourcentyp

ServerVulnerabilityProperties

Zusätzliche Kontextfelder für die Serversicherheitsbewertung

Name	Typ	Beschreibung
assessedResourceType	string: ServerVulnerabilityAssessment	Ressourcentyp der Unterbewertung
cve	CVE[]	Liste der CVEs
cvss	<string, CVSS>	Verzeichnis von cvss-Version zum cvss-Detailobjekt
patchable	boolean	Gibt an, ob ein Patch verfügbar ist.
publishedTime	string	Veröffentlichungszeit
threat	string	Bedrohungsname
type	string	Sicherheitsrisikotyp. z.B.: Sicherheitsrisiko, potenzielle Sicherheitsrisiken, gesammelte Informationen
vendorReferences	VendorReference[]	Herstellerreferenz

severity

Schweregrad der Unterbewertung

Name	Typ	Beschreibung
High	string
Low	string
Medium	string

SqlServerVulnerabilityProperties

Details der bewerteten Ressource

Name	Typ	Beschreibung
assessedResourceType	string: SqlServerVulnerability	Ressourcentyp der Unterbewertung
query	string	Die T-SQL-Abfrage, die für Ihre SQL-Datenbank ausgeführt wird, um die bestimmte Überprüfung durchzuführen.
type	string	Der Ressourcentyp, auf den sich die Unterbewertung in den Ressourcendetails bezieht.

SubAssessmentStatus

Status der Teilbewertung

Name	Typ	Beschreibung
cause	string	Programmgesteuerter Code für die Ursache der Bewertung status
code	SubAssessmentStatusCode	Programmgesteuerter Code für die status der Bewertung
description	string	Für Menschen lesbare Beschreibung des Bewertungsstatus
severity	severity	Schweregrad der Unterbewertung

SubAssessmentStatusCode

Programmgesteuerter Code für die status der Bewertung

Name	Typ	Beschreibung
Healthy	string	Die Ressource ist fehlerfrei.
NotApplicable	string	Die Bewertung für diese Ressource wurde nicht durchgeführt.
Unhealthy	string	Die Ressource weist ein Sicherheitsproblem auf, das behoben werden muss.

VendorReference

Herstellerreferenz

Name	Typ	Beschreibung
link	string	Link-URL
title	string	Linktitel

Sub Assessments - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Get security recommendation task from security data location

Sample Request

Sample Response

Definitionen

AzureResourceDetails

CloudError

CloudErrorBody

ContainerRegistryVulnerabilityProperties

CVE

CVSS

ErrorAdditionalInfo

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecuritySubAssessment

ServerVulnerabilityProperties

severity

SqlServerVulnerabilityProperties

SubAssessmentStatus

SubAssessmentStatusCode

VendorReference

Zusätzliche Ressourcen