We recommend using Azure Native.
azure.synapse.SqlPoolSecurityAlertPolicy
Explore with Pulumi AI
Manages a Security Alert Policy for a Synapse SQL Pool.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
AccountKind = "StorageV2",
IsHnsEnabled = true,
});
var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", new()
{
StorageAccountId = exampleAccount.Id,
});
var exampleWorkspace = new Azure.Synapse.Workspace("exampleWorkspace", new()
{
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",
},
Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
{
Type = "SystemAssigned",
},
Tags =
{
{ "Env", "production" },
},
});
var exampleSqlPool = new Azure.Synapse.SqlPool("exampleSqlPool", new()
{
SynapseWorkspaceId = exampleWorkspace.Id,
SkuName = "DW100c",
CreateMode = "Default",
});
var auditLogs = new Azure.Storage.Account("auditLogs", new()
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "LRS",
});
var exampleSqlPoolSecurityAlertPolicy = new Azure.Synapse.SqlPoolSecurityAlertPolicy("exampleSqlPoolSecurityAlertPolicy", new()
{
SqlPoolId = exampleSqlPool.Id,
PolicyState = "Enabled",
StorageEndpoint = auditLogs.PrimaryBlobEndpoint,
StorageAccountAccessKey = auditLogs.PrimaryAccessKey,
DisabledAlerts = new[]
{
"Sql_Injection",
"Data_Exfiltration",
},
RetentionDays = 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 {
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.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, "exampleSqlPool", &synapse.SqlPoolArgs{
SynapseWorkspaceId: exampleWorkspace.ID(),
SkuName: pulumi.String("DW100c"),
CreateMode: pulumi.String("Default"),
})
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.NewSqlPoolSecurityAlertPolicy(ctx, "exampleSqlPoolSecurityAlertPolicy", &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
})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.location())
.accountTier("Standard")
.accountReplicationType("LRS")
.accountKind("StorageV2")
.isHnsEnabled("true")
.build());
var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
.storageAccountId(exampleAccount.id())
.build());
var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.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()
.synapseWorkspaceId(exampleWorkspace.id())
.skuName("DW100c")
.createMode("Default")
.build());
var auditLogs = new Account("auditLogs", AccountArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.location(exampleResourceGroup.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());
}
}
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",
),
identity=azure.synapse.WorkspaceIdentityArgs(
type="SystemAssigned",
),
tags={
"Env": "production",
})
example_sql_pool = azure.synapse.SqlPool("exampleSqlPool",
synapse_workspace_id=example_workspace.id,
sku_name="DW100c",
create_mode="Default")
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_sql_pool_security_alert_policy = azure.synapse.SqlPoolSecurityAlertPolicy("exampleSqlPoolSecurityAlertPolicy",
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)
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",
},
identity: {
type: "SystemAssigned",
},
tags: {
Env: "production",
},
});
const exampleSqlPool = new azure.synapse.SqlPool("exampleSqlPool", {
synapseWorkspaceId: exampleWorkspace.id,
skuName: "DW100c",
createMode: "Default",
});
const auditLogs = new azure.storage.Account("auditLogs", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
accountTier: "Standard",
accountReplicationType: "LRS",
});
const exampleSqlPoolSecurityAlertPolicy = new azure.synapse.SqlPoolSecurityAlertPolicy("exampleSqlPoolSecurityAlertPolicy", {
sqlPoolId: exampleSqlPool.id,
policyState: "Enabled",
storageEndpoint: auditLogs.primaryBlobEndpoint,
storageAccountAccessKey: auditLogs.primaryAccessKey,
disabledAlerts: [
"Sql_Injection",
"Data_Exfiltration",
],
retentionDays: 20,
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleAccount:
type: azure:storage:Account
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
accountTier: Standard
accountReplicationType: LRS
accountKind: StorageV2
isHnsEnabled: 'true'
exampleDataLakeGen2Filesystem:
type: azure:storage:DataLakeGen2Filesystem
properties:
storageAccountId: ${exampleAccount.id}
exampleWorkspace:
type: azure:synapse:Workspace
properties:
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
identity:
type: SystemAssigned
tags:
Env: production
exampleSqlPool:
type: azure:synapse:SqlPool
properties:
synapseWorkspaceId: ${exampleWorkspace.id}
skuName: DW100c
createMode: Default
auditLogs:
type: azure:storage:Account
properties:
resourceGroupName: ${exampleResourceGroup.name}
location: ${exampleResourceGroup.location}
accountTier: Standard
accountReplicationType: LRS
exampleSqlPoolSecurityAlertPolicy:
type: azure:synapse:SqlPoolSecurityAlertPolicy
properties:
sqlPoolId: ${exampleSqlPool.id}
policyState: Enabled
storageEndpoint: ${auditLogs.primaryBlobEndpoint}
storageAccountAccessKey: ${auditLogs.primaryAccessKey}
disabledAlerts:
- Sql_Injection
- Data_Exfiltration
retentionDays: 20
Create SqlPoolSecurityAlertPolicy Resource
new SqlPoolSecurityAlertPolicy(name: string, args: SqlPoolSecurityAlertPolicyArgs, opts?: CustomResourceOptions);
@overload
def SqlPoolSecurityAlertPolicy(resource_name: 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)
@overload
def SqlPoolSecurityAlertPolicy(resource_name: str,
args: SqlPoolSecurityAlertPolicyArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Policy
State 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
andNew
.- Sql
Pool stringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- Disabled
Alerts List<string> 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 List<string> 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 stringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- Storage
Endpoint 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 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
andNew
.- Sql
Pool stringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- Disabled
Alerts []string 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 []string 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 stringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- Storage
Endpoint 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 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
andNew
.- sql
Pool StringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- disabled
Alerts List<String> Specifies an array of alerts that are disabled. Allowed values are:
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
,Unsafe_Action
.- email
Account BooleanAdmins Enabled Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to
false
.- email
Addresses List<String> Specifies an array of email addresses to which the alert is sent.
- retention
Days Integer Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- storage
Account StringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint 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 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
andNew
.- sql
Pool stringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- disabled
Alerts string[] Specifies an array of alerts that are disabled. Allowed values are:
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
,Unsafe_Action
.- email
Account booleanAdmins Enabled Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to
false
.- email
Addresses string[] Specifies an array of email addresses to which the alert is sent.
- retention
Days number Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint 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
andNew
.- sql_
pool_ strid 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_ 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.
- policy
State 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
andNew
.- sql
Pool StringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- disabled
Alerts List<String> Specifies an array of alerts that are disabled. Allowed values are:
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
,Unsafe_Action
.- email
Account BooleanAdmins Enabled Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to
false
.- email
Addresses List<String> Specifies an array of email addresses to which the alert is sent.
- retention
Days Number Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- storage
Account StringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint 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.
- Disabled
Alerts List<string> 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 List<string> Specifies an array of email addresses to which the alert is sent.
- Policy
State 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
andNew
.- Retention
Days int Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- Sql
Pool stringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- Storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- Storage
Endpoint 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 []string 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 []string Specifies an array of email addresses to which the alert is sent.
- Policy
State 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
andNew
.- Retention
Days int Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- Sql
Pool stringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- Storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- Storage
Endpoint 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 List<String> Specifies an array of alerts that are disabled. Allowed values are:
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
,Unsafe_Action
.- email
Account BooleanAdmins Enabled Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to
false
.- email
Addresses List<String> Specifies an array of email addresses to which the alert is sent.
- policy
State 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
andNew
.- retention
Days Integer Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- sql
Pool StringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- storage
Account StringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint 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 string[] Specifies an array of alerts that are disabled. Allowed values are:
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
,Unsafe_Action
.- email
Account booleanAdmins Enabled Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to
false
.- email
Addresses string[] Specifies an array of email addresses to which the alert is sent.
- policy
State 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
andNew
.- retention
Days number Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- sql
Pool stringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- storage
Account stringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint 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_ 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 SQL pool. Possible values are
Disabled
,Enabled
andNew
.- retention_
days int Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- sql_
pool_ strid Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- 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.
- disabled
Alerts List<String> Specifies an array of alerts that are disabled. Allowed values are:
Sql_Injection
,Sql_Injection_Vulnerability
,Access_Anomaly
,Data_Exfiltration
,Unsafe_Action
.- email
Account BooleanAdmins Enabled Boolean flag which specifies if the alert is sent to the account administrators or not. Defaults to
false
.- email
Addresses List<String> Specifies an array of email addresses to which the alert is sent.
- policy
State 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
andNew
.- retention
Days Number Specifies the number of days to keep in the Threat Detection audit logs. Defaults to
0
.- sql
Pool StringId Specifies the ID of the Synapse SQL Pool. Changing this forces a new resource to be created.
- storage
Account StringAccess Key Specifies the identifier key of the Threat Detection audit storage account.
- storage
Endpoint 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
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurerm
Terraform Provider.