com.pulumi.azure.mssql.kotlin.DatabaseExtendedAuditingPolicyArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.mssql.kotlin
import com.pulumi.azure.mssql.DatabaseExtendedAuditingPolicyArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* Manages a MS SQL Database Extended Auditing Policy.
* ## Example Usage
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/mssql"
* "github.com/pulumi/pulumi-azure/sdk/v5/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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## Import
* MS SQL Database Extended Auditing Policies can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:mssql/databaseExtendedAuditingPolicy:DatabaseExtendedAuditingPolicy example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Sql/servers/sqlServer1/databases/db1/extendedAuditingSettings/default
* ```
* @property databaseId The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
* @property enabled 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.
* @property logMonitoringEnabled 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.
* @property retentionInDays The number of days to retain logs for in the storage account. Defaults to `0`.
* @property storageAccountAccessKey The access key to use for the auditing storage account.
* @property storageAccountAccessKeyIsSecondary Is `storage_account_access_key` value the storage's secondary key?
* @property storageEndpoint The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs.
*/
public data class DatabaseExtendedAuditingPolicyArgs(
public val databaseId: Output? = null,
public val enabled: Output? = null,
public val logMonitoringEnabled: Output? = null,
public val retentionInDays: Output? = null,
public val storageAccountAccessKey: Output? = null,
public val storageAccountAccessKeyIsSecondary: Output? = null,
public val storageEndpoint: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.mssql.DatabaseExtendedAuditingPolicyArgs =
com.pulumi.azure.mssql.DatabaseExtendedAuditingPolicyArgs.builder()
.databaseId(databaseId?.applyValue({ args0 -> args0 }))
.enabled(enabled?.applyValue({ args0 -> args0 }))
.logMonitoringEnabled(logMonitoringEnabled?.applyValue({ args0 -> args0 }))
.retentionInDays(retentionInDays?.applyValue({ args0 -> args0 }))
.storageAccountAccessKey(storageAccountAccessKey?.applyValue({ args0 -> args0 }))
.storageAccountAccessKeyIsSecondary(
storageAccountAccessKeyIsSecondary?.applyValue({ args0 ->
args0
}),
)
.storageEndpoint(storageEndpoint?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [DatabaseExtendedAuditingPolicyArgs].
*/
@PulumiTagMarker
public class DatabaseExtendedAuditingPolicyArgsBuilder internal constructor() {
private var databaseId: Output? = null
private var enabled: Output? = null
private var logMonitoringEnabled: Output? = null
private var retentionInDays: Output? = null
private var storageAccountAccessKey: Output? = null
private var storageAccountAccessKeyIsSecondary: Output? = null
private var storageEndpoint: Output? = null
/**
* @param value The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
*/
@JvmName("dytfsjunssnnsyhy")
public suspend fun databaseId(`value`: Output) {
this.databaseId = value
}
/**
* @param value 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.
*/
@JvmName("cuyxkyhvqkjklvfb")
public suspend fun enabled(`value`: Output) {
this.enabled = value
}
/**
* @param value 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.
*/
@JvmName("rglwgkddhylwahcn")
public suspend fun logMonitoringEnabled(`value`: Output) {
this.logMonitoringEnabled = value
}
/**
* @param value The number of days to retain logs for in the storage account. Defaults to `0`.
*/
@JvmName("urvjvncphvmvopgm")
public suspend fun retentionInDays(`value`: Output) {
this.retentionInDays = value
}
/**
* @param value The access key to use for the auditing storage account.
*/
@JvmName("iqxktdjgerkwmqbi")
public suspend fun storageAccountAccessKey(`value`: Output) {
this.storageAccountAccessKey = value
}
/**
* @param value Is `storage_account_access_key` value the storage's secondary key?
*/
@JvmName("qqlgrbsfoghcxfsr")
public suspend fun storageAccountAccessKeyIsSecondary(`value`: Output) {
this.storageAccountAccessKeyIsSecondary = value
}
/**
* @param value The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs.
*/
@JvmName("jpfckfehxckdkmmw")
public suspend fun storageEndpoint(`value`: Output) {
this.storageEndpoint = value
}
/**
* @param value The ID of the SQL database to set the extended auditing policy. Changing this forces a new resource to be created.
*/
@JvmName("fwdmdlpqsikfjcig")
public suspend fun databaseId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.databaseId = mapped
}
/**
* @param value 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.
*/
@JvmName("ofjlkgpvpqjiipov")
public suspend fun enabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enabled = mapped
}
/**
* @param value 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.
*/
@JvmName("mgoowtdbdchwmmfd")
public suspend fun logMonitoringEnabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.logMonitoringEnabled = mapped
}
/**
* @param value The number of days to retain logs for in the storage account. Defaults to `0`.
*/
@JvmName("jaebnektffjjmbat")
public suspend fun retentionInDays(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.retentionInDays = mapped
}
/**
* @param value The access key to use for the auditing storage account.
*/
@JvmName("cjjekgybppqftwpl")
public suspend fun storageAccountAccessKey(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.storageAccountAccessKey = mapped
}
/**
* @param value Is `storage_account_access_key` value the storage's secondary key?
*/
@JvmName("dairodqqvmmbxusl")
public suspend fun storageAccountAccessKeyIsSecondary(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.storageAccountAccessKeyIsSecondary = mapped
}
/**
* @param value The blob storage endpoint (e.g. ). This blob storage will hold all extended auditing logs.
*/
@JvmName("fmmlfgrxraexdecp")
public suspend fun storageEndpoint(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.storageEndpoint = mapped
}
internal fun build(): DatabaseExtendedAuditingPolicyArgs = DatabaseExtendedAuditingPolicyArgs(
databaseId = databaseId,
enabled = enabled,
logMonitoringEnabled = logMonitoringEnabled,
retentionInDays = retentionInDays,
storageAccountAccessKey = storageAccountAccessKey,
storageAccountAccessKeyIsSecondary = storageAccountAccessKeyIsSecondary,
storageEndpoint = storageEndpoint,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy