Microsoft.Sql servers/securityAlertPolicies template reference

Template format

To create a Microsoft.Sql/servers/securityAlertPolicies resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Sql/servers/securityAlertPolicies",
  "apiVersion": "2017-03-01-preview",
  "properties": {
    "state": "string",
    "disabledAlerts": [
      "string"
    ],
    "emailAddresses": [
      "string"
    ],
    "emailAccountAdmins": "boolean",
    "storageEndpoint": "string",
    "storageAccountAccessKey": "string",
    "retentionDays": "integer"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Sql/servers/securityAlertPolicies object

Name Type Required Value
name string Yes The name of the security alert policy.
type enum Yes securityAlertPolicies
-or-
Microsoft.Sql/servers/securityAlertPolicies

See Set name and type for child resources.
apiVersion enum Yes 2017-03-01-preview
properties object Yes Resource properties. - SecurityAlertPolicyProperties object

SecurityAlertPolicyProperties object

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Deploy
SQL logical server.