Assessments Metadata - Create In Subscription

Service:

Defender for Cloud

API Version:

2020-01-01

Erstellen von Metadateninformationen für einen Bewertungstyp in einem bestimmten Abonnement

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}?api-version=2020-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
assessmentMetadataName	path	True	string	Der Bewertungsschlüssel – eindeutiger Schlüssel für den Bewertungstyp
subscriptionId	path	True	string	Azure-Abonnement-ID Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	API-Version für den Vorgang

Anforderungstext

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

Antworten

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

Create security assessment metadata for subscription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/0980887d-03d6-408c-9566-532f3456804e/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7?api-version=2020-01-01

{
  "properties": {
    "displayName": "Install endpoint protection solution on virtual machine scale sets",
    "description": "Install an endpoint protection solution on your virtual machines scale sets, to protect them from threats and vulnerabilities.",
    "remediationDescription": "To install an endpoint protection solution: 1.  <a href=\"https://docs.microsoft.com/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-faq#how-do-i-turn-on-antimalware-in-my-virtual-machine-scale-set\">Follow the instructions in How do I turn on antimalware in my virtual machine scale set</a>",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Sample Response

Status code:

200

{
  "id": "/providers/Microsoft.Security/assessmentMetadata/ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "name": "ca039e75-a276-4175-aebc-bcd41e4b14b7",
  "type": "Microsoft.Security/assessmentMetadata",
  "properties": {
    "displayName": "My organization security assessment",
    "description": "Assessment that my organization created to view our security assessment in Azure Security Center",
    "remediationDescription": "Fix it with these remediation instructions",
    "categories": [
      "Compute"
    ],
    "severity": "Medium",
    "userImpact": "Low",
    "implementationEffort": "Low",
    "threats": [
      "dataExfiltration",
      "dataSpillage",
      "maliciousInsider"
    ],
    "assessmentType": "CustomerManaged"
  }
}

Definitionen

Name	Beschreibung
assessmentType	BuiltIn, wenn die Bewertung basierend auf der integrierten Azure Policy Definition, Benutzerdefiniert, wenn die Bewertung auf benutzerdefinierten Azure Policy Definition basiert
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.
implementationEffort	Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist
SecurityAssessmentMetadata	Metadaten zur Sicherheitsbewertung
SecurityAssessmentMetadataPartnerData	Beschreibt den Partner, der die Bewertung erstellt hat.
severity	Der Schweregrad der Bewertung
threats
userImpact	Die Benutzerwirkung der Bewertung

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

categories

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.

implementationEffort

Der implementierungsaufwand, der zum Beheben dieser Bewertung erforderlich ist

Name	Typ	Beschreibung
High	string
Low	string
Moderate	string

SecurityAssessmentMetadata

Metadaten zur Sicherheitsbewertung

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

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