We recommend using Azure Native.
azure.synapse.WorkspaceSecurityAlertPolicy
Explore with Pulumi AI
Manages a Security Alert Policy for a Synapse Workspace.
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
  auditLogs:
    type: azure:storage:Account
    name: audit_logs
    properties:
      name: examplesa
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleWorkspaceSecurityAlertPolicy:
    type: azure:synapse:WorkspaceSecurityAlertPolicy
    name: example
    properties:
      synapseWorkspaceId: ${exampleWorkspace.id}
      policyState: Enabled
      storageEndpoint: ${auditLogs.primaryBlobEndpoint}
      storageAccountAccessKey: ${auditLogs.primaryAccessKey}
      disabledAlerts:
        - Sql_Injection
        - Data_Exfiltration
      retentionDays: 20
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. Possible values are Disabled,EnabledandNew.
- SynapseWorkspace stringId 
- 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.
- EmailAccount boolAdmins Enabled 
- 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.
- StorageAccount stringAccess Key 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- SynapseWorkspace stringId 
- 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.
- EmailAccount boolAdmins Enabled 
- 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.
- StorageAccount stringAccess Key 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- synapseWorkspace StringId 
- 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.
- emailAccount BooleanAdmins Enabled 
- 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.
- storageAccount StringAccess Key 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- synapseWorkspace stringId 
- 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.
- emailAccount booleanAdmins Enabled 
- 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.
- storageAccount stringAccess Key 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- synapse_workspace_ strid 
- 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_ booladmins_ enabled 
- 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_ straccess_ key 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- synapseWorkspace StringId 
- 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.
- emailAccount BooleanAdmins Enabled 
- 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.
- storageAccount StringAccess Key 
- 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 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) -> WorkspaceSecurityAlertPolicyfunc 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.
- 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.
- EmailAccount boolAdmins Enabled 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- RetentionDays int
- Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
- StorageAccount stringAccess Key 
- 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.
- SynapseWorkspace stringId 
- 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.
- EmailAccount boolAdmins Enabled 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- RetentionDays int
- Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
- StorageAccount stringAccess Key 
- 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.
- SynapseWorkspace stringId 
- 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.
- emailAccount BooleanAdmins Enabled 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- retentionDays Integer
- Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
- storageAccount StringAccess Key 
- 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.
- synapseWorkspace StringId 
- 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.
- emailAccount booleanAdmins Enabled 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- retentionDays number
- Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
- storageAccount stringAccess Key 
- 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.
- synapseWorkspace stringId 
- 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_ booladmins_ enabled 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- retention_days int
- Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
- storage_account_ straccess_ key 
- 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.
- synapse_workspace_ strid 
- 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.
- emailAccount BooleanAdmins Enabled 
- 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 workspace. Possible values are Disabled,EnabledandNew.
- retentionDays Number
- Specifies the number of days to keep in the Threat Detection audit logs. Defaults to 0.
- storageAccount StringAccess Key 
- 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.
- synapseWorkspace StringId 
- 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 azurermTerraform Provider.