Alerts - Simulate

Simulate security alerts

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/alerts/default/simulate?api-version=2022-01-01

URI Parameters

Name In Required Type Description
ascLocation
path True

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

subscriptionId
path True

string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

API version for the operation

Request Body

Name Type Description
properties AlertSimulatorRequestProperties:

AlertSimulatorBundlesRequestProperties

Alert Simulator request body data.

Responses

Name Type Description
202 Accepted

Accepted

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Simulate security alerts on a subscription

Sample request

POST https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/centralus/alerts/default/simulate?api-version=2022-01-01

{
  "properties": {
    "kind": "Bundles",
    "bundles": [
      "AppServices",
      "DNS",
      "KeyVaults",
      "KubernetesService",
      "ResourceManager",
      "SqlServers",
      "StorageAccounts",
      "VirtualMachines",
      "CosmosDbs"
    ]
  }
}

Sample response

Definitions

Name Description
AlertSimulatorBundlesRequestProperties

Simulate alerts according to this bundles.

AlertSimulatorRequestBody

Alert Simulator request body.

BundleType

Alert Simulator supported bundles.

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

CloudErrorBody

The error detail.

ErrorAdditionalInfo

The resource management error additional info.

AlertSimulatorBundlesRequestProperties

Simulate alerts according to this bundles.

Name Type Description
bundles

BundleType[]

Bundles list.

kind string:

Bundles

The kind of alert simulation.

AlertSimulatorRequestBody

Alert Simulator request body.

Name Type Description
properties AlertSimulatorRequestProperties:

AlertSimulatorBundlesRequestProperties

Alert Simulator request body data.

BundleType

Alert Simulator supported bundles.

Name Type Description
AppServices

string

CosmosDbs

string

DNS

string

KeyVaults

string

KubernetesService

string

ResourceManager

string

SqlServers

string

StorageAccounts

string

VirtualMachines

string

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name Type Description
error.additionalInfo

ErrorAdditionalInfo[]

The error additional info.

error.code

string

The error code.

error.details

CloudErrorBody[]

The error details.

error.message

string

The error message.

error.target

string

The error target.

CloudErrorBody

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

CloudErrorBody[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.