Assessments - Get

Referenz

Service:: Defender for Cloud

API Version:: 2020-01-01

Abrufen einer Sicherheitsbewertung für Ihre gescannte Ressource

GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}?api-version=2020-01-01

With optional parameters:

GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}?api-version=2020-01-01&$expand={$expand}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
assessmentName	path	True	string	Der Bewertungsschlüssel – eindeutiger Schlüssel für den Bewertungstyp
resourceId	path	True	string	Der Bezeichner der Ressource.
api-version	query	True	string	API-Version für den Vorgang
$expand	query		ExpandEnum	OData erweitern. Dies ist optional.

Antworten

Name	Typ	Beschreibung
200 OK	SecurityAssessment	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

Get security recommendation task from security data location with expand parameter

Get security recommendation task from security data location

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"
    },
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "status": {
      "code": "NotApplicable",
      "cause": "OffByPolicy",
      "description": "The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"
    },
    "additionalData": {
      "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
    }
  }
}

Get security recommendation task from security data location with expand parameter

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b?api-version=2020-01-01&$expand=links

Sample Response

Status code:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2/providers/Microsoft.Security/assessments/21300918-b2e3-0346-785f-c77ff57d243b",
  "name": "21300918-b2e3-0346-785f-c77ff57d243b",
  "type": "Microsoft.Security/assessments",
  "properties": {
    "resourceDetails": {
      "source": "Azure",
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss2"
    },
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "status": {
      "code": "NotApplicable",
      "cause": "OffByPolicy",
      "description": "The effective policy for the assessment was evaluated to off - use Microsoft.Authorization/policyAssignments to turn this assessment on"
    },
    "additionalData": {
      "linkedWorkspaceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myLaWorkspace"
    },
    "links": {
      "azurePortalUri": "https://www.portal.azure.com/?fea#blade/Microsoft_Azure_Security/RecommendationsBlade/assessmentKey/21300918-b2e3-0346-785f-c77ff57d243b"
    }
  }
}

Definitionen

Name	Beschreibung
AssessmentLinks	Für die Bewertung relevante Links
AssessmentStatus	Das Ergebnis der Bewertung
AssessmentStatusCode	Programmgesteuerter Code für die status der Bewertung
assessmentType	BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert
AzureResourceDetails	Details der bewerteten Azure-Ressource
categories
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.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ExpandEnum	OData erweitern. Optional.
implementationEffort	Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist
OnPremiseResourceDetails	Details zur lokalen Ressource, die bewertet wurde
OnPremiseSqlResourceDetails	Details zur bewerteten lokalen Sql-Ressource
SecurityAssessment	Sicherheitsbewertung für eine Ressource
SecurityAssessmentMetadataPartnerData	Beschreibt den Partner, der die Bewertung erstellt hat.
SecurityAssessmentMetadataProperties	Beschreibt die Eigenschaften einer Bewertungsmetadaten.
SecurityAssessmentPartnerData	Daten zur Integration von Drittanbieterpartnern
severity	Der Schweregrad der Bewertung
threats
userImpact	Die Benutzerwirkung der Bewertung

AssessmentLinks

Für die Bewertung relevante Links

Name	Typ	Beschreibung
azurePortalUri	string	Link zur Bewertung im Azure-Portal

AssessmentStatus

Das Ergebnis der Bewertung

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

AssessmentStatusCode

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.

assessmentType

BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert

Name	Typ	Beschreibung
BuiltIn	string	Microsoft Defender für cloudverwaltete Bewertungen
CustomPolicy	string	Benutzerdefinierte Richtlinien, die automatisch von Azure Policy in Microsoft Defender für Cloud erfasst werden
CustomerManaged	string	Benutzerbewertungen, die direkt vom Benutzer oder einem anderen Drittanbieter an Microsoft Defender for Cloud gepusht werden
VerifiedPartner	string	Eine Bewertung, die von einem überprüften Drittanbieter erstellt wurde, wenn der Benutzer sie mit ASC verbunden hat

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

Name	Typ	Beschreibung
Compute	string
Data	string
IdentityAndAccess	string
IoT	string
Networking	string

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.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

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

ExpandEnum

OData erweitern. Optional.

Name	Typ	Beschreibung
links	string	Alle Links, die einer Bewertung zugeordnet sind
metadata	string	Bewertungsmetadaten

implementationEffort

Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist

Name	Typ	Beschreibung
High	string
Low	string
Moderate	string

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

SecurityAssessment

Sicherheitsbewertung für eine Ressource

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Ressourcenname
properties.additionalData	object	Zusätzliche Daten zur Bewertung
properties.displayName	string	Benutzerfreundlicher Anzeigename der Bewertung
properties.links	AssessmentLinks	Für die Bewertung relevante Links
properties.metadata	SecurityAssessmentMetadataProperties	Beschreibt die Eigenschaften einer Bewertungsmetadaten.
properties.partnersData	SecurityAssessmentPartnerData	Daten zur Integration von Drittanbieterpartnern
properties.resourceDetails	ResourceDetails: AzureResourceDetails OnPremiseResourceDetails OnPremiseSqlResourceDetails	Details der bewerteten Ressource
properties.status	AssessmentStatus	Das Ergebnis der Bewertung
type	string	Ressourcentyp

SecurityAssessmentMetadataPartnerData

Beschreibt den Partner, der die Bewertung erstellt hat.

Name	Typ	Beschreibung
partnerName	string	Name des Unternehmens des Partners
productName	string	Name des Produkts des Partners, der die Bewertung erstellt hat
secret	string	Geheimnis, um den Partner zu authentifizieren und zu überprüfen, ob die Bewertung erstellt wurde – schreibgeschützt

SecurityAssessmentMetadataProperties

Beschreibt die Eigenschaften einer Bewertungsmetadaten.

Name	Typ	Beschreibung
assessmentType	assessmentType	BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert
categories	categories[]	Die Kategorien von Ressourcen, die gefährdet sind, wenn die Bewertung fehlerhaft ist
description	string	Lesbare Beschreibung der Bewertung
displayName	string	Benutzerfreundlicher Anzeigename der Bewertung
implementationEffort	implementationEffort	Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist
partnerData	SecurityAssessmentMetadataPartnerData	Beschreibt den Partner, der die Bewertung erstellt hat.
policyDefinitionId	string	Azure-Ressourcen-ID der Richtliniendefinition, die diese Bewertungsberechnung aktiviert
preview	boolean	True, wenn sich diese Bewertung in der Vorschauversion status
remediationDescription	string	Lesbare Beschreibung, was Sie tun sollten, um dieses Sicherheitsproblem zu beheben
severity	severity	Der Schweregrad der Bewertung
threats	threats[]	Auswirkungen der Bewertung auf Bedrohungen
userImpact	userImpact	Die Benutzerwirkung der Bewertung

SecurityAssessmentPartnerData

Daten zur Integration von Drittanbieterpartnern

Name	Typ	Beschreibung
partnerName	string	Name des Unternehmens des Partners
secret	string	Geheimnis zum Authentifizieren des Partners – schreibgeschützt

severity

Der Schweregrad der Bewertung

Name	Typ	Beschreibung
High	string
Low	string
Medium	string

threats

Name	Typ	Beschreibung
accountBreach	string
dataExfiltration	string
dataSpillage	string
denialOfService	string
elevationOfPrivilege	string
maliciousInsider	string
missingCoverage	string
threatResistance	string

userImpact

Die Benutzerwirkung der Bewertung

Name	Typ	Beschreibung
High	string
Low	string
Moderate	string

Freigeben über

Assessments - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

Get security recommendation task from security data location

Sample Request

Sample Response

Get security recommendation task from security data location with expand parameter

Sample Request

Sample Response

Definitionen

AssessmentLinks

AssessmentStatus

AssessmentStatusCode

assessmentType

AzureResourceDetails

categories

CloudError

CloudErrorBody

ErrorAdditionalInfo

ExpandEnum

implementationEffort

OnPremiseResourceDetails

OnPremiseSqlResourceDetails

SecurityAssessment

SecurityAssessmentMetadataPartnerData

SecurityAssessmentMetadataProperties

SecurityAssessmentPartnerData

severity

threats

userImpact

Zusätzliche Ressourcen