ExtendedServerBlobAuditingPolicy Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ExtendedServerBlobAuditingPolicy() |
Initializes a new instance of the ExtendedServerBlobAuditingPolicy class. |
| ExtendedServerBlobAuditingPolicy(BlobAuditingPolicyState, String, String, String, String, String, String, Nullable<Int32>, IList<String>, Nullable<Guid>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>) |
Initializes a new instance of the ExtendedServerBlobAuditingPolicy class. |
ExtendedServerBlobAuditingPolicy()
Initializes a new instance of the ExtendedServerBlobAuditingPolicy class.
public ExtendedServerBlobAuditingPolicy ();Public Sub New ()Applies to
ExtendedServerBlobAuditingPolicy(BlobAuditingPolicyState, String, String, String, String, String, String, Nullable<Int32>, IList<String>, Nullable<Guid>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>)
Initializes a new instance of the ExtendedServerBlobAuditingPolicy class.
public ExtendedServerBlobAuditingPolicy (Microsoft.Azure.Management.Synapse.Models.BlobAuditingPolicyState state, string id = default, string name = default, string type = default, string predicateExpression = default, string storageEndpoint = default, string storageAccountAccessKey = default, int? retentionDays = default, System.Collections.Generic.IList<string> auditActionsAndGroups = default, Guid? storageAccountSubscriptionId = default, bool? isStorageSecondaryKeyInUse = default, bool? isAzureMonitorTargetEnabled = default, int? queueDelayMs = default);new Microsoft.Azure.Management.Synapse.Models.ExtendedServerBlobAuditingPolicy : Microsoft.Azure.Management.Synapse.Models.BlobAuditingPolicyState * string * string * string * string * string * string * Nullable<int> * System.Collections.Generic.IList<string> * Nullable<Guid> * Nullable<bool> * Nullable<bool> * Nullable<int> -> Microsoft.Azure.Management.Synapse.Models.ExtendedServerBlobAuditingPolicyPublic Sub New (state As BlobAuditingPolicyState, Optional id As String = Nothing, Optional name As String = Nothing, Optional type As String = Nothing, Optional predicateExpression As String = Nothing, Optional storageEndpoint As String = Nothing, Optional storageAccountAccessKey As String = Nothing, Optional retentionDays As Nullable(Of Integer) = Nothing, Optional auditActionsAndGroups As IList(Of String) = Nothing, Optional storageAccountSubscriptionId As Nullable(Of Guid) = Nothing, Optional isStorageSecondaryKeyInUse As Nullable(Of Boolean) = Nothing, Optional isAzureMonitorTargetEnabled As Nullable(Of Boolean) = Nothing, Optional queueDelayMs As Nullable(Of Integer) = Nothing)Parameters
- state
- BlobAuditingPolicyState
Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Possible values include: 'Enabled', 'Disabled'
- id
- String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name
- String
The name of the resource
- type
- String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- predicateExpression
- String
Specifies condition of where clause when creating an audit.
- storageEndpoint
- String
Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
- storageAccountAccessKey
- String
Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication: 1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). 2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication
Specifies the number of days to keep in the audit logs in the storage account.
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](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 <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](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)
Specifies whether storageAccountAccessKey value is the storage's secondary key.
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)
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.
