1. Packages
  2. Azure Classic
  3. API Docs
  4. mssql
  5. DatabaseExtendedAuditingPolicy

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.mssql.DatabaseExtendedAuditingPolicy

Explore with Pulumi AI

Manages a MS SQL Database 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 exampleServer = new azure.mssql.Server("example", {
    name: "example-sqlserver",
    resourceGroupName: example.name,
    location: example.location,
    version: "12.0",
    administratorLogin: "missadministrator",
    administratorLoginPassword: "AdminPassword123!",
});
const exampleDatabase = new azure.mssql.Database("example", {
    name: "example-db",
    serverId: exampleServer.id,
});
const exampleAccount = new azure.storage.Account("example", {
    name: "examplesa",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleDatabaseExtendedAuditingPolicy = new azure.mssql.DatabaseExtendedAuditingPolicy("example", {
    databaseId: exampleDatabase.id,
    storageEndpoint: exampleAccount.primaryBlobEndpoint,
    storageAccountAccessKey: exampleAccount.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_server = azure.mssql.Server("example",
    name="example-sqlserver",
    resource_group_name=example.name,
    location=example.location,
    version="12.0",
    administrator_login="missadministrator",
    administrator_login_password="AdminPassword123!")
example_database = azure.mssql.Database("example",
    name="example-db",
    server_id=example_server.id)
example_account = azure.storage.Account("example",
    name="examplesa",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_database_extended_auditing_policy = azure.mssql.DatabaseExtendedAuditingPolicy("example",
    database_id=example_database.id,
    storage_endpoint=example_account.primary_blob_endpoint,
    storage_account_access_key=example_account.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/mssql"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"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
		}
		exampleServer, err := mssql.NewServer(ctx, "example", &mssql.ServerArgs{
			Name:                       pulumi.String("example-sqlserver"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			Version:                    pulumi.String("12.0"),
			AdministratorLogin:         pulumi.String("missadministrator"),
			AdministratorLoginPassword: pulumi.String("AdminPassword123!"),
		})
		if err != nil {
			return err
		}
		exampleDatabase, err := mssql.NewDatabase(ctx, "example", &mssql.DatabaseArgs{
			Name:     pulumi.String("example-db"),
			ServerId: exampleServer.ID(),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &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 = mssql.NewDatabaseExtendedAuditingPolicy(ctx, "example", &mssql.DatabaseExtendedAuditingPolicyArgs{
			DatabaseId:                         exampleDatabase.ID(),
			StorageEndpoint:                    exampleAccount.PrimaryBlobEndpoint,
			StorageAccountAccessKey:            exampleAccount.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 exampleServer = new Azure.MSSql.Server("example", new()
    {
        Name = "example-sqlserver",
        ResourceGroupName = example.Name,
        Location = example.Location,
        Version = "12.0",
        AdministratorLogin = "missadministrator",
        AdministratorLoginPassword = "AdminPassword123!",
    });

    var exampleDatabase = new Azure.MSSql.Database("example", new()
    {
        Name = "example-db",
        ServerId = exampleServer.Id,
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "examplesa",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleDatabaseExtendedAuditingPolicy = new Azure.MSSql.DatabaseExtendedAuditingPolicy("example", new()
    {
        DatabaseId = exampleDatabase.Id,
        StorageEndpoint = exampleAccount.PrimaryBlobEndpoint,
        StorageAccountAccessKey = exampleAccount.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.mssql.Server;
import com.pulumi.azure.mssql.ServerArgs;
import com.pulumi.azure.mssql.Database;
import com.pulumi.azure.mssql.DatabaseArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.mssql.DatabaseExtendedAuditingPolicy;
import com.pulumi.azure.mssql.DatabaseExtendedAuditingPolicyArgs;
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 exampleServer = new Server("exampleServer", ServerArgs.builder()
            .name("example-sqlserver")
            .resourceGroupName(example.name())
            .location(example.location())
            .version("12.0")
            .administratorLogin("missadministrator")
            .administratorLoginPassword("AdminPassword123!")
            .build());

        var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
            .name("example-db")
            .serverId(exampleServer.id())
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplesa")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleDatabaseExtendedAuditingPolicy = new DatabaseExtendedAuditingPolicy("exampleDatabaseExtendedAuditingPolicy", DatabaseExtendedAuditingPolicyArgs.builder()
            .databaseId(exampleDatabase.id())
            .storageEndpoint(exampleAccount.primaryBlobEndpoint())
            .storageAccountAccessKey(exampleAccount.primaryAccessKey())
            .storageAccountAccessKeyIsSecondary(false)
            .retentionInDays(6)
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleServer:
    type: azure:mssql:Server
    name: example
    properties:
      name: example-sqlserver
      resourceGroupName: ${example.name}
      location: ${example.location}
      version: '12.0'
      administratorLogin: missadministrator
      administratorLoginPassword: AdminPassword123!
  exampleDatabase:
    type: azure:mssql:Database
    name: example
    properties:
      name: example-db
      serverId: ${exampleServer.id}
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplesa
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleDatabaseExtendedAuditingPolicy:
    type: azure:mssql:DatabaseExtendedAuditingPolicy
    name: example
    properties:
      databaseId: ${exampleDatabase.id}
      storageEndpoint: ${exampleAccount.primaryBlobEndpoint}
      storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
      storageAccountAccessKeyIsSecondary: false
      retentionInDays: 6
Copy

Create DatabaseExtendedAuditingPolicy Resource

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

Constructor syntax

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

@overload
def DatabaseExtendedAuditingPolicy(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   database_id: Optional[str] = None,
                                   enabled: Optional[bool] = 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 NewDatabaseExtendedAuditingPolicy(ctx *Context, name string, args DatabaseExtendedAuditingPolicyArgs, opts ...ResourceOption) (*DatabaseExtendedAuditingPolicy, error)
public DatabaseExtendedAuditingPolicy(string name, DatabaseExtendedAuditingPolicyArgs args, CustomResourceOptions? opts = null)
public DatabaseExtendedAuditingPolicy(String name, DatabaseExtendedAuditingPolicyArgs args)
public DatabaseExtendedAuditingPolicy(String name, DatabaseExtendedAuditingPolicyArgs args, CustomResourceOptions options)
type: azure:mssql:DatabaseExtendedAuditingPolicy
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. DatabaseExtendedAuditingPolicyArgs
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. DatabaseExtendedAuditingPolicyArgs
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. DatabaseExtendedAuditingPolicyArgs
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. DatabaseExtendedAuditingPolicyArgs
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. DatabaseExtendedAuditingPolicyArgs
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 databaseExtendedAuditingPolicyResource = new Azure.MSSql.DatabaseExtendedAuditingPolicy("databaseExtendedAuditingPolicyResource", new()
{
    DatabaseId = "string",
    Enabled = false,
    LogMonitoringEnabled = false,
    RetentionInDays = 0,
    StorageAccountAccessKey = "string",
    StorageAccountAccessKeyIsSecondary = false,
    StorageEndpoint = "string",
});
Copy
example, err := mssql.NewDatabaseExtendedAuditingPolicy(ctx, "databaseExtendedAuditingPolicyResource", &mssql.DatabaseExtendedAuditingPolicyArgs{
	DatabaseId:                         pulumi.String("string"),
	Enabled:                            pulumi.Bool(false),
	LogMonitoringEnabled:               pulumi.Bool(false),
	RetentionInDays:                    pulumi.Int(0),
	StorageAccountAccessKey:            pulumi.String("string"),
	StorageAccountAccessKeyIsSecondary: pulumi.Bool(false),
	StorageEndpoint:                    pulumi.String("string"),
})
Copy
var databaseExtendedAuditingPolicyResource = new DatabaseExtendedAuditingPolicy("databaseExtendedAuditingPolicyResource", DatabaseExtendedAuditingPolicyArgs.builder()
    .databaseId("string")
    .enabled(false)
    .logMonitoringEnabled(false)
    .retentionInDays(0)
    .storageAccountAccessKey("string")
    .storageAccountAccessKeyIsSecondary(false)
    .storageEndpoint("string")
    .build());
Copy
database_extended_auditing_policy_resource = azure.mssql.DatabaseExtendedAuditingPolicy("databaseExtendedAuditingPolicyResource",
    database_id="string",
    enabled=False,
    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 databaseExtendedAuditingPolicyResource = new azure.mssql.DatabaseExtendedAuditingPolicy("databaseExtendedAuditingPolicyResource", {
    databaseId: "string",
    enabled: false,
    logMonitoringEnabled: false,
    retentionInDays: 0,
    storageAccountAccessKey: "string",
    storageAccountAccessKeyIsSecondary: false,
    storageEndpoint: "string",
});
Copy
type: azure:mssql:DatabaseExtendedAuditingPolicy
properties:
    databaseId: string
    enabled: false
    logMonitoringEnabled: false
    retentionInDays: 0
    storageAccountAccessKey: string
    storageAccountAccessKeyIsSecondary: false
    storageEndpoint: string
Copy

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

DatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
Enabled bool

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

LogMonitoringEnabled bool

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
DatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
Enabled bool

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

LogMonitoringEnabled bool

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
databaseId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled Boolean

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

logMonitoringEnabled Boolean

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
databaseId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled boolean

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

logMonitoringEnabled boolean

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
database_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled bool

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

log_monitoring_enabled bool

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
databaseId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled Boolean

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

logMonitoringEnabled Boolean

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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 DatabaseExtendedAuditingPolicy 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 DatabaseExtendedAuditingPolicy Resource

Get an existing DatabaseExtendedAuditingPolicy 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?: DatabaseExtendedAuditingPolicyState, opts?: CustomResourceOptions): DatabaseExtendedAuditingPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_id: Optional[str] = None,
        enabled: Optional[bool] = 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) -> DatabaseExtendedAuditingPolicy
func GetDatabaseExtendedAuditingPolicy(ctx *Context, name string, id IDInput, state *DatabaseExtendedAuditingPolicyState, opts ...ResourceOption) (*DatabaseExtendedAuditingPolicy, error)
public static DatabaseExtendedAuditingPolicy Get(string name, Input<string> id, DatabaseExtendedAuditingPolicyState? state, CustomResourceOptions? opts = null)
public static DatabaseExtendedAuditingPolicy get(String name, Output<String> id, DatabaseExtendedAuditingPolicyState state, CustomResourceOptions options)
resources:  _:    type: azure:mssql:DatabaseExtendedAuditingPolicy    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:
DatabaseId Changes to this property will trigger replacement. string
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
Enabled bool

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

LogMonitoringEnabled bool

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
DatabaseId Changes to this property will trigger replacement. string
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
Enabled bool

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

LogMonitoringEnabled bool

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
databaseId Changes to this property will trigger replacement. String
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled Boolean

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

logMonitoringEnabled Boolean

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
databaseId Changes to this property will trigger replacement. string
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled boolean

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

logMonitoringEnabled boolean

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
database_id Changes to this property will trigger replacement. str
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled bool

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

log_monitoring_enabled bool

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.
databaseId Changes to this property will trigger replacement. String
The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
enabled Boolean

Whether to enable the extended auditing policy. Possible values are true and false. Defaults to true.

->NOTE: If enabled is true, storage_endpoint or log_monitoring_enabled are required.

logMonitoringEnabled Boolean

Enable audit events to Azure Monitor? Defaults to true.

NOTE: To enable sending audit events to Log Analytics, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_log_analytics directory within the GitHub Repository. To enable sending server audit events to Log Analytics, please enable the master database to send audit events to Log Analytics. To enable audit events to Eventhub, please refer to the example which can be found in the ./examples/sql-azure/sql_auditing_eventhub directory within the GitHub Repository.

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.

Import

MS SQL Database Extended Auditing Policies can be imported using the resource id, e.g.

$ pulumi import azure:mssql/databaseExtendedAuditingPolicy:DatabaseExtendedAuditingPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Sql/servers/sqlServer1/databases/db1/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.