Microsoft.Synapse workspaces/securityAlertPolicies

Bicep resource definition

The workspaces/securityAlertPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/securityAlertPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    disabledAlerts: [
      'string'
    ]
    emailAccountAdmins: bool
    emailAddresses: [
      'string'
    ]
    retentionDays: int
    state: 'string'
    storageAccountAccessKey: 'string'
    storageEndpoint: 'string'
  }
}

Property Values

Microsoft.Synapse/workspaces/securityAlertPolicies

Name	Description	Value
name	The resource name	'Default' (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: workspaces
properties	Resource properties.	ServerSecurityAlertPolicyProperties

ServerSecurityAlertPolicyProperties

Name	Description	Value
disabledAlerts	Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action	string[]
emailAccountAdmins	Specifies that the alert is sent to the account administrators.	bool
emailAddresses	Specifies an array of e-mail addresses to which the alert is sent.	string[]
retentionDays	Specifies the number of days to keep in the Threat Detection audit logs.	int
state	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific server	'Disabled' 'Enabled' 'New' (required)
storageAccountAccessKey	Specifies the identifier key of the Threat Detection audit storage account.	string
storageEndpoint	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.	string

ARM template resource definition

The workspaces/securityAlertPolicies resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/securityAlertPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/workspaces/securityAlertPolicies",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "disabledAlerts": [ "string" ],
    "emailAccountAdmins": "bool",
    "emailAddresses": [ "string" ],
    "retentionDays": "int",
    "state": "string",
    "storageAccountAccessKey": "string",
    "storageEndpoint": "string"
  }
}

Property Values

Microsoft.Synapse/workspaces/securityAlertPolicies

Name	Description	Value
apiVersion	The api version	'2021-06-01'
name	The resource name	'Default' (required)
properties	Resource properties.	ServerSecurityAlertPolicyProperties
type	The resource type	'Microsoft.Synapse/workspaces/securityAlertPolicies'

ServerSecurityAlertPolicyProperties

Name	Description	Value
disabledAlerts	Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action	string[]
emailAccountAdmins	Specifies that the alert is sent to the account administrators.	bool
emailAddresses	Specifies an array of e-mail addresses to which the alert is sent.	string[]
retentionDays	Specifies the number of days to keep in the Threat Detection audit logs.	int
state	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific server	'Disabled' 'Enabled' 'New' (required)
storageAccountAccessKey	Specifies the identifier key of the Threat Detection audit storage account.	string
storageEndpoint	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.	string

Usage Examples

Terraform (AzAPI provider) resource definition

The workspaces/securityAlertPolicies resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Synapse/workspaces/securityAlertPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01"
  name = "string"
  body = {
    properties = {
      disabledAlerts = [
        "string"
      ]
      emailAccountAdmins = bool
      emailAddresses = [
        "string"
      ]
      retentionDays = int
      state = "string"
      storageAccountAccessKey = "string"
      storageEndpoint = "string"
    }
  }
}

Property Values

Microsoft.Synapse/workspaces/securityAlertPolicies

Name	Description	Value
name	The resource name	'Default' (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: workspaces
properties	Resource properties.	ServerSecurityAlertPolicyProperties
type	The resource type	"Microsoft.Synapse/workspaces/securityAlertPolicies@2021-06-01"

ServerSecurityAlertPolicyProperties

Name	Description	Value
disabledAlerts	Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action	string[]
emailAccountAdmins	Specifies that the alert is sent to the account administrators.	bool
emailAddresses	Specifies an array of e-mail addresses to which the alert is sent.	string[]
retentionDays	Specifies the number of days to keep in the Threat Detection audit logs.	int
state	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific server	'Disabled' 'Enabled' 'New' (required)
storageAccountAccessKey	Specifies the identifier key of the Threat Detection audit storage account.	string
storageEndpoint	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.	string