Incidents - Run Playbook

Dienst:

Sentinel

API-Version:

2024-03-01

Löst Playbook für einen bestimmten Vorfall aus

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook?api-version=2024-03-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
incidentIdentifier	path	True	string	Incident-ID
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string uuid	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceName	path	True	string	Den Namen des Arbeitsbereichs RegEx-Muster: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
requestBody	ManualTriggerRequestBody	Beschreibt den Anforderungstext zum Auslösen eines Playbooks für einen Incident.

Antworten

Name	Typ	Beschreibung
204 No Content		Erfolg
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

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

Incidents_RunPlaybook

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ar4/runPlaybook?api-version=2024-03-01

Beispiel für eine Antwort

Statuscode:

204

Definitionen

Name	Beschreibung
CloudError	Fehlerantwortstruktur.
CloudErrorBody	Fehlerdetails.
ManualTriggerRequestBody	Beschreibt den Anforderungstext zum Auslösen eines Playbooks für einen Incident.

CloudError

Fehlerantwortstruktur.

Name	Typ	Beschreibung
error	CloudErrorBody	Fehlerdaten

CloudErrorBody

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet sein soll.

ManualTriggerRequestBody

Beschreibt den Anforderungstext zum Auslösen eines Playbooks für einen Incident.

Name	Typ	Beschreibung
logicAppsResourceId	string	Die Ressourcen-ID der Playbookressource.
tenantId	string	Die Mandanten-ID der Playbookressource.