1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. WorkspaceSecurityAlertPolicy

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.synapse.WorkspaceSecurityAlertPolicy

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Security Alert Policy for a Synapse Workspace.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new Azure.Storage.DataLakeGen2FilesystemArgs
        {
            StorageAccountId = exampleAccount.Id,
        });
        var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new Azure.Synapse.WorkspaceArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            AadAdmin = new Azure.Synapse.Inputs.WorkspaceAadAdminArgs
            {
                Login = "AzureAD Admin",
                ObjectId = "00000000-0000-0000-0000-000000000000",
                TenantId = "00000000-0000-0000-0000-000000000000",
            },
            Tags = 
            {
                { "Env", "production" },
            },
        });
        var auditLogs = new Azure.Storage.Account("auditLogs", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleWorkspaceSecurityAlertPolicy = new Azure.Synapse.WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy", new Azure.Synapse.WorkspaceSecurityAlertPolicyArgs
        {
            SynapseWorkspaceId = exampleWorkspace.Id,
            PolicyState = "Enabled",
            StorageEndpoint = auditLogs.PrimaryBlobEndpoint,
            StorageAccountAccessKey = auditLogs.PrimaryAccessKey,
            DisabledAlerts = 
            {
                "Sql_Injection",
                "Data_Exfiltration",
            },
            RetentionDays = 20,
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/synapse"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			AccountKind:            pulumi.String("StorageV2"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "exampleDataLakeGen2Filesystem", &storage.DataLakeGen2FilesystemArgs{
			StorageAccountId: exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := synapse.NewWorkspace(ctx, "exampleWorkspace", &synapse.WorkspaceArgs{
			ResourceGroupName:               exampleResourceGroup.Name,
			Location:                        exampleResourceGroup.Location,
			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
			AadAdmin: &synapse.WorkspaceAadAdminArgs{
				Login:    pulumi.String("AzureAD Admin"),
				ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			},
			Tags: pulumi.StringMap{
				"Env": pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		auditLogs, err := storage.NewAccount(ctx, "auditLogs", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		_, err = synapse.NewWorkspaceSecurityAlertPolicy(ctx, "exampleWorkspaceSecurityAlertPolicy", &synapse.WorkspaceSecurityAlertPolicyArgs{
			SynapseWorkspaceId:      exampleWorkspace.ID(),
			PolicyState:             pulumi.String("Enabled"),
			StorageEndpoint:         auditLogs.PrimaryBlobEndpoint,
			StorageAccountAccessKey: auditLogs.PrimaryAccessKey,
			DisabledAlerts: pulumi.StringArray{
				pulumi.String("Sql_Injection"),
				pulumi.String("Data_Exfiltration"),
			},
			RetentionDays: pulumi.Int(20),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
    accountKind: "StorageV2",
    isHnsEnabled: "true",
});
const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", {storageAccountId: exampleAccount.id});
const exampleWorkspace = new azure.synapse.Workspace("exampleWorkspace", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.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",
    },
    tags: {
        Env: "production",
    },
});
const auditLogs = new azure.storage.Account("auditLogs", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleWorkspaceSecurityAlertPolicy = new azure.synapse.WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy", {
    synapseWorkspaceId: exampleWorkspace.id,
    policyState: "Enabled",
    storageEndpoint: auditLogs.primaryBlobEndpoint,
    storageAccountAccessKey: auditLogs.primaryAccessKey,
    disabledAlerts: [
        "Sql_Injection",
        "Data_Exfiltration",
    ],
    retentionDays: 20,
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS",
    account_kind="StorageV2",
    is_hns_enabled=True)
example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", storage_account_id=example_account.id)
example_workspace = azure.synapse.Workspace("exampleWorkspace",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
    sql_administrator_login="sqladminuser",
    sql_administrator_login_password="H@Sh1CoR3!",
    aad_admin=azure.synapse.WorkspaceAadAdminArgs(
        login="AzureAD Admin",
        object_id="00000000-0000-0000-0000-000000000000",
        tenant_id="00000000-0000-0000-0000-000000000000",
    ),
    tags={
        "Env": "production",
    })
audit_logs = azure.storage.Account("auditLogs",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_workspace_security_alert_policy = azure.synapse.WorkspaceSecurityAlertPolicy("exampleWorkspaceSecurityAlertPolicy",
    synapse_workspace_id=example_workspace.id,
    policy_state="Enabled",
    storage_endpoint=audit_logs.primary_blob_endpoint,
    storage_account_access_key=audit_logs.primary_access_key,
    disabled_alerts=[
        "Sql_Injection",
        "Data_Exfiltration",
    ],
    retention_days=20)

    Example coming soon!

    Create WorkspaceSecurityAlertPolicy Resource

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

    Constructor syntax

    new WorkspaceSecurityAlertPolicy(name: string, args: WorkspaceSecurityAlertPolicyArgs, opts?: CustomResourceOptions);
    @overload
def WorkspaceSecurityAlertPolicy(resource_name: str,
                                 args: WorkspaceSecurityAlertPolicyArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceSecurityAlertPolicy(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 policy_state: Optional[str] = None,
                                 synapse_workspace_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 NewWorkspaceSecurityAlertPolicy(ctx *Context, name string, args WorkspaceSecurityAlertPolicyArgs, opts ...ResourceOption) (*WorkspaceSecurityAlertPolicy, error)
    public WorkspaceSecurityAlertPolicy(string name, WorkspaceSecurityAlertPolicyArgs args, CustomResourceOptions? opts = null)
    public WorkspaceSecurityAlertPolicy(String name, WorkspaceSecurityAlertPolicyArgs args)
public WorkspaceSecurityAlertPolicy(String name, WorkspaceSecurityAlertPolicyArgs args, CustomResourceOptions options)

    type: azure:synapse:WorkspaceSecurityAlertPolicy
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 WorkspaceSecurityAlertPolicyArgs
    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 WorkspaceSecurityAlertPolicyArgs
    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 WorkspaceSecurityAlertPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceSecurityAlertPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceSecurityAlertPolicyArgs
    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 workspaceSecurityAlertPolicyResource = new Azure.Synapse.WorkspaceSecurityAlertPolicy("workspaceSecurityAlertPolicyResource", new()
{
    PolicyState = "string",
    SynapseWorkspaceId = "string",
    DisabledAlerts = new[]
    {
        "string",
    },
    EmailAccountAdminsEnabled = false,
    EmailAddresses = new[]
    {
        "string",
    },
    RetentionDays = 0,
    StorageAccountAccessKey = "string",
    StorageEndpoint = "string",
});

    example, err := synapse.NewWorkspaceSecurityAlertPolicy(ctx, "workspaceSecurityAlertPolicyResource", &synapse.WorkspaceSecurityAlertPolicyArgs{
	PolicyState:        pulumi.String("string"),
	SynapseWorkspaceId: 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 workspaceSecurityAlertPolicyResource = new WorkspaceSecurityAlertPolicy("workspaceSecurityAlertPolicyResource", WorkspaceSecurityAlertPolicyArgs.builder()
    .policyState("string")
    .synapseWorkspaceId("string")
    .disabledAlerts("string")
    .emailAccountAdminsEnabled(false)
    .emailAddresses("string")
    .retentionDays(0)
    .storageAccountAccessKey("string")
    .storageEndpoint("string")
    .build());

    workspace_security_alert_policy_resource = azure.synapse.WorkspaceSecurityAlertPolicy("workspaceSecurityAlertPolicyResource",
    policy_state="string",
    synapse_workspace_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 workspaceSecurityAlertPolicyResource = new azure.synapse.WorkspaceSecurityAlertPolicy("workspaceSecurityAlertPolicyResource", {
    policyState: "string",
    synapseWorkspaceId: "string",
    disabledAlerts: ["string"],
    emailAccountAdminsEnabled: false,
    emailAddresses: ["string"],
    retentionDays: 0,
    storageAccountAccessKey: "string",
    storageEndpoint: "string",
});

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

    WorkspaceSecurityAlertPolicy 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 WorkspaceSecurityAlertPolicy 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 workspace. Allowed values are: Disabled, Enabled.
    SynapseWorkspaceId string
    Specifies the ID of the Synapse Workspace. 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 e-mail 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://MyAccount.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 workspace. Allowed values are: Disabled, Enabled.
    SynapseWorkspaceId string
    Specifies the ID of the Synapse Workspace. 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 e-mail 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://MyAccount.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 workspace. Allowed values are: Disabled, Enabled.
    synapseWorkspaceId String
    Specifies the ID of the Synapse Workspace. 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 e-mail 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://MyAccount.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 workspace. Allowed values are: Disabled, Enabled.
    synapseWorkspaceId string
    Specifies the ID of the Synapse Workspace. 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 e-mail 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://MyAccount.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 workspace. Allowed values are: Disabled, Enabled.
    synapse_workspace_id str
    Specifies the ID of the Synapse Workspace. 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 e-mail 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://MyAccount.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 workspace. Allowed values are: Disabled, Enabled.
    synapseWorkspaceId String
    Specifies the ID of the Synapse Workspace. 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 e-mail 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://MyAccount.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 WorkspaceSecurityAlertPolicy 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 WorkspaceSecurityAlertPolicy Resource

    Get an existing WorkspaceSecurityAlertPolicy 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?: WorkspaceSecurityAlertPolicyState, opts?: CustomResourceOptions): WorkspaceSecurityAlertPolicy
    @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,
        storage_account_access_key: Optional[str] = None,
        storage_endpoint: Optional[str] = None,
        synapse_workspace_id: Optional[str] = None) -> WorkspaceSecurityAlertPolicy
    func GetWorkspaceSecurityAlertPolicy(ctx *Context, name string, id IDInput, state *WorkspaceSecurityAlertPolicyState, opts ...ResourceOption) (*WorkspaceSecurityAlertPolicy, error)
    public static WorkspaceSecurityAlertPolicy Get(string name, Input<string> id, WorkspaceSecurityAlertPolicyState? state, CustomResourceOptions? opts = null)
    public static WorkspaceSecurityAlertPolicy get(String name, Output<String> id, WorkspaceSecurityAlertPolicyState state, CustomResourceOptions options)
    resources:  _:    type: azure:synapse:WorkspaceSecurityAlertPolicy    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 e-mail 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 workspace. Allowed values are: Disabled, Enabled.
    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://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    SynapseWorkspaceId string
    Specifies the ID of the Synapse Workspace. 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 e-mail 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 workspace. Allowed values are: Disabled, Enabled.
    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://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    SynapseWorkspaceId string
    Specifies the ID of the Synapse Workspace. 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 e-mail 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 workspace. Allowed values are: Disabled, Enabled.
    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://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    synapseWorkspaceId String
    Specifies the ID of the Synapse Workspace. 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 e-mail 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 workspace. Allowed values are: Disabled, Enabled.
    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://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    synapseWorkspaceId string
    Specifies the ID of the Synapse Workspace. 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 e-mail 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 workspace. Allowed values are: Disabled, Enabled.
    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://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    synapse_workspace_id str
    Specifies the ID of the Synapse Workspace. 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 e-mail 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 workspace. Allowed values are: Disabled, Enabled.
    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://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
    synapseWorkspaceId String
    Specifies the ID of the Synapse Workspace. Changing this forces a new resource to be created.

    Import

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

     $ pulumi import azure:synapse/workspaceSecurityAlertPolicy:WorkspaceSecurityAlertPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1/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.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.