Automation rules - 2023-03-01-preview - add entity trigger API (#22523)

Author: loriatarms

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-03-01-preview/AutomationRules.json

@@ -217,6 +217,66 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityIdentifier}/runPlaybook": {
+      "post": {
+        "tags": [
+          "manualTrigger"
+        ],
+        "description": "Triggers playbook on a specific entity.",
+        "operationId": "Entities_RunPlaybook",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName"
+          },
+          {
+            "in": "path",
+            "name": "entityIdentifier",
+            "description": "Entity identifier.",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "in": "body",
+            "name": "requestBody",
+            "description": "Describes the request body for triggering a playbook on an entity.",
+            "schema": {
+              "$ref": "#/definitions/EntityManualTriggerRequestBody"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../common/2.0/types.json#/definitions/CloudError"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Entities_RunPlaybook": {
+            "$ref": "./examples/manualTrigger/Entities_RunPlaybook.json"
+          }
+        }
+      }
+    },
     "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook": {
       "post": {
         "tags": [
@@ -1183,6 +1243,28 @@
         ]
       }
     },
+    "EntityManualTriggerRequestBody": {
+      "type": "object",
+      "description": "Describes the request body for triggering a playbook on an entity.",
+      "required": [
+        "logicAppsResourceId"
+      ],
+      "properties": {
+        "incidentArmId": {
+          "type": "string",
+          "description": "Incident ARM id."
+        },
+        "tenantId": {
+          "format": "uuid",
+          "type": "string",
+          "description": "The tenant id of the playbook resource."
+        },
+        "logicAppsResourceId": {
+          "type": "string",
+          "description": "The resource id of the playbook resource."
+        }
+      }
+    },
     "IncidentPropertiesAction": {
       "type": "object",
       "properties": {
@@ -1234,6 +1316,9 @@
     },
     "PlaybookActionProperties": {
       "type": "object",
+      "required": [
+        "logicAppResourceId"
+      ],
       "properties": {
         "logicAppResourceId": {
           "description": "The resource id of the playbook resource.",

specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-03-01-preview/examples/manualTrigger/Entities_RunPlaybook.json

@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "api-version": "2023-03-01-preview",
+    "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0",
+    "resourceGroupName": "myRg",
+    "workspaceName": "myWorkspace",
+    "entityIdentifier": "72e01a22-5cd2-4139-a149-9f2736ff2ar2",
+    "manualTriggerRequestBody": {
+      "logicAppsResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/my-playbook-name",
+      "tenantId": "qwere6b2-9ac0-4464-9919-dccaee2e4ddd",
+      "incidentArmId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5"
+    }
+  },
+  "responses": {
+    "204": {}
+  }
+}