ArmSynapseModelFactory.SynapseSqlPoolBlobAuditingPolicyData Method

Definition

Namespace:

Azure.ResourceManager.Synapse.Models

Assembly:

Azure.ResourceManager.Synapse.dll

Package:

Azure.ResourceManager.Synapse v1.2.0

Source:

ArmSynapseModelFactory.cs

Initializes a new instance of SynapseSqlPoolBlobAuditingPolicyData.

public static Azure.ResourceManager.Synapse.SynapseSqlPoolBlobAuditingPolicyData SynapseSqlPoolBlobAuditingPolicyData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, string kind = default, Azure.ResourceManager.Synapse.Models.SynapseBlobAuditingPolicyState? state = default, string storageEndpoint = default, string storageAccountAccessKey = default, int? retentionDays = default, System.Collections.Generic.IEnumerable<string> auditActionsAndGroups = default, Guid? storageAccountSubscriptionId = default, bool? isStorageSecondaryKeyInUse = default, bool? isAzureMonitorTargetEnabled = default);

static member SynapseSqlPoolBlobAuditingPolicyData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * string * Nullable<Azure.ResourceManager.Synapse.Models.SynapseBlobAuditingPolicyState> * string * string * Nullable<int> * seq<string> * Nullable<Guid> * Nullable<bool> * Nullable<bool> -> Azure.ResourceManager.Synapse.SynapseSqlPoolBlobAuditingPolicyData

Public Shared Function SynapseSqlPoolBlobAuditingPolicyData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional kind As String = Nothing, Optional state As Nullable(Of SynapseBlobAuditingPolicyState) = Nothing, Optional storageEndpoint As String = Nothing, Optional storageAccountAccessKey As String = Nothing, Optional retentionDays As Nullable(Of Integer) = Nothing, Optional auditActionsAndGroups As IEnumerable(Of String) = Nothing, Optional storageAccountSubscriptionId As Nullable(Of Guid) = Nothing, Optional isStorageSecondaryKeyInUse As Nullable(Of Boolean) = Nothing, Optional isAzureMonitorTargetEnabled As Nullable(Of Boolean) = Nothing) As SynapseSqlPoolBlobAuditingPolicyData

Parameters

id

ResourceIdentifier

The id.

name

String

The name.

resourceType

ResourceType

The resourceType.

systemData

SystemData

The systemData.

kind

String

Resource kind.

state

Nullable<SynapseBlobAuditingPolicyState>

Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

storageEndpoint

String

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.

storageAccountAccessKey

String

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.

retentionDays

Nullable<Int32>

Specifies the number of days to keep in the audit logs in the storage account.

auditActionsAndGroups

IEnumerable<String>

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

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.

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 <object> 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

storageAccountSubscriptionId

Nullable<Guid>

Specifies the blob storage subscription Id.

isStorageSecondaryKeyInUse

Nullable<Boolean>

Specifies whether storageAccountAccessKey value is the storage's secondary key.

isAzureMonitorTargetEnabled

Nullable<Boolean>

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 or Diagnostic Settings PowerShell

Returns

SynapseSqlPoolBlobAuditingPolicyData

A new SynapseSqlPoolBlobAuditingPolicyData instance for mocking.