All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.azurenative.sql.kotlin.outputs.GetDatabaseBlobAuditingPolicyResult.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 2.82.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azurenative.sql.kotlin.outputs

import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List

/**
 * A database blob auditing policy.
 * @property auditActionsAndGroups Specifies the Actions-Groups and Actions to audit.
 * The recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:
 * BATCH_COMPLETED_GROUP,
 * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
 * FAILED_DATABASE_AUTHENTICATION_GROUP.
 * This above combination is also the set that is configured by default when enabling auditing from the Azure portal.
 * The supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):
 * APPLICATION_ROLE_CHANGE_PASSWORD_GROUP
 * BACKUP_RESTORE_GROUP
 * DATABASE_LOGOUT_GROUP
 * DATABASE_OBJECT_CHANGE_GROUP
 * DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP
 * DATABASE_OBJECT_PERMISSION_CHANGE_GROUP
 * DATABASE_OPERATION_GROUP
 * DATABASE_PERMISSION_CHANGE_GROUP
 * DATABASE_PRINCIPAL_CHANGE_GROUP
 * DATABASE_PRINCIPAL_IMPERSONATION_GROUP
 * DATABASE_ROLE_MEMBER_CHANGE_GROUP
 * FAILED_DATABASE_AUTHENTICATION_GROUP
 * SCHEMA_OBJECT_ACCESS_GROUP
 * SCHEMA_OBJECT_CHANGE_GROUP
 * SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP
 * SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP
 * SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP
 * USER_CHANGE_PASSWORD_GROUP
 * BATCH_STARTED_GROUP
 * BATCH_COMPLETED_GROUP
 * DBCC_GROUP
 * DATABASE_OWNERSHIP_CHANGE_GROUP
 * DATABASE_CHANGE_GROUP
 * LEDGER_OPERATION_GROUP
 * These are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.
 * For more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).
 * For Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:
 * SELECT
 * UPDATE
 * INSERT
 * DELETE
 * EXECUTE
 * RECEIVE
 * REFERENCES
 * The general form for defining an action to be audited is:
 * {action} ON {object} BY {principal}
 * Note that  in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.
 * For example:
 * SELECT on dbo.myTable by public
 * SELECT on DATABASE::myDatabase by public
 * SELECT on SCHEMA::mySchema by public
 * For more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)
 * @property id Resource ID.
 * @property isAzureMonitorTargetEnabled Specifies whether audit events are sent to Azure Monitor.
 * In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.
 * When using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.
 * Note that for server level audit you should use the 'master' database as {databaseName}.
 * Diagnostic Settings URI format:
 * PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview
 * For more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)
 * or [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)
 * @property isManagedIdentityInUse Specifies whether Managed Identity is used to access blob storage
 * @property isStorageSecondaryKeyInUse Specifies whether storageAccountAccessKey value is the storage's secondary key.
 * @property kind Resource kind.
 * @property name Resource name.
 * @property queueDelayMs Specifies the amount of time in milliseconds that can elapse before audit actions are forced to be processed.
 * The default minimum value is 1000 (1 second). The maximum is 2,147,483,647.
 * @property retentionDays Specifies the number of days to keep in the audit logs in the storage account.
 * @property state Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
 * @property storageAccountSubscriptionId Specifies the blob storage subscription Id.
 * @property storageEndpoint Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
 * @property type Resource type.
 */
public data class GetDatabaseBlobAuditingPolicyResult(
    public val auditActionsAndGroups: List? = null,
    public val id: String,
    public val isAzureMonitorTargetEnabled: Boolean? = null,
    public val isManagedIdentityInUse: Boolean? = null,
    public val isStorageSecondaryKeyInUse: Boolean? = null,
    public val kind: String,
    public val name: String,
    public val queueDelayMs: Int? = null,
    public val retentionDays: Int? = null,
    public val state: String,
    public val storageAccountSubscriptionId: String? = null,
    public val storageEndpoint: String? = null,
    public val type: String,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.azurenative.sql.outputs.GetDatabaseBlobAuditingPolicyResult): GetDatabaseBlobAuditingPolicyResult = GetDatabaseBlobAuditingPolicyResult(
            auditActionsAndGroups = javaType.auditActionsAndGroups().map({ args0 -> args0 }),
            id = javaType.id(),
            isAzureMonitorTargetEnabled = javaType.isAzureMonitorTargetEnabled().map({ args0 ->
                args0
            }).orElse(null),
            isManagedIdentityInUse = javaType.isManagedIdentityInUse().map({ args0 -> args0 }).orElse(null),
            isStorageSecondaryKeyInUse = javaType.isStorageSecondaryKeyInUse().map({ args0 ->
                args0
            }).orElse(null),
            kind = javaType.kind(),
            name = javaType.name(),
            queueDelayMs = javaType.queueDelayMs().map({ args0 -> args0 }).orElse(null),
            retentionDays = javaType.retentionDays().map({ args0 -> args0 }).orElse(null),
            state = javaType.state(),
            storageAccountSubscriptionId = javaType.storageAccountSubscriptionId().map({ args0 ->
                args0
            }).orElse(null),
            storageEndpoint = javaType.storageEndpoint().map({ args0 -> args0 }).orElse(null),
            type = javaType.type(),
        )
    }
}