Automations - Validate
Überprüft das Sicherheitsautomatisierungsmodell vor dem Erstellen oder Aktualisieren. Alle Validierungsfehler werden an den Client zurückgegeben.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}/validate?api-version=2023-12-01-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
automation
|
path | True |
string |
Der Name der Sicherheitsautomatisierung. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe im Abonnement des Benutzers. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. RegEx-Muster: |
subscription
|
path | True |
string |
Azure-Abonnement-ID RegEx-Muster: |
api-version
|
query | True |
string |
API-Version für den Vorgang |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
etag |
string |
Das Entitätstag wird verwendet, um zwei oder mehr Entitäten aus derselben angeforderten Ressource zu vergleichen. |
kind |
string |
Art der Ressource |
location |
string |
Speicherort der Ressource |
properties.actions | AutomationAction[]: |
Eine Auflistung der Aktionen, die ausgelöst werden, wenn alle konfigurierten Regelauswertungen innerhalb mindestens eines Regelsatzes true sind. |
properties.description |
string |
Die Beschreibung der Sicherheitsautomatisierung. |
properties.isEnabled |
boolean |
Gibt an, ob die Sicherheitsautomatisierung aktiviert ist. |
properties.scopes |
Eine Auflistung von Bereichen, auf die die Logik für Sicherheitsautomatisierungen angewendet wird. Unterstützte Bereiche sind das Abonnement selbst oder eine Ressourcengruppe unter diesem Abonnement. Die Automatisierung gilt nur für definierte Bereiche. |
|
properties.sources |
Eine Auflistung der Quellereignistypen, die den Sicherheitsautomatisierungssatz auswerten. |
|
tags |
object |
Eine Liste mit Schlüssel-/Wertpaaren, welche die Ressource beschreiben. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang nicht erfolgreich durchgeführt werden konnte. |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Beispiele
Validate the security automation model before create or update
Beispielanforderung
POST https://management.azure.com/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation/validate?api-version=2023-12-01-preview
{
"location": "Central US",
"tags": {},
"properties": {
"description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment of type customAssessment",
"isEnabled": true,
"scopes": [
{
"description": "A description that helps to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5",
"scopePath": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup"
}
],
"sources": [
{
"eventSource": "Assessments",
"ruleSets": [
{
"rules": [
{
"propertyJPath": "$.Entity.AssessmentType",
"propertyType": "String",
"expectedValue": "customAssessment",
"operator": "Equals"
}
]
}
]
}
],
"actions": [
{
"logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
"actionType": "LogicApp",
"uri": "https://exampleTriggerUri1.com"
}
]
}
}
Beispiel für eine Antwort
{
"isValid": true,
"message": "Validation Successful"
}
Definitionen
Name | Beschreibung |
---|---|
Automation |
Die Sicherheitsautomatisierungsressource. |
Automation |
Der Event Hub-Ziel, in den Ereignisdaten exportiert werden. Weitere Informationen zu Microsoft Defender für fortlaufende Cloudexportfunktionen finden Sie unterhttps://aka.ms/ASCExportLearnMore |
Automation |
Die Logik-App-Aktion, die ausgelöst werden soll. Weitere Informationen zu den Workflowautomatisierungsfunktionen von Microsoft Defender für Cloud finden Sie unterhttps://aka.ms/ASCWorkflowAutomationLearnMore |
Automation |
Der Log Analytics-Arbeitsbereich, in den Ereignisdaten exportiert werden. Sicherheitswarnungsdaten befinden sich in der Tabelle "SecurityAlert", und die Bewertungsdaten befinden sich in der Tabelle "SecurityRecommendation" (unter den Lösungen "Security"/"SecurityCenterFree"). Beachten Sie, dass zum Anzeigen der Daten im Arbeitsbereich die Kostenlose/Standardlösung Security Center Log Analytics für diesen Arbeitsbereich aktiviert werden muss. Weitere Informationen zu Microsoft Defender für fortlaufende Cloudexportfunktionen finden Sie unterhttps://aka.ms/ASCExportLearnMore |
Automation |
Ein Regelsatz, der alle zugehörigen Regeln bei einem Ereignisabfangen auswertet. Nur wenn alle enthaltenen Regeln im Regelsatz als "true" ausgewertet werden, löst das Ereignis die definierten Aktionen aus. |
Automation |
Ein einzelner Automatisierungsbereich. |
Automation |
Die Quellereignistypen, die den Sicherheitsautomatisierungsregelsatz auswerten. Beispiel: Sicherheitswarnungen und Sicherheitsbewertungen. Weitere Informationen zu den unterstützten Datenmodellschemas für Sicherheitsereignisse finden Sie unter https://aka.ms/ASCAutomationSchemas. |
Automation |
Eine Regel, die beim Abfangen von Ereignissen ausgewertet wird. Die Regel wird konfiguriert, indem ein bestimmter Wert aus dem Ereignismodell mit einem erwarteten Wert verglichen wird. Dieser Vergleich erfolgt mithilfe eines der unterstützten Operatoren. |
Automation |
Der Zustandseigenschaftenbehälter des Sicherheitsautomatisierungsmodells. |
Cloud |
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.). |
Cloud |
Die Fehlerdetails. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Event |
Ein gültiger Ereignisquellentyp. |
Operator |
Ein gültiger Vergleichsoperator, der verwendet werden soll. Für String PropertyType wird ein Vergleich ohne Beachtung der Groß-/Kleinschreibung angewendet. |
Property |
Der Datentyp der verglichenen Operanden (String, Integer, Gleitkommazahl oder ein boolescher Wert [true/false]] |
Automation
Die Sicherheitsautomatisierungsressource.
Name | Typ | Beschreibung |
---|---|---|
etag |
string |
Das Entitätstag wird zum Vergleichen von zwei oder mehr Entitäten aus derselben angeforderten Ressource verwendet. |
id |
string |
Ressourcen-ID |
kind |
string |
Art der Ressource |
location |
string |
Speicherort der Ressource |
name |
string |
Ressourcenname |
properties.actions | AutomationAction[]: |
Eine Auflistung der Aktionen, die ausgelöst werden, wenn alle konfigurierten Regelauswertungen innerhalb mindestens eines Regelsatzes true sind. |
properties.description |
string |
Die Beschreibung der Sicherheitsautomatisierung. |
properties.isEnabled |
boolean |
Gibt an, ob die Sicherheitsautomatisierung aktiviert ist. |
properties.scopes |
Eine Auflistung von Bereichen, auf die die Logik für Sicherheitsautomatisierungen angewendet wird. Unterstützte Bereiche sind das Abonnement selbst oder eine Ressourcengruppe unter diesem Abonnement. Die Automatisierung gilt nur für definierte Bereiche. |
|
properties.sources |
Eine Auflistung der Quellereignistypen, die den Sicherheitsautomatisierungssatz auswerten. |
|
tags |
object |
Eine Liste mit Schlüssel-/Wertpaaren, welche die Ressource beschreiben. |
type |
string |
Ressourcentyp |
AutomationActionEventHub
Der Event Hub-Ziel, in den Ereignisdaten exportiert werden. Weitere Informationen zu Microsoft Defender für fortlaufende Cloudexportfunktionen finden Sie unterhttps://aka.ms/ASCExportLearnMore
Name | Typ | Beschreibung |
---|---|---|
actionType |
string:
Event |
Der Typ der Aktion, die von der Automatisierung ausgelöst wird |
connectionString |
string |
Der Event Hub-ziel-Verbindungszeichenfolge (es wird in keiner Antwort enthalten sein). |
eventHubResourceId |
string |
Die Azure-Ressourcen-ID des Ziel-Event Hubs. |
isTrustedServiceEnabled |
boolean |
Gibt an, ob der vertrauenswürdige Dienst aktiviert ist oder nicht. |
sasPolicyName |
string |
Der Name der Ziel-Event Hub-SAS-Richtlinie. |
AutomationActionLogicApp
Die Logik-App-Aktion, die ausgelöst werden soll. Weitere Informationen zu den Workflowautomatisierungsfunktionen von Microsoft Defender für Cloud finden Sie unterhttps://aka.ms/ASCWorkflowAutomationLearnMore
Name | Typ | Beschreibung |
---|---|---|
actionType |
string:
Logic |
Der Typ der Aktion, die von der Automatisierung ausgelöst wird |
logicAppResourceId |
string |
Die ausgelöste Azure-Ressourcen-ID der Logik-App. Dies kann sich auch in anderen Abonnements befinden, da Sie über Berechtigungen zum Auslösen der Logik-App verfügen. |
uri |
string |
Der Logik-App-Trigger-URI-Endpunkt (er wird in keiner Antwort eingeschlossen). |
AutomationActionWorkspace
Der Log Analytics-Arbeitsbereich, in den Ereignisdaten exportiert werden. Sicherheitswarnungsdaten befinden sich in der Tabelle "SecurityAlert", und die Bewertungsdaten befinden sich in der Tabelle "SecurityRecommendation" (unter den Lösungen "Security"/"SecurityCenterFree"). Beachten Sie, dass zum Anzeigen der Daten im Arbeitsbereich die Kostenlose/Standardlösung Security Center Log Analytics für diesen Arbeitsbereich aktiviert werden muss. Weitere Informationen zu Microsoft Defender für fortlaufende Cloudexportfunktionen finden Sie unterhttps://aka.ms/ASCExportLearnMore
Name | Typ | Beschreibung |
---|---|---|
actionType |
string:
Workspace |
Der Typ der Aktion, die von der Automatisierung ausgelöst wird |
workspaceResourceId |
string |
Die vollqualifizierte Azure-Ressourcen-ID des Log Analytics-Arbeitsbereichs. |
AutomationRuleSet
Ein Regelsatz, der alle zugehörigen Regeln bei einem Ereignisabfangen auswertet. Nur wenn alle enthaltenen Regeln im Regelsatz als "true" ausgewertet werden, löst das Ereignis die definierten Aktionen aus.
Name | Typ | Beschreibung |
---|---|---|
rules |
Eine Regel, die beim Abfangen von Ereignissen ausgewertet wird. Die Regel wird konfiguriert, indem ein bestimmter Wert aus dem Ereignismodell mit einem erwarteten Wert verglichen wird. Dieser Vergleich erfolgt mithilfe eines der unterstützten Operatoren. |
AutomationScope
Ein einzelner Automatisierungsbereich.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Die Beschreibung des Ressourcenbereichs. |
scopePath |
string |
Der Ressourcenbereichspfad. Dies kann das Abonnement sein, für das die Automatisierung definiert ist, oder eine Ressourcengruppe unter diesem Abonnement (vollqualifizierte Azure-Ressourcen-IDs). |
AutomationSource
Die Quellereignistypen, die den Sicherheitsautomatisierungsregelsatz auswerten. Beispiel: Sicherheitswarnungen und Sicherheitsbewertungen. Weitere Informationen zu den unterstützten Datenmodellschemas für Sicherheitsereignisse finden Sie unter https://aka.ms/ASCAutomationSchemas.
Name | Typ | Beschreibung |
---|---|---|
eventSource |
Ein gültiger Ereignisquellentyp. |
|
ruleSets |
Ein Satz von Regeln, die beim Abfangen von Ereignissen ausgewertet werden. Zwischen definierten Regelsätzen (logisches "or") wird eine logische Disjunktion angewendet. |
AutomationTriggeringRule
Eine Regel, die beim Abfangen von Ereignissen ausgewertet wird. Die Regel wird konfiguriert, indem ein bestimmter Wert aus dem Ereignismodell mit einem erwarteten Wert verglichen wird. Dieser Vergleich erfolgt mithilfe eines der unterstützten Operatoren.
Name | Typ | Beschreibung |
---|---|---|
expectedValue |
string |
Der erwartete Wert. |
operator |
Ein gültiger Vergleichsoperator, der verwendet werden soll. Für String PropertyType wird ein Vergleich ohne Beachtung der Groß-/Kleinschreibung angewendet. |
|
propertyJPath |
string |
Der JPath der Entitätsmodelleigenschaft, die überprüft werden soll. |
propertyType |
Der Datentyp der verglichenen Operanden (String, Integer, Gleitkommazahl oder ein boolescher Wert [true/false]] |
AutomationValidationStatus
Der Zustandseigenschaftenbehälter des Sicherheitsautomatisierungsmodells.
Name | Typ | Beschreibung |
---|---|---|
isValid |
boolean |
Gibt an, ob das Modell gültig ist oder nicht. |
message |
string |
Die Validierungsmeldung. |
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 |
Die zusätzlichen Fehlerinformationen. |
|
error.code |
string |
Der Fehlercode. |
error.details |
Die Fehlerdetails. |
|
error.message |
string |
Die Fehlermeldung. |
error.target |
string |
Das Fehlerziel. |
CloudErrorBody
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
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. |
EventSource
Ein gültiger Ereignisquellentyp.
Name | Typ | Beschreibung |
---|---|---|
Alerts |
string |
|
Assessments |
string |
|
AssessmentsSnapshot |
string |
|
AttackPaths |
string |
|
AttackPathsSnapshot |
string |
|
RegulatoryComplianceAssessment |
string |
|
RegulatoryComplianceAssessmentSnapshot |
string |
|
SecureScoreControls |
string |
|
SecureScoreControlsSnapshot |
string |
|
SecureScores |
string |
|
SecureScoresSnapshot |
string |
|
SubAssessments |
string |
|
SubAssessmentsSnapshot |
string |
Operator
Ein gültiger Vergleichsoperator, der verwendet werden soll. Für String PropertyType wird ein Vergleich ohne Beachtung der Groß-/Kleinschreibung angewendet.
Name | Typ | Beschreibung |
---|---|---|
Contains |
string |
Gilt nur für Nicht-Dezimalopernden |
EndsWith |
string |
Gilt nur für Nicht-Dezimalopernden |
Equals |
string |
Gilt für dezimale und nicht dezimale Operanden |
GreaterThan |
string |
Gilt nur für Dezimalopernden |
GreaterThanOrEqualTo |
string |
Gilt nur für Dezimalopernden |
LesserThan |
string |
Gilt nur für Dezimalopernden |
LesserThanOrEqualTo |
string |
Gilt nur für Dezimalopernden |
NotEquals |
string |
Gilt für dezimale und nicht dezimale Operanden |
StartsWith |
string |
Gilt nur für Nicht-Dezimalopernden |
PropertyType
Der Datentyp der verglichenen Operanden (String, Integer, Gleitkommazahl oder ein boolescher Wert [true/false]]
Name | Typ | Beschreibung |
---|---|---|
Boolean |
string |
|
Integer |
string |
|
Number |
string |
|
String |
string |