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

We recommend using Azure Native.

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

azure.mssql.ServerExtendedAuditingPolicy

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 MS SQL Server 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 exampleAccount = new azure.storage.Account("example", {
    name: "examplesa",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleServerExtendedAuditingPolicy = new azure.mssql.ServerExtendedAuditingPolicy("example", {
    serverId: exampleServer.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_account = azure.storage.Account("example",
    name="examplesa",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_server_extended_auditing_policy = azure.mssql.ServerExtendedAuditingPolicy("example",
    server_id=example_server.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
		}
		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.NewServerExtendedAuditingPolicy(ctx, "example", &mssql.ServerExtendedAuditingPolicyArgs{
			ServerId:                           exampleServer.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 exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "examplesa",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleServerExtendedAuditingPolicy = new Azure.MSSql.ServerExtendedAuditingPolicy("example", new()
    {
        ServerId = exampleServer.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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.mssql.ServerExtendedAuditingPolicy;
import com.pulumi.azure.mssql.ServerExtendedAuditingPolicyArgs;
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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("examplesa")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleServerExtendedAuditingPolicy = new ServerExtendedAuditingPolicy("exampleServerExtendedAuditingPolicy", ServerExtendedAuditingPolicyArgs.builder()
            .serverId(exampleServer.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!
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplesa
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleServerExtendedAuditingPolicy:
    type: azure:mssql:ServerExtendedAuditingPolicy
    name: example
    properties:
      serverId: ${exampleServer.id}
      storageEndpoint: ${exampleAccount.primaryBlobEndpoint}
      storageAccountAccessKey: ${exampleAccount.primaryAccessKey}
      storageAccountAccessKeyIsSecondary: false
      retentionInDays: 6
Copy

With Storage Account Behind VNet And Firewall

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    name: example
    properties:
      name: example
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: virtnetname-1
      addressSpaces:
        - 10.0.0.0/16
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: subnetname-1
      resourceGroupName: ${exampleResourceGroup.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 10.0.2.0/24
      serviceEndpoints:
        - Microsoft.Sql
        - Microsoft.Storage
      enforcePrivateLinkEndpointNetworkPolicies: true
  exampleAssignment:
    type: azure:authorization:Assignment
    name: example
    properties:
      scope: ${primary.id}
      roleDefinitionName: Storage Blob Data Contributor
      principalId: ${exampleServer.identity.principalId}
  exampleServer:
    type: azure:mssql:Server
    name: example
    properties:
      name: example-sqlserver
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      version: '12.0'
      administratorLogin: missadministrator
      administratorLoginPassword: AdminPassword123!
      minimumTlsVersion: '1.2'
      identity:
        type: SystemAssigned
  sqlvnetrule:
    type: azurerm:sqlVirtualNetworkRule
    properties:
      name: sql-vnet-rule
      resourceGroupName: ${exampleResourceGroup.name}
      serverName: ${exampleServer.name}
      subnetId: ${exampleSubnet.id}
  exampleSqlFirewallRule:
    type: azurerm:sqlFirewallRule
    name: example
    properties:
      name: FirewallRule1
      resourceGroupName: ${exampleResourceGroup.name}
      serverName: ${exampleServer.name}
      startIpAddress: 0.0.0.0
      endIpAddress: 0.0.0.0
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: examplesa
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
      accountTier: Standard
      accountReplicationType: LRS
      accountKind: StorageV2
      allowNestedItemsToBePublic: false
      networkRules:
        defaultAction: Deny
        ipRules:
          - 127.0.0.1
        virtualNetworkSubnetIds:
          - ${exampleSubnet.id}
        bypasses:
          - AzureServices
      identity:
        type: SystemAssigned
  exampleServerExtendedAuditingPolicy:
    type: azure:mssql:ServerExtendedAuditingPolicy
    name: example
    properties:
      storageEndpoint: ${exampleAccount.primaryBlobEndpoint}
      serverId: ${exampleServer.id}
      retentionInDays: 6
      logMonitoringEnabled: false
      storageAccountSubscriptionId: ${primaryAzurermSubscription.subscriptionId}
    options:
      dependsOn:
        - ${exampleAssignment}
        - ${exampleAccount}
variables:
  primary:
    fn::invoke:
      function: azure:core:getSubscription
      arguments: {}
  example:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

Create ServerExtendedAuditingPolicy Resource

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

Constructor syntax

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

@overload
def ServerExtendedAuditingPolicy(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 server_id: Optional[str] = None,
                                 audit_actions_and_groups: Optional[Sequence[str]] = None,
                                 enabled: Optional[bool] = None,
                                 log_monitoring_enabled: Optional[bool] = None,
                                 predicate_expression: Optional[str] = None,
                                 retention_in_days: Optional[int] = None,
                                 storage_account_access_key: Optional[str] = None,
                                 storage_account_access_key_is_secondary: Optional[bool] = None,
                                 storage_account_subscription_id: Optional[str] = None,
                                 storage_endpoint: Optional[str] = None)
func NewServerExtendedAuditingPolicy(ctx *Context, name string, args ServerExtendedAuditingPolicyArgs, opts ...ResourceOption) (*ServerExtendedAuditingPolicy, error)
public ServerExtendedAuditingPolicy(string name, ServerExtendedAuditingPolicyArgs args, CustomResourceOptions? opts = null)
public ServerExtendedAuditingPolicy(String name, ServerExtendedAuditingPolicyArgs args)
public ServerExtendedAuditingPolicy(String name, ServerExtendedAuditingPolicyArgs args, CustomResourceOptions options)

type: azure:mssql:ServerExtendedAuditingPolicy
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. ServerExtendedAuditingPolicyArgs
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. ServerExtendedAuditingPolicyArgs
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. ServerExtendedAuditingPolicyArgs
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. ServerExtendedAuditingPolicyArgs
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. ServerExtendedAuditingPolicyArgs
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 serverExtendedAuditingPolicyResource = new Azure.MSSql.ServerExtendedAuditingPolicy("serverExtendedAuditingPolicyResource", new()
{
    ServerId = "string",
    AuditActionsAndGroups = new[]
    {
        "string",
    },
    Enabled = false,
    LogMonitoringEnabled = false,
    PredicateExpression = "string",
    RetentionInDays = 0,
    StorageAccountAccessKey = "string",
    StorageAccountAccessKeyIsSecondary = false,
    StorageAccountSubscriptionId = "string",
    StorageEndpoint = "string",
});
Copy
example, err := mssql.NewServerExtendedAuditingPolicy(ctx, "serverExtendedAuditingPolicyResource", &mssql.ServerExtendedAuditingPolicyArgs{
	ServerId: pulumi.String("string"),
	AuditActionsAndGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Enabled:                            pulumi.Bool(false),
	LogMonitoringEnabled:               pulumi.Bool(false),
	PredicateExpression:                pulumi.String("string"),
	RetentionInDays:                    pulumi.Int(0),
	StorageAccountAccessKey:            pulumi.String("string"),
	StorageAccountAccessKeyIsSecondary: pulumi.Bool(false),
	StorageAccountSubscriptionId:       pulumi.String("string"),
	StorageEndpoint:                    pulumi.String("string"),
})
Copy
var serverExtendedAuditingPolicyResource = new ServerExtendedAuditingPolicy("serverExtendedAuditingPolicyResource", ServerExtendedAuditingPolicyArgs.builder()
    .serverId("string")
    .auditActionsAndGroups("string")
    .enabled(false)
    .logMonitoringEnabled(false)
    .predicateExpression("string")
    .retentionInDays(0)
    .storageAccountAccessKey("string")
    .storageAccountAccessKeyIsSecondary(false)
    .storageAccountSubscriptionId("string")
    .storageEndpoint("string")
    .build());
Copy
server_extended_auditing_policy_resource = azure.mssql.ServerExtendedAuditingPolicy("serverExtendedAuditingPolicyResource",
    server_id="string",
    audit_actions_and_groups=["string"],
    enabled=False,
    log_monitoring_enabled=False,
    predicate_expression="string",
    retention_in_days=0,
    storage_account_access_key="string",
    storage_account_access_key_is_secondary=False,
    storage_account_subscription_id="string",
    storage_endpoint="string")
Copy
const serverExtendedAuditingPolicyResource = new azure.mssql.ServerExtendedAuditingPolicy("serverExtendedAuditingPolicyResource", {
    serverId: "string",
    auditActionsAndGroups: ["string"],
    enabled: false,
    logMonitoringEnabled: false,
    predicateExpression: "string",
    retentionInDays: 0,
    storageAccountAccessKey: "string",
    storageAccountAccessKeyIsSecondary: false,
    storageAccountSubscriptionId: "string",
    storageEndpoint: "string",
});
Copy
type: azure:mssql:ServerExtendedAuditingPolicy
properties:
    auditActionsAndGroups:
        - string
    enabled: false
    logMonitoringEnabled: false
    predicateExpression: string
    retentionInDays: 0
    serverId: string
    storageAccountAccessKey: string
    storageAccountAccessKeyIsSecondary: false
    storageAccountSubscriptionId: string
    storageEndpoint: string
Copy

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

ServerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SQL Server to set the extended auditing policy. Changing this forces a new resource to be created.
AuditActionsAndGroups List<string>
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
PredicateExpression string
Specifies condition of where clause when creating an audit.
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?
StorageAccountSubscriptionId string
The ID of the Subscription containing the Storage Account.
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
ServerId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SQL Server to set the extended auditing policy. Changing this forces a new resource to be created.
AuditActionsAndGroups []string
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
PredicateExpression string
Specifies condition of where clause when creating an audit.
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?
StorageAccountSubscriptionId string
The ID of the Subscription containing the Storage Account.
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
serverId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SQL Server to set the extended auditing policy. Changing this forces a new resource to be created.
auditActionsAndGroups List<String>
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicateExpression String
Specifies condition of where clause when creating an audit.
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?
storageAccountSubscriptionId String
The ID of the Subscription containing the Storage Account.
storageEndpoint String
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
serverId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SQL Server to set the extended auditing policy. Changing this forces a new resource to be created.
auditActionsAndGroups string[]
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicateExpression string
Specifies condition of where clause when creating an audit.
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?
storageAccountSubscriptionId string
The ID of the Subscription containing the Storage Account.
storageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
server_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the SQL Server to set the extended auditing policy. Changing this forces a new resource to be created.
audit_actions_and_groups Sequence[str]
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicate_expression str
Specifies condition of where clause when creating an audit.
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_account_subscription_id str
The ID of the Subscription containing the Storage Account.
storage_endpoint str
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
serverId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SQL Server to set the extended auditing policy. Changing this forces a new resource to be created.
auditActionsAndGroups List<String>
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicateExpression String
Specifies condition of where clause when creating an audit.
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?
storageAccountSubscriptionId String
The ID of the Subscription containing the Storage Account.
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 ServerExtendedAuditingPolicy 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 ServerExtendedAuditingPolicy Resource

Get an existing ServerExtendedAuditingPolicy 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?: ServerExtendedAuditingPolicyState, opts?: CustomResourceOptions): ServerExtendedAuditingPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_actions_and_groups: Optional[Sequence[str]] = None,
        enabled: Optional[bool] = None,
        log_monitoring_enabled: Optional[bool] = None,
        predicate_expression: Optional[str] = None,
        retention_in_days: Optional[int] = None,
        server_id: Optional[str] = None,
        storage_account_access_key: Optional[str] = None,
        storage_account_access_key_is_secondary: Optional[bool] = None,
        storage_account_subscription_id: Optional[str] = None,
        storage_endpoint: Optional[str] = None) -> ServerExtendedAuditingPolicy
func GetServerExtendedAuditingPolicy(ctx *Context, name string, id IDInput, state *ServerExtendedAuditingPolicyState, opts ...ResourceOption) (*ServerExtendedAuditingPolicy, error)
public static ServerExtendedAuditingPolicy Get(string name, Input<string> id, ServerExtendedAuditingPolicyState? state, CustomResourceOptions? opts = null)
public static ServerExtendedAuditingPolicy get(String name, Output<String> id, ServerExtendedAuditingPolicyState state, CustomResourceOptions options)
resources:  _:    type: azure:mssql:ServerExtendedAuditingPolicy    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:
AuditActionsAndGroups List<string>
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
PredicateExpression string
Specifies condition of where clause when creating an audit.
RetentionInDays int
The number of days to retain logs for in the storage account. Defaults to 0.
ServerId Changes to this property will trigger replacement. string
The ID of the SQL Server 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?
StorageAccountSubscriptionId string
The ID of the Subscription containing the Storage Account.
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
AuditActionsAndGroups []string
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
PredicateExpression string
Specifies condition of where clause when creating an audit.
RetentionInDays int
The number of days to retain logs for in the storage account. Defaults to 0.
ServerId Changes to this property will trigger replacement. string
The ID of the SQL Server 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?
StorageAccountSubscriptionId string
The ID of the Subscription containing the Storage Account.
StorageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
auditActionsAndGroups List<String>
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicateExpression String
Specifies condition of where clause when creating an audit.
retentionInDays Integer
The number of days to retain logs for in the storage account. Defaults to 0.
serverId Changes to this property will trigger replacement. String
The ID of the SQL Server 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?
storageAccountSubscriptionId String
The ID of the Subscription containing the Storage Account.
storageEndpoint String
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
auditActionsAndGroups string[]
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicateExpression string
Specifies condition of where clause when creating an audit.
retentionInDays number
The number of days to retain logs for in the storage account. Defaults to 0.
serverId Changes to this property will trigger replacement. string
The ID of the SQL Server 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?
storageAccountSubscriptionId string
The ID of the Subscription containing the Storage Account.
storageEndpoint string
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
audit_actions_and_groups Sequence[str]
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicate_expression str
Specifies condition of where clause when creating an audit.
retention_in_days int
The number of days to retain logs for in the storage account. Defaults to 0.
server_id Changes to this property will trigger replacement. str
The ID of the SQL Server 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_account_subscription_id str
The ID of the Subscription containing the Storage Account.
storage_endpoint str
The blob storage endpoint (e.g. https://example.blob.core.windows.net). This blob storage will hold all extended auditing logs.
auditActionsAndGroups List<String>
A list of Actions-Groups and Actions to audit.
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? To enable server audit events to Azure Monitor, please enable its main database audit events to Azure Monitor. Defaults to true.
predicateExpression String
Specifies condition of where clause when creating an audit.
retentionInDays Number
The number of days to retain logs for in the storage account. Defaults to 0.
serverId Changes to this property will trigger replacement. String
The ID of the SQL Server 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?
storageAccountSubscriptionId String
The ID of the Subscription containing the Storage Account.
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 Server Extended Auditing Policies can be imported using the resource id, e.g.

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