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

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

azure.synapse.SqlPoolSecurityAlertPolicy

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi

    Manages a Security Alert Policy for a Synapse SQL Pool.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "examplestorageacc",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
        accountKind: "StorageV2",
        isHnsEnabled: true,
    });
    const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
        name: "example",
        storageAccountId: exampleAccount.id,
    });
    const exampleWorkspace = new azure.synapse.Workspace("example", {
        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",
        },
    });
    const exampleSqlPool = new azure.synapse.SqlPool("example", {
        name: "examplesqlpool",
        synapseWorkspaceId: exampleWorkspace.id,
        skuName: "DW100c",
        createMode: "Default",
    });
    const auditLogs = new azure.storage.Account("audit_logs", {
        name: "examplesa",
        resourceGroupName: example.name,
        location: example.location,
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleSqlPoolSecurityAlertPolicy = new azure.synapse.SqlPoolSecurityAlertPolicy("example", {
        sqlPoolId: exampleSqlPool.id,
        policyState: "Enabled",
        storageEndpoint: auditLogs.primaryBlobEndpoint,
        storageAccountAccessKey: auditLogs.primaryAccessKey,
        disabledAlerts: [
            "Sql_Injection",
            "Data_Exfiltration",
        ],
        retentionDays: 20,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_account = azure.storage.Account("example",
        name="examplestorageacc",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS",
        account_kind="StorageV2",
        is_hns_enabled=True)
    example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
        name="example",
        storage_account_id=example_account.id)
    example_workspace = azure.synapse.Workspace("example",
        name="example",
        resource_group_name=example.name,
        location=example.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",
        ),
        identity=azure.synapse.WorkspaceIdentityArgs(
            type="SystemAssigned",
        ),
        tags={
            "Env": "production",
        })
    example_sql_pool = azure.synapse.SqlPool("example",
        name="examplesqlpool",
        synapse_workspace_id=example_workspace.id,
        sku_name="DW100c",
        create_mode="Default")
    audit_logs = azure.storage.Account("audit_logs",
        name="examplesa",
        resource_group_name=example.name,
        location=example.location,
        account_tier="Standard",
        account_replication_type="LRS")
    example_sql_pool_security_alert_policy = azure.synapse.SqlPoolSecurityAlertPolicy("example",
        sql_pool_id=example_sql_pool.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)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("examplestorageacc"),
    			ResourceGroupName:      example.Name,
    			Location:               example.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, "example", &storage.DataLakeGen2FilesystemArgs{
    			Name:             pulumi.String("example"),
    			StorageAccountId: exampleAccount.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
    			Name:                            pulumi.String("example"),
    			ResourceGroupName:               example.Name,
    			Location:                        example.Location,
    			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
    			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
    			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
    			AadAdmin: &synapse.WorkspaceAadAdminTypeArgs{
    				Login:    pulumi.String("AzureAD Admin"),
    				ObjectId: pulumi.String("00000000-0000-0000-0000-000000000000"),
    				TenantId: pulumi.String("00000000-0000-0000-0000-000000000000"),
    			},
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    			Tags: pulumi.StringMap{
    				"Env": pulumi.String("production"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSqlPool, err := synapse.NewSqlPool(ctx, "example", &synapse.SqlPoolArgs{
    			Name:               pulumi.String("examplesqlpool"),
    			SynapseWorkspaceId: exampleWorkspace.ID(),
    			SkuName:            pulumi.String("DW100c"),
    			CreateMode:         pulumi.String("Default"),
    		})
    		if err != nil {
    			return err
    		}
    		auditLogs, err := storage.NewAccount(ctx, "audit_logs", &storage.AccountArgs{
    			Name:                   pulumi.String("examplesa"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = synapse.NewSqlPoolSecurityAlertPolicy(ctx, "example", &synapse.SqlPoolSecurityAlertPolicyArgs{
    			SqlPoolId:               exampleSqlPool.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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "examplestorageacc",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
            AccountKind = "StorageV2",
            IsHnsEnabled = true,
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
        {
            Name = "example",
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.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",
            },
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
            Tags = 
            {
                { "Env", "production" },
            },
        });
    
        var exampleSqlPool = new Azure.Synapse.SqlPool("example", new()
        {
            Name = "examplesqlpool",
            SynapseWorkspaceId = exampleWorkspace.Id,
            SkuName = "DW100c",
            CreateMode = "Default",
        });
    
        var auditLogs = new Azure.Storage.Account("audit_logs", new()
        {
            Name = "examplesa",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var exampleSqlPoolSecurityAlertPolicy = new Azure.Synapse.SqlPoolSecurityAlertPolicy("example", new()
        {
            SqlPoolId = exampleSqlPool.Id,
            PolicyState = "Enabled",
            StorageEndpoint = auditLogs.PrimaryBlobEndpoint,
            StorageAccountAccessKey = auditLogs.PrimaryAccessKey,
            DisabledAlerts = new[]
            {
                "Sql_Injection",
                "Data_Exfiltration",
            },
            RetentionDays = 20,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.storage.DataLakeGen2Filesystem;
    import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
    import com.pulumi.azure.synapse.Workspace;
    import com.pulumi.azure.synapse.WorkspaceArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceAadAdminArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
    import com.pulumi.azure.synapse.SqlPool;
    import com.pulumi.azure.synapse.SqlPoolArgs;
    import com.pulumi.azure.synapse.SqlPoolSecurityAlertPolicy;
    import com.pulumi.azure.synapse.SqlPoolSecurityAlertPolicyArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("examplestorageacc")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .accountKind("StorageV2")
                .isHnsEnabled("true")
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
                .name("example")
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .aadAdmin(WorkspaceAadAdminArgs.builder()
                    .login("AzureAD Admin")
                    .objectId("00000000-0000-0000-0000-000000000000")
                    .tenantId("00000000-0000-0000-0000-000000000000")
                    .build())
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .tags(Map.of("Env", "production"))
                .build());
    
            var exampleSqlPool = new SqlPool("exampleSqlPool", SqlPoolArgs.builder()
                .name("examplesqlpool")
                .synapseWorkspaceId(exampleWorkspace.id())
                .skuName("DW100c")
                .createMode("Default")
                .build());
    
            var auditLogs = new Account("auditLogs", AccountArgs.builder()
                .name("examplesa")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .build());
    
            var exampleSqlPoolSecurityAlertPolicy = new SqlPoolSecurityAlertPolicy("exampleSqlPoolSecurityAlertPolicy", SqlPoolSecurityAlertPolicyArgs.builder()
                .sqlPoolId(exampleSqlPool.id())
                .policyState("Enabled")
                .storageEndpoint(auditLogs.primaryBlobEndpoint())
                .storageAccountAccessKey(auditLogs.primaryAccessKey())
                .disabledAlerts(            
                    "Sql_Injection",
                    "Data_Exfiltration")
                .retentionDays(20)
                .build());
    
        }
    }
    
    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.

    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

    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)
    Resource lookup is not supported in YAML
    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.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi