ExtendedDatabaseBlobAuditingPolicyProperties Class
- java.
lang. Object - com.
azure. resourcemanager. sql. fluent. models. ExtendedDatabaseBlobAuditingPolicyProperties
- com.
Implements
public final class ExtendedDatabaseBlobAuditingPolicyProperties
implements JsonSerializable<ExtendedDatabaseBlobAuditingPolicyProperties>
Properties of an extended database blob auditing policy.
Constructor Summary
| Constructor | Description |
|---|---|
| ExtendedDatabaseBlobAuditingPolicyProperties() |
Creates an instance of Extended |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| List<String> |
auditActionsAndGroups()
Get the audit |
|
static
Extended |
fromJson(JsonReader jsonReader)
Reads an instance of Extended |
| Boolean |
isAzureMonitorTargetEnabled()
Get the is |
| Boolean |
isManagedIdentityInUse()
Get the is |
| Boolean |
isStorageSecondaryKeyInUse()
Get the is |
| String |
predicateExpression()
Get the predicate |
| Integer |
queueDelayMs()
Get the queue |
| Integer |
retentionDays()
Get the retention |
|
Blob |
state()
Get the state property: Specifies the state of the audit. |
| String |
storageAccountAccessKey()
Get the storage |
| UUID |
storageAccountSubscriptionId()
Get the storage |
| String |
storageEndpoint()
Get the storage |
|
Json |
toJson(JsonWriter jsonWriter) |
| void |
validate()
Validates the instance. |
|
Extended |
withAuditActionsAndGroups(List<String> auditActionsAndGroups)
Set the audit |
|
Extended |
withIsAzureMonitorTargetEnabled(Boolean isAzureMonitorTargetEnabled)
Set the is |
|
Extended |
withIsManagedIdentityInUse(Boolean isManagedIdentityInUse)
Set the is |
|
Extended |
withIsStorageSecondaryKeyInUse(Boolean isStorageSecondaryKeyInUse)
Set the is |
|
Extended |
withPredicateExpression(String predicateExpression)
Set the predicate |
|
Extended |
withQueueDelayMs(Integer queueDelayMs)
Set the queue |
|
Extended |
withRetentionDays(Integer retentionDays)
Set the retention |
|
Extended |
withState(BlobAuditingPolicyState state)
Set the state property: Specifies the state of the audit. |
|
Extended |
withStorageAccountAccessKey(String storageAccountAccessKey)
Set the storage |
|
Extended |
withStorageAccountSubscriptionId(UUID storageAccountSubscriptionId)
Set the storage |
|
Extended |
withStorageEndpoint(String storageEndpoint)
Set the storage |
Methods inherited from java.lang.Object
Constructor Details
ExtendedDatabaseBlobAuditingPolicyProperties
public ExtendedDatabaseBlobAuditingPolicyProperties()
Creates an instance of ExtendedDatabaseBlobAuditingPolicyProperties class.
Method Details
auditActionsAndGroups
public List<String> auditActionsAndGroups()
Get the auditActionsAndGroups property: 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 <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).
Returns:
fromJson
public static ExtendedDatabaseBlobAuditingPolicyProperties fromJson(JsonReader jsonReader)
Reads an instance of ExtendedDatabaseBlobAuditingPolicyProperties from the JsonReader.
Parameters:
Returns:
Throws:
isAzureMonitorTargetEnabled
public Boolean isAzureMonitorTargetEnabled()
Get the isAzureMonitorTargetEnabled property: 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).
Returns:
isManagedIdentityInUse
public Boolean isManagedIdentityInUse()
Get the isManagedIdentityInUse property: Specifies whether Managed Identity is used to access blob storage.
Returns:
isStorageSecondaryKeyInUse
public Boolean isStorageSecondaryKeyInUse()
Get the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.
Returns:
predicateExpression
public String predicateExpression()
Get the predicateExpression property: Specifies condition of where clause when creating an audit.
Returns:
queueDelayMs
public Integer queueDelayMs()
Get the queueDelayMs property: 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.
Returns:
retentionDays
public Integer retentionDays()
Get the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.
Returns:
state
public BlobAuditingPolicyState state()
Get the state property: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
Returns:
storageAccountAccessKey
public String storageAccountAccessKey()
Get the storageAccountAccessKey property: 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](https://go.microsoft.com/fwlink/?linkid=2114355).
Returns:
storageAccountSubscriptionId
public UUID storageAccountSubscriptionId()
Get the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.
Returns:
storageEndpoint
public String storageEndpoint()
Get the storageEndpoint property: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
Returns:
toJson
validate
public void validate()
Validates the instance.
withAuditActionsAndGroups
public ExtendedDatabaseBlobAuditingPolicyProperties withAuditActionsAndGroups(List<String> auditActionsAndGroups)
Set the auditActionsAndGroups property: 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 <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).
Parameters:
Returns:
withIsAzureMonitorTargetEnabled
public ExtendedDatabaseBlobAuditingPolicyProperties withIsAzureMonitorTargetEnabled(Boolean isAzureMonitorTargetEnabled)
Set the isAzureMonitorTargetEnabled property: 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).
Parameters:
Returns:
withIsManagedIdentityInUse
public ExtendedDatabaseBlobAuditingPolicyProperties withIsManagedIdentityInUse(Boolean isManagedIdentityInUse)
Set the isManagedIdentityInUse property: Specifies whether Managed Identity is used to access blob storage.
Parameters:
Returns:
withIsStorageSecondaryKeyInUse
public ExtendedDatabaseBlobAuditingPolicyProperties withIsStorageSecondaryKeyInUse(Boolean isStorageSecondaryKeyInUse)
Set the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.
Parameters:
Returns:
withPredicateExpression
public ExtendedDatabaseBlobAuditingPolicyProperties withPredicateExpression(String predicateExpression)
Set the predicateExpression property: Specifies condition of where clause when creating an audit.
Parameters:
Returns:
withQueueDelayMs
public ExtendedDatabaseBlobAuditingPolicyProperties withQueueDelayMs(Integer queueDelayMs)
Set the queueDelayMs property: 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.
Parameters:
Returns:
withRetentionDays
public ExtendedDatabaseBlobAuditingPolicyProperties withRetentionDays(Integer retentionDays)
Set the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.
Parameters:
Returns:
withState
public ExtendedDatabaseBlobAuditingPolicyProperties withState(BlobAuditingPolicyState state)
Set the state property: Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
Parameters:
Returns:
withStorageAccountAccessKey
public ExtendedDatabaseBlobAuditingPolicyProperties withStorageAccountAccessKey(String storageAccountAccessKey)
Set the storageAccountAccessKey property: 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](https://go.microsoft.com/fwlink/?linkid=2114355).
Parameters:
Returns:
withStorageAccountSubscriptionId
public ExtendedDatabaseBlobAuditingPolicyProperties withStorageAccountSubscriptionId(UUID storageAccountSubscriptionId)
Set the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.
Parameters:
Returns:
withStorageEndpoint
public ExtendedDatabaseBlobAuditingPolicyProperties withStorageEndpoint(String storageEndpoint)
Set the storageEndpoint property: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
Parameters:
Returns:
