Partager via

Incidents - Run Playbook

  • Référence
Service:
Sentinel
Version d'API:
2024-03-01

Déclenche le playbook sur un incident spécifique

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

Paramètres URI

Nom Dans Obligatoire Type Description
incidentIdentifier
 path True

string

ID de l'incident
resourceGroupName
 path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

uuid

ID de l’abonnement cible. La valeur doit être un UUID.
workspaceName
 path True

string

Nom de l’espace de travail.

Modèle d’expression régulière: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
requestBody

ManualTriggerRequestBody

Décrit le corps de la demande pour déclencher un playbook sur un incident.

Réponses

Nom Type Description
204 No Content

Succès
Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

Incidents_RunPlaybook

Exemple de requête

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

Exemple de réponse

Code d’état:
204

Définitions

Nom Description
CloudError

Structure de réponse d’erreur.
CloudErrorBody

Détails de l’erreur.
ManualTriggerRequestBody

Décrit le corps de la demande pour déclencher un playbook sur un incident.

CloudError

Structure de réponse d’erreur.

Nom Type Description
error

CloudErrorBody

Données d’erreur

CloudErrorBody

Détails de l’erreur.

Nom Type Description
code

string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message

string

Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

ManualTriggerRequestBody

Décrit le corps de la demande pour déclencher un playbook sur un incident.

Nom Type Description
logicAppsResourceId

string

ID de ressource de la ressource de playbook.
tenantId

string

ID de locataire de la ressource de playbook.