Azure v6.22.1, May 12 25

We recommend using Azure Native.

Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi

pulumi/pulumi-azure

azure.synapse.SqlPoolSecurityAlertPolicy

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi

pulumi/pulumi-azure

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplestorageacc
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      isHnsEnabled: 'true'
  exampleDataLakeGen2Filesystem:
    type: azure:storage:DataLakeGen2Filesystem
    name: example
    properties:
      name: example
      storageAccountId: ${exampleAccount.id}
  exampleWorkspace:
    type: azure:synapse:Workspace
    name: example
    properties:
      name: example
      resourceGroupName: ${example.name}
      location: ${example.location}
      storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
      sqlAdministratorLogin: sqladminuser
      sqlAdministratorLoginPassword: H@Sh1CoR3!
      aadAdmin:
        - login: AzureAD Admin
          objectId: 00000000-0000-0000-0000-000000000000
          tenantId: 00000000-0000-0000-0000-000000000000
      identity:
        type: SystemAssigned
      tags:
        Env: production
  exampleSqlPool:
    type: azure:synapse:SqlPool
    name: example
    properties:
      name: examplesqlpool
      synapseWorkspaceId: ${exampleWorkspace.id}
      skuName: DW100c
      createMode: Default
  auditLogs:
    type: azure:storage:Account
    name: audit_logs
    properties:
      name: examplesa
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleSqlPoolSecurityAlertPolicy:
    type: azure:synapse:SqlPoolSecurityAlertPolicy
    name: example
    properties:
      sqlPoolId: ${exampleSqlPool.id}
      policyState: Enabled
      storageEndpoint: ${auditLogs.primaryBlobEndpoint}
      storageAccountAccessKey: ${auditLogs.primaryAccessKey}
      disabledAlerts:
        - Sql_Injection
        - Data_Exfiltration
      retentionDays: 20

Create SqlPoolSecurityAlertPolicy Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SqlPoolSecurityAlertPolicy(name: string, args: SqlPoolSecurityAlertPolicyArgs, opts?: CustomResourceOptions);

@overload
def SqlPoolSecurityAlertPolicy(resource_name: str,
                               args: SqlPoolSecurityAlertPolicyArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def SqlPoolSecurityAlertPolicy(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               policy_state: Optional[str] = None,
                               sql_pool_id: Optional[str] = None,
                               disabled_alerts: Optional[Sequence[str]] = None,
                               email_account_admins_enabled: Optional[bool] = None,
                               email_addresses: Optional[Sequence[str]] = None,
                               retention_days: Optional[int] = None,
                               storage_account_access_key: Optional[str] = None,
                               storage_endpoint: Optional[str] = None)

func NewSqlPoolSecurityAlertPolicy(ctx *Context, name string, args SqlPoolSecurityAlertPolicyArgs, opts ...ResourceOption) (*SqlPoolSecurityAlertPolicy, error)

public SqlPoolSecurityAlertPolicy(string name, SqlPoolSecurityAlertPolicyArgs args, CustomResourceOptions? opts = null)

public SqlPoolSecurityAlertPolicy(String name, SqlPoolSecurityAlertPolicyArgs args)
public SqlPoolSecurityAlertPolicy(String name, SqlPoolSecurityAlertPolicyArgs args, CustomResourceOptions options)

type: azure:synapse:SqlPoolSecurityAlertPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SqlPoolSecurityAlertPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SqlPoolSecurityAlertPolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SqlPoolSecurityAlertPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SqlPoolSecurityAlertPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SqlPoolSecurityAlertPolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sqlPoolSecurityAlertPolicyResource = new Azure.Synapse.SqlPoolSecurityAlertPolicy("sqlPoolSecurityAlertPolicyResource", new()
{
    PolicyState = "string",
    SqlPoolId = "string",
    DisabledAlerts = new[]
    {
        "string",
    },
    EmailAccountAdminsEnabled = false,
    EmailAddresses = new[]
    {
        "string",
    },
    RetentionDays = 0,
    StorageAccountAccessKey = "string",
    StorageEndpoint = "string",
});

example, err := synapse.NewSqlPoolSecurityAlertPolicy(ctx, "sqlPoolSecurityAlertPolicyResource", &synapse.SqlPoolSecurityAlertPolicyArgs{
	PolicyState: pulumi.String("string"),
	SqlPoolId:   pulumi.String("string"),
	DisabledAlerts: pulumi.StringArray{
		pulumi.String("string"),
	},
	EmailAccountAdminsEnabled: pulumi.Bool(false),
	EmailAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetentionDays:           pulumi.Int(0),
	StorageAccountAccessKey: pulumi.String("string"),
	StorageEndpoint:         pulumi.String("string"),
})

var sqlPoolSecurityAlertPolicyResource = new SqlPoolSecurityAlertPolicy("sqlPoolSecurityAlertPolicyResource", SqlPoolSecurityAlertPolicyArgs.builder()
    .policyState("string")
    .sqlPoolId("string")
    .disabledAlerts("string")
    .emailAccountAdminsEnabled(false)
    .emailAddresses("string")
    .retentionDays(0)
    .storageAccountAccessKey("string")
    .storageEndpoint("string")
    .build());

sql_pool_security_alert_policy_resource = azure.synapse.SqlPoolSecurityAlertPolicy("sqlPoolSecurityAlertPolicyResource",
    policy_state="string",
    sql_pool_id="string",
    disabled_alerts=["string"],
    email_account_admins_enabled=False,
    email_addresses=["string"],
    retention_days=0,
    storage_account_access_key="string",
    storage_endpoint="string")

const sqlPoolSecurityAlertPolicyResource = new azure.synapse.SqlPoolSecurityAlertPolicy("sqlPoolSecurityAlertPolicyResource", {
    policyState: "string",
    sqlPoolId: "string",
    disabledAlerts: ["string"],
    emailAccountAdminsEnabled: false,
    emailAddresses: ["string"],
    retentionDays: 0,
    storageAccountAccessKey: "string",
    storageEndpoint: "string",
});

type: azure:synapse:SqlPoolSecurityAlertPolicy
properties:
    disabledAlerts:
        - string
    emailAccountAdminsEnabled: false
    emailAddresses:
        - string
    policyState: string
    retentionDays: 0
    sqlPoolId: string
    storageAccountAccessKey: string
    storageEndpoint: string

SqlPoolSecurityAlertPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SqlPoolSecurityAlertPolicy resource accepts the following input properties:

PolicyState string: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
SqlPoolId string: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
DisabledAlerts List<string>: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
EmailAccountAdminsEnabled bool: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
EmailAddresses List<string>: Specifies an array of email addresses to which the alert is sent.
RetentionDays int: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
StorageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
StorageEndpoint string: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

PolicyState string: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
SqlPoolId string: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
DisabledAlerts []string: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
EmailAccountAdminsEnabled bool: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
EmailAddresses []string: Specifies an array of email addresses to which the alert is sent.
RetentionDays int: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
StorageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
StorageEndpoint string: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

policyState String: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
sqlPoolId String: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
disabledAlerts List<String>: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdminsEnabled Boolean: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
emailAddresses List<String>: Specifies an array of email addresses to which the alert is sent.
retentionDays Integer: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
storageAccountAccessKey String: Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint String: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

policyState string: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
sqlPoolId string: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
disabledAlerts string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdminsEnabled boolean: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
emailAddresses string[]: Specifies an array of email addresses to which the alert is sent.
retentionDays number: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
storageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint string: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

policy_state str: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
sql_pool_id str: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
disabled_alerts Sequence[str]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
email_account_admins_enabled bool: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
email_addresses Sequence[str]: Specifies an array of email addresses to which the alert is sent.
retention_days int: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
storage_account_access_key str: Specifies the identifier key of the Threat Detection audit storage account.
storage_endpoint str: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

policyState String: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
sqlPoolId String: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
disabledAlerts List<String>: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdminsEnabled Boolean: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
emailAddresses List<String>: Specifies an array of email addresses to which the alert is sent.
retentionDays Number: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
storageAccountAccessKey String: Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint String: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

Outputs

All input properties are implicitly available as output properties. Additionally, the SqlPoolSecurityAlertPolicy resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing SqlPoolSecurityAlertPolicy Resource

Get an existing SqlPoolSecurityAlertPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SqlPoolSecurityAlertPolicyState, opts?: CustomResourceOptions): SqlPoolSecurityAlertPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        disabled_alerts: Optional[Sequence[str]] = None,
        email_account_admins_enabled: Optional[bool] = None,
        email_addresses: Optional[Sequence[str]] = None,
        policy_state: Optional[str] = None,
        retention_days: Optional[int] = None,
        sql_pool_id: Optional[str] = None,
        storage_account_access_key: Optional[str] = None,
        storage_endpoint: Optional[str] = None) -> SqlPoolSecurityAlertPolicy

func GetSqlPoolSecurityAlertPolicy(ctx *Context, name string, id IDInput, state *SqlPoolSecurityAlertPolicyState, opts ...ResourceOption) (*SqlPoolSecurityAlertPolicy, error)

public static SqlPoolSecurityAlertPolicy Get(string name, Input<string> id, SqlPoolSecurityAlertPolicyState? state, CustomResourceOptions? opts = null)

public static SqlPoolSecurityAlertPolicy get(String name, Output<String> id, SqlPoolSecurityAlertPolicyState state, CustomResourceOptions options)

resources:  _:    type: azure:synapse:SqlPoolSecurityAlertPolicy    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DisabledAlerts List<string>: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
EmailAccountAdminsEnabled bool: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
EmailAddresses List<string>: Specifies an array of email addresses to which the alert is sent.
PolicyState string: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
RetentionDays int: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
SqlPoolId string: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
StorageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
StorageEndpoint string: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

DisabledAlerts []string: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
EmailAccountAdminsEnabled bool: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
EmailAddresses []string: Specifies an array of email addresses to which the alert is sent.
PolicyState string: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
RetentionDays int: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
SqlPoolId string: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
StorageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
StorageEndpoint string: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

disabledAlerts List<String>: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdminsEnabled Boolean: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
emailAddresses List<String>: Specifies an array of email addresses to which the alert is sent.
policyState String: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
retentionDays Integer: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
sqlPoolId String: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
storageAccountAccessKey String: Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint String: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

disabledAlerts string[]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdminsEnabled boolean: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
emailAddresses string[]: Specifies an array of email addresses to which the alert is sent.
policyState string: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
retentionDays number: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
sqlPoolId string: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
storageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint string: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

disabled_alerts Sequence[str]: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
email_account_admins_enabled bool: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
email_addresses Sequence[str]: Specifies an array of email addresses to which the alert is sent.
policy_state str: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
retention_days int: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
sql_pool_id str: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
storage_account_access_key str: Specifies the identifier key of the Threat Detection audit storage account.
storage_endpoint str: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

disabledAlerts List<String>: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdminsEnabled Boolean: Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to false.
emailAddresses List<String>: Specifies an array of email addresses to which the alert is sent.
policyState String: Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific SQL pool. Possible values are Disabled, Enabled and New.
retentionDays Number: Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
sqlPoolId String: Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
storageAccountAccessKey String: Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint String: Specifies the blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

Import

Synapse SQL Pool Security Alert Policies can be imported using the resource id, e.g.

$ pulumi import azure:synapse/sqlPoolSecurityAlertPolicy:SqlPoolSecurityAlertPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1/sqlPools/sqlPool1/securityAlertPolicies/default

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi

pulumi/pulumi-azure

azure.synapse.SqlPoolSecurityAlertPolicy

On this page

On this page

Example Usage

Create SqlPoolSecurityAlertPolicy Resource

Constructor syntax

Parameters

Constructor example

SqlPoolSecurityAlertPolicy Resource Properties

Inputs

Outputs

Look up Existing SqlPoolSecurityAlertPolicy Resource

Import

Package Details

On this page

On this page