Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. SqlPoolExtendedAuditingPolicy

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.synapse.SqlPoolExtendedAuditingPolicy

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Synapse SQL Pool Extended Auditing Policy.

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: "BlobStorage",
});
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!",
    identity: {
        type: "SystemAssigned",
    },
});
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 exampleSqlPoolExtendedAuditingPolicy = new azure.synapse.SqlPoolExtendedAuditingPolicy("example", {
    sqlPoolId: exampleSqlPool.id,
    storageEndpoint: auditLogs.primaryBlobEndpoint,
    storageAccountAccessKey: auditLogs.primaryAccessKey,
    storageAccountAccessKeyIsSecondary: false,
    retentionInDays: 6,
});
Copy
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="BlobStorage")
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!",
    identity={
        "type": "SystemAssigned",
    })
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_extended_auditing_policy = azure.synapse.SqlPoolExtendedAuditingPolicy("example",
    sql_pool_id=example_sql_pool.id,
    storage_endpoint=audit_logs.primary_blob_endpoint,
    storage_account_access_key=audit_logs.primary_access_key,
    storage_account_access_key_is_secondary=False,
    retention_in_days=6)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi-azure/sdk/v6/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("BlobStorage"),
		})
		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!"),
			Identity: &synapse.WorkspaceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
		})
		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.NewSqlPoolExtendedAuditingPolicy(ctx, "example", &synapse.SqlPoolExtendedAuditingPolicyArgs{
			SqlPoolId:                          exampleSqlPool.ID(),
			StorageEndpoint:                    auditLogs.PrimaryBlobEndpoint,
			StorageAccountAccessKey:            auditLogs.PrimaryAccessKey,
			StorageAccountAccessKeyIsSecondary: pulumi.Bool(false),
			RetentionInDays:                    pulumi.Int(6),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "BlobStorage",
    });

    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!",
        Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
        {
            Type = "SystemAssigned",
        },
    });

    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 exampleSqlPoolExtendedAuditingPolicy = new Azure.Synapse.SqlPoolExtendedAuditingPolicy("example", new()
    {
        SqlPoolId = exampleSqlPool.Id,
        StorageEndpoint = auditLogs.PrimaryBlobEndpoint,
        StorageAccountAccessKey = auditLogs.PrimaryAccessKey,
        StorageAccountAccessKeyIsSecondary = false,
        RetentionInDays = 6,
    });

});
Copy
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.WorkspaceIdentityArgs;
import com.pulumi.azure.synapse.SqlPool;
import com.pulumi.azure.synapse.SqlPoolArgs;
import com.pulumi.azure.synapse.SqlPoolExtendedAuditingPolicy;
import com.pulumi.azure.synapse.SqlPoolExtendedAuditingPolicyArgs;
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("BlobStorage")
            .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!")
            .identity(WorkspaceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .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 exampleSqlPoolExtendedAuditingPolicy = new SqlPoolExtendedAuditingPolicy("exampleSqlPoolExtendedAuditingPolicy", SqlPoolExtendedAuditingPolicyArgs.builder()
            .sqlPoolId(exampleSqlPool.id())
            .storageEndpoint(auditLogs.primaryBlobEndpoint())
            .storageAccountAccessKey(auditLogs.primaryAccessKey())
            .storageAccountAccessKeyIsSecondary(false)
            .retentionInDays(6)
            .build());

    }
}
Copy
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: BlobStorage
  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!
      identity:
        type: SystemAssigned
  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
  exampleSqlPoolExtendedAuditingPolicy:
    type: azure:synapse:SqlPoolExtendedAuditingPolicy
    name: example
    properties:
      sqlPoolId: ${exampleSqlPool.id}
      storageEndpoint: ${auditLogs.primaryBlobEndpoint}
      storageAccountAccessKey: ${auditLogs.primaryAccessKey}
      storageAccountAccessKeyIsSecondary: false
      retentionInDays: 6
Copy

Create SqlPoolExtendedAuditingPolicy Resource

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

Constructor syntax

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

@overload
def SqlPoolExtendedAuditingPolicy(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  sql_pool_id: Optional[str] = None,
                                  log_monitoring_enabled: Optional[bool] = None,
                                  retention_in_days: Optional[int] = None,
                                  storage_account_access_key: Optional[str] = None,
                                  storage_account_access_key_is_secondary: Optional[bool] = None,
                                  storage_endpoint: Optional[str] = None)
func NewSqlPoolExtendedAuditingPolicy(ctx *Context, name string, args SqlPoolExtendedAuditingPolicyArgs, opts ...ResourceOption) (*SqlPoolExtendedAuditingPolicy, error)
public SqlPoolExtendedAuditingPolicy(string name, SqlPoolExtendedAuditingPolicyArgs args, CustomResourceOptions? opts = null)
public SqlPoolExtendedAuditingPolicy(String name, SqlPoolExtendedAuditingPolicyArgs args)
public SqlPoolExtendedAuditingPolicy(String name, SqlPoolExtendedAuditingPolicyArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SqlPoolExtendedAuditingPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SqlPoolExtendedAuditingPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SqlPoolExtendedAuditingPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SqlPoolExtendedAuditingPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SqlPoolExtendedAuditingPolicyArgs
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 sqlPoolExtendedAuditingPolicyResource = new Azure.Synapse.SqlPoolExtendedAuditingPolicy("sqlPoolExtendedAuditingPolicyResource", new()
{
    SqlPoolId = "string",
    LogMonitoringEnabled = false,
    RetentionInDays = 0,
    StorageAccountAccessKey = "string",
    StorageAccountAccessKeyIsSecondary = false,
    StorageEndpoint = "string",
});
Copy
example, err := synapse.NewSqlPoolExtendedAuditingPolicy(ctx, "sqlPoolExtendedAuditingPolicyResource", &synapse.SqlPoolExtendedAuditingPolicyArgs{
	SqlPoolId:                          pulumi.String("string"),
	LogMonitoringEnabled:               pulumi.Bool(false),
	RetentionInDays:                    pulumi.Int(0),
	StorageAccountAccessKey:            pulumi.String("string"),
	StorageAccountAccessKeyIsSecondary: pulumi.Bool(false),
	StorageEndpoint:                    pulumi.String("string"),
})
Copy
var sqlPoolExtendedAuditingPolicyResource = new SqlPoolExtendedAuditingPolicy("sqlPoolExtendedAuditingPolicyResource", SqlPoolExtendedAuditingPolicyArgs.builder()
    .sqlPoolId("string")
    .logMonitoringEnabled(false)
    .retentionInDays(0)
    .storageAccountAccessKey("string")
    .storageAccountAccessKeyIsSecondary(false)
    .storageEndpoint("string")
    .build());
Copy
sql_pool_extended_auditing_policy_resource = azure.synapse.SqlPoolExtendedAuditingPolicy("sqlPoolExtendedAuditingPolicyResource",
    sql_pool_id="string",
    log_monitoring_enabled=False,
    retention_in_days=0,
    storage_account_access_key="string",
    storage_account_access_key_is_secondary=False,
    storage_endpoint="string")
Copy
const sqlPoolExtendedAuditingPolicyResource = new azure.synapse.SqlPoolExtendedAuditingPolicy("sqlPoolExtendedAuditingPolicyResource", {
    sqlPoolId: "string",
    logMonitoringEnabled: false,
    retentionInDays: 0,
    storageAccountAccessKey: "string",
    storageAccountAccessKeyIsSecondary: false,
    storageEndpoint: "string",
});
Copy
type: azure:synapse:SqlPoolExtendedAuditingPolicy
properties:
    logMonitoringEnabled: false
    retentionInDays: 0
    sqlPoolId: string
    storageAccountAccessKey: string
    storageAccountAccessKeyIsSecondary: false
    storageEndpoint: string
Copy

SqlPoolExtendedAuditingPolicy 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 SqlPoolExtendedAuditingPolicy resource accepts the following input properties:

SqlPoolId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
LogMonitoringEnabled bool
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
RetentionInDays int
The number of days to retain logs for in the storage account. Defaults to 0.
StorageAccountAccessKey string
The access key to use for the auditing storage account.
StorageAccountAccessKeyIsSecondary bool
Is storage_account_access_key value the storage's secondary key?
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
SqlPoolId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
LogMonitoringEnabled bool
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
RetentionInDays int
The number of days to retain logs for in the storage account. Defaults to 0.
StorageAccountAccessKey string
The access key to use for the auditing storage account.
StorageAccountAccessKeyIsSecondary bool
Is storage_account_access_key value the storage's secondary key?
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
sqlPoolId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
logMonitoringEnabled Boolean
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retentionInDays Integer
The number of days to retain logs for in the storage account. Defaults to 0.
storageAccountAccessKey String
The access key to use for the auditing storage account.
storageAccountAccessKeyIsSecondary Boolean
Is storage_account_access_key value the storage's secondary key?
storageEndpoint String
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
sqlPoolId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
logMonitoringEnabled boolean
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retentionInDays number
The number of days to retain logs for in the storage account. Defaults to 0.
storageAccountAccessKey string
The access key to use for the auditing storage account.
storageAccountAccessKeyIsSecondary boolean
Is storage_account_access_key value the storage's secondary key?
storageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
sql_pool_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
log_monitoring_enabled bool
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retention_in_days int
The number of days to retain logs for in the storage account. Defaults to 0.
storage_account_access_key str
The access key to use for the auditing storage account.
storage_account_access_key_is_secondary bool
Is storage_account_access_key value the storage's secondary key?
storage_endpoint str
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
sqlPoolId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
logMonitoringEnabled Boolean
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retentionInDays Number
The number of days to retain logs for in the storage account. Defaults to 0.
storageAccountAccessKey String
The access key to use for the auditing storage account.
storageAccountAccessKeyIsSecondary Boolean
Is storage_account_access_key value the storage's secondary key?
storageEndpoint String
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.

Outputs

All input properties are implicitly available as output properties. Additionally, the SqlPoolExtendedAuditingPolicy 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 SqlPoolExtendedAuditingPolicy Resource

Get an existing SqlPoolExtendedAuditingPolicy 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?: SqlPoolExtendedAuditingPolicyState, opts?: CustomResourceOptions): SqlPoolExtendedAuditingPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        log_monitoring_enabled: Optional[bool] = None,
        retention_in_days: Optional[int] = None,
        sql_pool_id: Optional[str] = None,
        storage_account_access_key: Optional[str] = None,
        storage_account_access_key_is_secondary: Optional[bool] = None,
        storage_endpoint: Optional[str] = None) -> SqlPoolExtendedAuditingPolicy
func GetSqlPoolExtendedAuditingPolicy(ctx *Context, name string, id IDInput, state *SqlPoolExtendedAuditingPolicyState, opts ...ResourceOption) (*SqlPoolExtendedAuditingPolicy, error)
public static SqlPoolExtendedAuditingPolicy Get(string name, Input<string> id, SqlPoolExtendedAuditingPolicyState? state, CustomResourceOptions? opts = null)
public static SqlPoolExtendedAuditingPolicy get(String name, Output<String> id, SqlPoolExtendedAuditingPolicyState state, CustomResourceOptions options)
resources:  _:    type: azure:synapse:SqlPoolExtendedAuditingPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
LogMonitoringEnabled bool
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
RetentionInDays int
The number of days to retain logs for in the storage account. Defaults to 0.
SqlPoolId Changes to this property will trigger replacement. string
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
StorageAccountAccessKey string
The access key to use for the auditing storage account.
StorageAccountAccessKeyIsSecondary bool
Is storage_account_access_key value the storage's secondary key?
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
LogMonitoringEnabled bool
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
RetentionInDays int
The number of days to retain logs for in the storage account. Defaults to 0.
SqlPoolId Changes to this property will trigger replacement. string
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
StorageAccountAccessKey string
The access key to use for the auditing storage account.
StorageAccountAccessKeyIsSecondary bool
Is storage_account_access_key value the storage's secondary key?
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
logMonitoringEnabled Boolean
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retentionInDays Integer
The number of days to retain logs for in the storage account. Defaults to 0.
sqlPoolId Changes to this property will trigger replacement. String
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
storageAccountAccessKey String
The access key to use for the auditing storage account.
storageAccountAccessKeyIsSecondary Boolean
Is storage_account_access_key value the storage's secondary key?
storageEndpoint String
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
logMonitoringEnabled boolean
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retentionInDays number
The number of days to retain logs for in the storage account. Defaults to 0.
sqlPoolId Changes to this property will trigger replacement. string
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
storageAccountAccessKey string
The access key to use for the auditing storage account.
storageAccountAccessKeyIsSecondary boolean
Is storage_account_access_key value the storage's secondary key?
storageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
log_monitoring_enabled bool
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retention_in_days int
The number of days to retain logs for in the storage account. Defaults to 0.
sql_pool_id Changes to this property will trigger replacement. str
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
storage_account_access_key str
The access key to use for the auditing storage account.
storage_account_access_key_is_secondary bool
Is storage_account_access_key value the storage's secondary key?
storage_endpoint str
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
logMonitoringEnabled Boolean
Enable audit events to Azure Monitor? To enable server audit events to Azure Monitor, please enable its master database audit events to Azure Monitor. Defaults to true.
retentionInDays Number
The number of days to retain logs for in the storage account. Defaults to 0.
sqlPoolId Changes to this property will trigger replacement. String
The ID of the Synapse SQL pool to set the extended auditing policy. Changing this forces a new resource to be created.
storageAccountAccessKey String
The access key to use for the auditing storage account.
storageAccountAccessKeyIsSecondary Boolean
Is storage_account_access_key value the storage's secondary key?
storageEndpoint String
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.

Import

Synapse SQL Pool Extended Auditing Policys can be imported using the resource id, e.g.

$ pulumi import azure:synapse/sqlPoolExtendedAuditingPolicy:SqlPoolExtendedAuditingPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Synapse/workspaces/workspace1/sqlPools/sqlPool1/extendedAuditingSettings/default
Copy

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

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure