{ "swagger": "2.0", "info": { "title": "Security Insights", "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", "version": "2025-06-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { "get": { "x-ms-examples": { "Get all alert rules.": { "$ref": "./examples/alertRules/GetAllAlertRules.json" } }, "tags": [ "Alert Rules" ], "description": "Gets all alert rules.", "operationId": "AlertRules_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRulesList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { "get": { "x-ms-examples": { "Get a Scheduled alert rule.": { "$ref": "./examples/alertRules/GetScheduledAlertRule.json" }, "Get a Fusion alert rule.": { "$ref": "./examples/alertRules/GetFusionAlertRule.json" }, "Get a MicrosoftSecurityIncidentCreation rule.": { "$ref": "./examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json" } }, "tags": [ "Alert Rules" ], "description": "Gets the alert rule.", "operationId": "AlertRules_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } }, "put": { "x-ms-examples": { "Creates or updates a Scheduled alert rule.": { "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" }, "Creates or updates a Fusion alert rule.": { "$ref": "./examples/alertRules/CreateFusionAlertRule.json" }, "Creates or updates a MicrosoftSecurityIncidentCreation rule.": { "$ref": "./examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json" } }, "tags": [ "Alert Rules" ], "description": "Creates or updates the alert rule.", "operationId": "AlertRules_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" }, { "$ref": "#/parameters/AlertRule" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRule" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/AlertRule" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } }, "delete": { "x-ms-examples": { "Delete an alert rule.": { "$ref": "./examples/alertRules/DeleteAlertRule.json" } }, "tags": [ "Alert Rules" ], "description": "Delete the alert rule.", "operationId": "AlertRules_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" } ], "responses": { "200": { "description": "OK, Operation successfully completed" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions": { "get": { "x-ms-examples": { "Get all actions of alert rule.": { "$ref": "./examples/actions/GetAllActionsByAlertRule.json" } }, "tags": [ "Actions" ], "description": "Gets all actions of alert rule.", "operationId": "Actions_ListByAlertRule", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/ActionsList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}": { "get": { "x-ms-examples": { "Get an action of alert rule.": { "$ref": "./examples/actions/GetActionOfAlertRuleById.json" } }, "tags": [ "Actions" ], "description": "Gets the action of alert rule.", "operationId": "Actions_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" }, { "$ref": "#/parameters/ActionId" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/ActionResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } }, "put": { "x-ms-examples": { "Creates or updates an action of alert rule.": { "$ref": "./examples/actions/CreateActionOfAlertRule.json" } }, "tags": [ "Actions" ], "description": "Creates or updates the action of alert rule.", "operationId": "Actions_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" }, { "$ref": "#/parameters/ActionId" }, { "$ref": "#/parameters/Action" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/ActionResponse" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ActionResponse" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } }, "delete": { "x-ms-examples": { "Delete an action of alert rule.": { "$ref": "./examples/actions/DeleteActionOfAlertRule.json" } }, "tags": [ "Actions" ], "description": "Delete the action of alert rule.", "operationId": "Actions_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/RuleId" }, { "$ref": "#/parameters/ActionId" } ], "responses": { "200": { "description": "OK, Operation successfully completed" }, "204": { "description": "No Content" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates": { "get": { "x-ms-examples": { "Get all alert rule templates.": { "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplates.json" } }, "tags": [ "Alert Rule Templates" ], "description": "Gets all alert rule templates.", "operationId": "AlertRuleTemplates_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRuleTemplatesList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}": { "get": { "x-ms-examples": { "Get alert rule template by Id.": { "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplateById.json" } }, "tags": [ "Alert Rule Templates" ], "description": "Gets the alert rule template.", "operationId": "AlertRuleTemplates_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "./common/2.0/types.json#/parameters/WorkspaceName" }, { "$ref": "#/parameters/AlertRuleTemplateId" } ], "responses": { "200": { "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRuleTemplate" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./common/2.0/types.json#/definitions/CloudError" } } } } } }, "definitions": { "ActionsList": { "description": "List all the actions.", "properties": { "nextLink": { "description": "URL to fetch the next set of actions.", "readOnly": true, "type": "string" }, "value": { "description": "Array of actions.", "items": { "$ref": "#/definitions/ActionResponse" }, "type": "array", "x-ms-identifiers": [] } }, "type": "object", "required": [ "value" ] }, "ActionRequest": { "allOf": [ { "$ref": "./common/2.0/types.json#/definitions/ResourceWithEtag" } ], "description": "Action for alert rule.", "properties": { "properties": { "$ref": "#/definitions/ActionRequestProperties", "description": "Action properties for put request", "x-ms-client-flatten": true } }, "type": "object" }, "ActionRequestProperties": { "allOf": [ { "$ref": "#/definitions/ActionPropertiesBase" } ], "description": "Action property bag.", "properties": { "triggerUri": { "description": "Logic App Callback URL for this specific workflow.", "type": "string", "x-ms-secret": true } }, "required": [ "triggerUri" ], "type": "object" }, "ActionResponse": { "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "description": "Action for alert rule.", "properties": { "etag": { "description": "ETag of the action.", "type": "string" }, "properties": { "$ref": "#/definitions/ActionResponseProperties", "description": "Action properties for get request", "x-ms-client-flatten": true } }, "type": "object" }, "ActionResponseProperties": { "allOf": [ { "$ref": "#/definitions/ActionPropertiesBase" } ], "description": "Action property bag.", "properties": { "workflowId": { "description": "The name of the logic app's workflow.", "type": "string" } }, "type": "object" }, "ActionPropertiesBase": { "description": "Action property bag base.", "properties": { "logicAppResourceId": { "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", "type": "string" } }, "required": [ "logicAppResourceId" ], "type": "object" }, "AlertRule": { "allOf": [ { "$ref": "./common/2.0/types.json#/definitions/ResourceWithEtag" } ], "description": "Alert rule.", "discriminator": "kind", "required": [ "kind" ], "properties": { "kind": { "$ref": "#/definitions/AlertRuleKindEnum", "description": "The alert rule kind" } }, "type": "object" }, "AlertRuleKindEnum": { "description": "The kind of the alert rule", "enum": [ "Scheduled", "MicrosoftSecurityIncidentCreation", "Fusion" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AlertRuleKind", "values": [ { "value": "Scheduled" }, { "value": "MicrosoftSecurityIncidentCreation" }, { "value": "Fusion" } ] } }, "AlertRuleTemplate": { "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" } ], "description": "Alert rule template.", "discriminator": "kind", "required": [ "kind" ], "properties": { "kind": { "$ref": "#/definitions/AlertRuleKindEnum", "description": "The alert rule kind", "type": "string" } }, "type": "object" }, "AlertRuleTemplateDataSource": { "description": "alert rule template data sources", "properties": { "connectorId": { "description": "The connector id that provides the following data types", "type": "string" }, "dataTypes": { "description": "The data types used by the alert rule template", "items": { "type": "string" }, "type": "array", "x-ms-identifiers": [] } }, "type": "object" }, "AlertRuleTemplatePropertiesBase": { "description": "Base alert rule template property bag.", "properties": { "alertRulesCreatedByTemplateCount": { "description": "The number of alert rules that were created by this template", "format": "int32", "type": "integer" }, "createdDateUTC": { "description": "The time that this alert rule template has been added.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description of the alert rule template.", "type": "string" }, "displayName": { "description": "The display name for alert rule template.", "type": "string" }, "lastUpdatedDateUTC": { "description": "The last time that this alert rule template has been updated.", "format": "date-time", "readOnly": true, "type": "string" }, "requiredDataConnectors": { "description": "The required data sources for this template", "items": { "$ref": "#/definitions/AlertRuleTemplateDataSource" }, "type": "array", "x-ms-identifiers": [ "connectorId" ] }, "status": { "$ref": "#/definitions/AlertRuleTemplateStatus", "description": "The alert rule template status." } }, "type": "object" }, "AlertRuleTemplateStatus": { "description": "The alert rule template status.", "enum": [ "Installed", "Available", "NotAvailable" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "TemplateStatus", "values": [ { "description": "Alert rule template installed. and can not use more then once", "value": "Installed" }, { "description": "Alert rule template is available.", "value": "Available" }, { "description": "Alert rule template is not available", "value": "NotAvailable" } ] } }, "AlertRuleTriggerOperator": { "description": "The operation against the threshold that triggers alert rule.", "enum": [ "GreaterThan", "LessThan", "Equal", "NotEqual" ], "type": "string", "x-ms-enum": { "modelAsString": false, "name": "TriggerOperator" } }, "AlertRulesList": { "description": "List all the alert rules.", "properties": { "nextLink": { "description": "URL to fetch the next set of alert rules.", "readOnly": true, "type": "string" }, "value": { "description": "Array of alert rules.", "items": { "$ref": "#/definitions/AlertRule" }, "type": "array", "x-ms-identifiers": [] } }, "type": "object", "required": [ "value" ] }, "AlertRuleTemplatesList": { "description": "List all the alert rule templates.", "properties": { "nextLink": { "description": "URL to fetch the next set of alert rule templates.", "readOnly": true, "type": "string" }, "value": { "description": "Array of alert rule templates.", "items": { "$ref": "#/definitions/AlertRuleTemplate" }, "type": "array", "x-ms-identifiers": [] } }, "type": "object", "required": [ "value" ] }, "FusionAlertRule": { "allOf": [ { "$ref": "#/definitions/AlertRule" } ], "description": "Represents Fusion alert rule.", "properties": { "properties": { "$ref": "#/definitions/FusionAlertRuleProperties", "description": "Fusion alert rule properties", "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "Fusion" }, "FusionAlertRuleProperties": { "description": "Fusion alert rule base property bag.", "properties": { "alertRuleTemplateName": { "description": "The Name of the alert rule template used to create this rule.", "type": "string" }, "description": { "description": "The description of the alert rule.", "readOnly": true, "type": "string" }, "displayName": { "description": "The display name for alerts created by this alert rule.", "readOnly": true, "type": "string" }, "enabled": { "description": "Determines whether this alert rule is enabled or disabled.", "type": "boolean" }, "lastModifiedUtc": { "description": "The last time that this alert has been modified.", "format": "date-time", "readOnly": true, "type": "string" }, "severity": { "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", "description": "The severity for alerts created by this alert rule.", "readOnly": true }, "tactics": { "description": "The tactics of the alert rule", "items": { "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" }, "readOnly": true, "type": "array", "x-ms-identifiers": [] }, "techniques": { "description": "The techniques of the alert rule", "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "alertRuleTemplateName", "enabled" ], "type": "object" }, "FusionAlertRuleTemplate": { "allOf": [ { "$ref": "#/definitions/AlertRuleTemplate" } ], "description": "Represents Fusion alert rule template.", "properties": { "properties": { "$ref": "#/definitions/FusionAlertRuleTemplateProperties", "description": "Fusion alert rule template properties", "required": [ "displayName", "description", "status", "severity", "alertRulesCreatedByTemplateCount" ], "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "Fusion" }, "FusionAlertRuleTemplateProperties": { "description": "Represents Fusion alert rule template properties", "properties": { "alertRulesCreatedByTemplateCount": { "description": "The number of alert rules that were created by this template", "format": "int32", "type": "integer" }, "createdDateUTC": { "description": "The time that this alert rule template has been added.", "format": "date-time", "readOnly": true, "type": "string" }, "lastUpdatedDateUTC": { "description": "The time that this alert rule template was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description of the alert rule template.", "type": "string" }, "displayName": { "description": "The display name for alert rule template.", "type": "string" }, "requiredDataConnectors": { "description": "The required data connectors for this template", "items": { "$ref": "#/definitions/AlertRuleTemplateDataSource" }, "type": "array", "x-ms-identifiers": [] }, "status": { "$ref": "#/definitions/AlertRuleTemplateStatus", "description": "The alert rule template status.", "type": "string" }, "severity": { "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", "description": "The severity for alerts created by this alert rule." }, "tactics": { "description": "The tactics of the alert rule template", "items": { "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" }, "type": "array", "x-ms-identifiers": [] }, "techniques": { "description": "The techniques of the alert rule template", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "MicrosoftSecurityIncidentCreationAlertRule": { "allOf": [ { "$ref": "#/definitions/AlertRule" } ], "description": "Represents MicrosoftSecurityIncidentCreation rule.", "properties": { "properties": { "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", "description": "MicrosoftSecurityIncidentCreation rule properties", "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" }, "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { "description": "MicrosoftSecurityIncidentCreation rule common property bag.", "properties": { "displayNamesFilter": { "description": "the alerts' displayNames on which the cases will be generated", "items": { "type": "string" }, "type": "array", "x-ms-identifiers": [] }, "displayNamesExcludeFilter": { "description": "the alerts' displayNames on which the cases will not be generated", "items": { "type": "string" }, "type": "array", "x-ms-identifiers": [] }, "productFilter": { "$ref": "#/definitions/MicrosoftSecurityProductName", "description": "The alerts' productName on which the cases will be generated" }, "severitiesFilter": { "description": "the alerts' severities on which the cases will be generated", "items": { "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" }, "type": "array", "x-ms-identifiers": [] } }, "required": [ "productFilter" ], "type": "object" }, "MicrosoftSecurityIncidentCreationAlertRuleProperties": { "allOf": [ { "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" } ], "description": "MicrosoftSecurityIncidentCreation rule property bag.", "properties": { "alertRuleTemplateName": { "description": "The Name of the alert rule template used to create this rule.", "type": "string" }, "description": { "description": "The description of the alert rule.", "type": "string" }, "displayName": { "description": "The display name for alerts created by this alert rule.", "type": "string" }, "enabled": { "description": "Determines whether this alert rule is enabled or disabled.", "type": "boolean" }, "lastModifiedUtc": { "description": "The last time that this alert has been modified.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "displayName", "enabled", "productFilter" ], "type": "object" }, "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { "allOf": [ { "$ref": "#/definitions/AlertRuleTemplate" } ], "description": "Represents MicrosoftSecurityIncidentCreation rule template.", "properties": { "properties": { "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", "description": "MicrosoftSecurityIncidentCreation rule template properties", "required": [ "displayName", "description", "createdDateUTC", "status", "alertRulesCreatedByTemplateCount", "productFilter" ], "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" }, "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { "allOf": [ { "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" } ], "description": "MicrosoftSecurityIncidentCreation rule template properties", "properties": { "displayNamesFilter": { "description": "the alerts' displayNames on which the cases will be generated", "items": { "type": "string" }, "type": "array", "x-ms-identifiers": [] }, "displayNamesExcludeFilter": { "description": "the alerts' displayNames on which the cases will not be generated", "items": { "type": "string" }, "type": "array", "x-ms-identifiers": [] }, "productFilter": { "$ref": "#/definitions/MicrosoftSecurityProductName", "description": "The alerts' productName on which the cases will be generated" }, "severitiesFilter": { "description": "the alerts' severities on which the cases will be generated", "items": { "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" }, "type": "array", "x-ms-identifiers": [] } }, "type": "object" }, "MicrosoftSecurityProductName": { "description": "The alerts' productName on which the cases will be generated", "enum": [ "Microsoft Cloud App Security", "Azure Security Center", "Azure Advanced Threat Protection", "Azure Active Directory Identity Protection", "Azure Security Center for IoT" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MicrosoftSecurityProductName" } }, "ScheduledAlertRule": { "allOf": [ { "$ref": "#/definitions/AlertRule" } ], "description": "Represents scheduled alert rule.", "properties": { "properties": { "$ref": "#/definitions/ScheduledAlertRuleProperties", "description": "Scheduled alert rule properties", "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "Scheduled" }, "ScheduledAlertRuleCommonProperties": { "description": "Scheduled alert rule template property bag.", "properties": { "query": { "description": "The query that creates alerts for this rule.", "type": "string" }, "queryFrequency": { "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", "format": "duration", "type": "string" }, "queryPeriod": { "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", "format": "duration", "type": "string" }, "severity": { "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", "description": "The severity for alerts created by this alert rule." }, "triggerOperator": { "$ref": "#/definitions/AlertRuleTriggerOperator", "description": "The operation against the threshold that triggers alert rule." }, "triggerThreshold": { "description": "The threshold triggers this alert rule.", "format": "int32", "type": "integer" }, "eventGroupingSettings": { "$ref": "#/definitions/EventGroupingSettings", "description": "The event grouping settings." }, "customDetails": { "description": "Dictionary of string key-value pairs of columns to be attached to the alert", "type": "object", "additionalProperties": { "type": "string" } }, "entityMappings": { "$ref": "#/definitions/EntityMappings", "description": "Array of the entity mappings of the alert rule" }, "alertDetailsOverride": { "type": "object", "$ref": "#/definitions/AlertDetailsOverride", "description": "The alert details override settings" } }, "type": "object" }, "EventGroupingSettings": { "description": "Event grouping settings property bag.", "properties": { "aggregationKind": { "$ref": "#/definitions/EventGroupingAggregationKind" } }, "type": "object" }, "EventGroupingAggregationKind": { "description": "The event grouping aggregation kinds", "enum": [ "SingleAlert", "AlertPerResult" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "EventGroupingAggregationKind" } }, "EntityMappings": { "description": "List of entity mappings of the alert rule", "type": "array", "items": { "$ref": "#/definitions/EntityMapping" }, "x-ms-identifiers": [] }, "EntityMapping": { "description": "Single entity mapping for the alert rule", "properties": { "entityType": { "$ref": "#/definitions/EntityMappingType" }, "fieldMappings": { "description": "array of field mappings for the given entity mapping", "type": "array", "items": { "$ref": "#/definitions/FieldMapping" }, "x-ms-identifiers": [] } }, "type": "object" }, "FieldMapping": { "description": "A single field mapping of the mapped entity", "properties": { "identifier": { "description": "the V3 identifier of the entity", "type": "string" }, "columnName": { "description": "the column name to be mapped to the identifier", "type": "string" } }, "type": "object" }, "AlertDetailsOverride": { "description": "Settings for how to dynamically override alert static details", "properties": { "alertDisplayNameFormat": { "description": "the format containing columns name(s) to override the alert name", "type": "string" }, "alertDescriptionFormat": { "description": "the format containing columns name(s) to override the alert description", "type": "string" }, "alertTacticsColumnName": { "description": "the column name to take the alert tactics from", "type": "string" }, "alertSeverityColumnName": { "description": "the column name to take the alert severity from", "type": "string" }, "alertDynamicProperties": { "description": "List of additional dynamic properties to override", "type": "array", "items": { "$ref": "#/definitions/AlertPropertyMapping" }, "x-ms-identifiers": [] } }, "type": "object" }, "AlertPropertyMapping": { "description": "A single alert property mapping to override", "properties": { "alertProperty": { "$ref": "#/definitions/AlertProperty" }, "value": { "description": "the column name to use to override this property", "type": "string" } }, "type": "object" }, "IncidentConfiguration": { "description": "Incident Configuration property bag.", "properties": { "createIncident": { "description": "Create incidents from alerts triggered by this analytics rule", "type": "boolean" }, "groupingConfiguration": { "$ref": "#/definitions/GroupingConfiguration", "description": "Set how the alerts that are triggered by this analytics rule, are grouped into incidents" } }, "type": "object", "required": [ "createIncident" ] }, "GroupingConfiguration": { "description": "Grouping configuration property bag.", "properties": { "enabled": { "description": "Grouping enabled", "type": "boolean" }, "reopenClosedIncident": { "description": "Re-open closed matching incidents", "type": "boolean" }, "lookbackDuration": { "description": "Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)", "format": "duration", "type": "string" }, "matchingMethod": { "description": "Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.", "enum": [ "AllEntities", "AnyAlert", "Selected" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "MatchingMethod", "values": [ { "description": "Grouping alerts into a single incident if all the entities match", "value": "AllEntities" }, { "description": "Grouping any alerts triggered by this rule into a single incident", "value": "AnyAlert" }, { "description": "Grouping alerts into a single incident if the selected entities, custom details and alert details match", "value": "Selected" } ] } }, "groupByEntities": { "description": "A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.", "items": { "$ref": "#/definitions/EntityMappingType" }, "type": "array", "x-ms-identifiers": [] }, "groupByAlertDetails": { "description": "A list of alert details to group by (when matchingMethod is Selected)", "items": { "description": "Alert detail", "enum": [ "DisplayName", "Severity" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AlertDetail", "values": [ { "description": "Alert display name", "value": "DisplayName" }, { "description": "Alert severity", "value": "Severity" } ] } }, "type": "array", "x-ms-identifiers": [] }, "groupByCustomDetails": { "description": "A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.", "items": { "type": "string" }, "type": "array", "x-ms-identifiers": [] } }, "type": "object", "required": [ "enabled", "reopenClosedIncident", "lookbackDuration", "matchingMethod" ] }, "ScheduledAlertRuleProperties": { "allOf": [ { "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" } ], "description": "Scheduled alert rule base property bag.", "properties": { "alertRuleTemplateName": { "description": "The Name of the alert rule template used to create this rule.", "type": "string" }, "templateVersion": { "description": "The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>", "type": "string" }, "description": { "description": "The description of the alert rule.", "type": "string" }, "displayName": { "description": "The display name for alerts created by this alert rule.", "type": "string" }, "enabled": { "description": "Determines whether this alert rule is enabled or disabled.", "type": "boolean" }, "lastModifiedUtc": { "description": "The last time that this alert rule has been modified.", "format": "date-time", "readOnly": true, "type": "string" }, "suppressionDuration": { "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", "format": "duration", "type": "string" }, "suppressionEnabled": { "description": "Determines whether the suppression for this alert rule is enabled or disabled.", "type": "boolean" }, "tactics": { "description": "The tactics of the alert rule", "items": { "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" }, "type": "array", "x-ms-identifiers": [] }, "techniques": { "description": "The techniques of the alert rule", "items": { "type": "string" }, "type": "array" }, "incidentConfiguration": { "$ref": "#/definitions/IncidentConfiguration", "description": "The settings of the incidents that created from alerts triggered by this analytics rule" } }, "required": [ "displayName", "enabled", "severity", "query", "queryFrequency", "queryPeriod", "triggerOperator", "triggerThreshold", "suppressionEnabled", "suppressionDuration" ], "type": "object" }, "ScheduledAlertRuleTemplateProperties": { "description": "Scheduled alert rule template properties", "properties": { "alertRulesCreatedByTemplateCount": { "description": "The number of alert rules that were created by this template", "format": "int32", "type": "integer" }, "createdDateUTC": { "description": "The time that this alert rule template has been added.", "format": "date-time", "readOnly": true, "type": "string" }, "lastUpdatedDateUTC": { "description": "The time that this alert rule template was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "description": { "description": "The description of the alert rule template.", "type": "string" }, "displayName": { "description": "The display name for alert rule template.", "type": "string" }, "requiredDataConnectors": { "description": "The required data connectors for this template", "items": { "$ref": "#/definitions/AlertRuleTemplateDataSource" }, "type": "array", "x-ms-identifiers": [] }, "status": { "$ref": "#/definitions/AlertRuleTemplateStatus", "description": "The alert rule template status.", "type": "string" }, "query": { "description": "The query that creates alerts for this rule.", "type": "string" }, "queryFrequency": { "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", "format": "duration", "type": "string" }, "queryPeriod": { "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", "format": "duration", "type": "string" }, "severity": { "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", "description": "The severity for alerts created by this alert rule." }, "triggerOperator": { "$ref": "#/definitions/AlertRuleTriggerOperator", "description": "The operation against the threshold that triggers alert rule." }, "triggerThreshold": { "description": "The threshold triggers this alert rule.", "format": "int32", "type": "integer" }, "tactics": { "description": "The tactics of the alert rule template", "items": { "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" }, "type": "array", "x-ms-identifiers": [] }, "techniques": { "description": "The techniques of the alert rule template", "items": { "type": "string" }, "type": "array" }, "version": { "description": "The version of this template - in format , where all are numbers. For example <1.0.2>.", "type": "string" }, "eventGroupingSettings": { "$ref": "#/definitions/EventGroupingSettings", "description": "The event grouping settings." }, "customDetails": { "description": "Dictionary of string key-value pairs of columns to be attached to the alert", "type": "object", "additionalProperties": { "type": "string" } }, "entityMappings": { "$ref": "#/definitions/EntityMappings", "description": "Array of the entity mappings of the alert rule" }, "alertDetailsOverride": { "type": "object", "$ref": "#/definitions/AlertDetailsOverride", "description": "The alert details override settings" } }, "type": "object" }, "ScheduledAlertRuleTemplate": { "allOf": [ { "$ref": "#/definitions/AlertRuleTemplate" } ], "description": "Represents scheduled alert rule template.", "properties": { "properties": { "$ref": "#/definitions/ScheduledAlertRuleTemplateProperties", "description": "Scheduled alert rule template properties", "required": [ "displayName", "description", "status", "alertRulesCreatedByTemplateCount", "severity", "query", "queryFrequency", "queryPeriod", "triggerOperator", "triggerThreshold", "version" ], "type": "object", "x-ms-client-flatten": true } }, "type": "object", "x-ms-discriminator-value": "Scheduled" }, "EntityMappingType": { "description": "The V3 type of the mapped entity", "enum": [ "Account", "Host", "IP", "Malware", "File", "Process", "CloudApplication", "DNS", "AzureResource", "FileHash", "RegistryKey", "RegistryValue", "SecurityGroup", "URL", "Mailbox", "MailCluster", "MailMessage", "SubmissionMail" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "EntityMappingType", "values": [ { "description": "User account entity type", "value": "Account" }, { "description": "Host entity type", "value": "Host" }, { "description": "IP address entity type", "value": "IP" }, { "description": "Malware entity type", "value": "Malware" }, { "description": "System file entity type", "value": "File" }, { "description": "Process entity type", "value": "Process" }, { "description": "Cloud app entity type", "value": "CloudApplication" }, { "description": "DNS entity type", "value": "DNS" }, { "description": "Azure resource entity type", "value": "AzureResource" }, { "description": "File-hash entity type", "value": "FileHash" }, { "description": "Registry key entity type", "value": "RegistryKey" }, { "description": "Registry value entity type", "value": "RegistryValue" }, { "description": "Security group entity type", "value": "SecurityGroup" }, { "description": "URL entity type", "value": "URL" }, { "description": "Mailbox entity type", "value": "Mailbox" }, { "description": "Mail cluster entity type", "value": "MailCluster" }, { "description": "Mail message entity type", "value": "MailMessage" }, { "description": "Submission mail entity type", "value": "SubmissionMail" } ] } }, "AlertProperty": { "description": "The V3 alert property", "enum": [ "AlertLink", "ConfidenceLevel", "ConfidenceScore", "ExtendedLinks", "ProductName", "ProviderName", "ProductComponentName", "RemediationSteps", "Techniques" ], "type": "string", "x-ms-enum": { "modelAsString": true, "name": "AlertProperty", "values": [ { "description": "Alert's link", "value": "AlertLink" }, { "description": "Confidence level property", "value": "ConfidenceLevel" }, { "description": "Confidence score", "value": "ConfidenceScore" }, { "description": "Extended links to the alert", "value": "ExtendedLinks" }, { "description": "Product name alert property", "value": "ProductName" }, { "description": "Provider name alert property", "value": "ProviderName" }, { "description": "Product component name alert property", "value": "ProductComponentName" }, { "description": "Remediation steps alert property", "value": "RemediationSteps" }, { "description": "Techniques alert property", "value": "Techniques" } ] } } }, "parameters": { "Action": { "description": "The action", "in": "body", "name": "action", "required": true, "schema": { "$ref": "#/definitions/ActionRequest" }, "x-ms-parameter-location": "method" }, "ActionId": { "description": "Action ID", "in": "path", "name": "actionId", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "AlertRule": { "description": "The alert rule", "in": "body", "name": "alertRule", "required": true, "schema": { "$ref": "#/definitions/AlertRule" }, "x-ms-parameter-location": "method" }, "AlertRuleTemplateId": { "description": "Alert rule template ID", "in": "path", "name": "alertRuleTemplateId", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "RuleId": { "description": "Alert rule ID", "in": "path", "name": "ruleId", "required": true, "type": "string", "x-ms-parameter-location": "method" } } }