Class SqlPoolBlobAuditingPolicyProperties
- java.lang.Object
-
- com.azure.resourcemanager.synapse.fluent.models.SqlPoolBlobAuditingPolicyProperties
-
public final class SqlPoolBlobAuditingPolicyProperties extends Object
Properties of a Sql pool blob auditing policy.
-
-
Constructor Summary
Constructors Constructor Description SqlPoolBlobAuditingPolicyProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>
auditActionsAndGroups()
Get the auditActionsAndGroups property: Specifies the Actions-Groups and Actions to audit.Boolean
isAzureMonitorTargetEnabled()
Get the isAzureMonitorTargetEnabled property: Specifies whether audit events are sent to Azure Monitor.Boolean
isStorageSecondaryKeyInUse()
Get the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.Integer
retentionDays()
Get the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.BlobAuditingPolicyState
state()
Get the state property: Specifies the state of the policy.String
storageAccountAccessKey()
Get the storageAccountAccessKey property: Specifies the identifier key of the auditing storage account.UUID
storageAccountSubscriptionId()
Get the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.String
storageEndpoint()
Get the storageEndpoint property: Specifies the blob storage endpoint (e.g.void
validate()
Validates the instance.SqlPoolBlobAuditingPolicyProperties
withAuditActionsAndGroups(List<String> auditActionsAndGroups)
Set the auditActionsAndGroups property: Specifies the Actions-Groups and Actions to audit.SqlPoolBlobAuditingPolicyProperties
withIsAzureMonitorTargetEnabled(Boolean isAzureMonitorTargetEnabled)
Set the isAzureMonitorTargetEnabled property: Specifies whether audit events are sent to Azure Monitor.SqlPoolBlobAuditingPolicyProperties
withIsStorageSecondaryKeyInUse(Boolean isStorageSecondaryKeyInUse)
Set the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.SqlPoolBlobAuditingPolicyProperties
withRetentionDays(Integer retentionDays)
Set the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.SqlPoolBlobAuditingPolicyProperties
withState(BlobAuditingPolicyState state)
Set the state property: Specifies the state of the policy.SqlPoolBlobAuditingPolicyProperties
withStorageAccountAccessKey(String storageAccountAccessKey)
Set the storageAccountAccessKey property: Specifies the identifier key of the auditing storage account.SqlPoolBlobAuditingPolicyProperties
withStorageAccountSubscriptionId(UUID storageAccountSubscriptionId)
Set the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.SqlPoolBlobAuditingPolicyProperties
withStorageEndpoint(String storageEndpoint)
Set the storageEndpoint property: Specifies the blob storage endpoint (e.g.
-
-
-
Method Detail
-
state
public BlobAuditingPolicyState state()
Get the state property: Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.- Returns:
- the state value.
-
withState
public SqlPoolBlobAuditingPolicyProperties withState(BlobAuditingPolicyState state)
Set the state property: Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.- Parameters:
state
- the state value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
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 is required.- Returns:
- the storageEndpoint value.
-
withStorageEndpoint
public SqlPoolBlobAuditingPolicyProperties 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 is required.- Parameters:
storageEndpoint
- the storageEndpoint value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
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, storageAccountAccessKey is required.- Returns:
- the storageAccountAccessKey value.
-
withStorageAccountAccessKey
public SqlPoolBlobAuditingPolicyProperties withStorageAccountAccessKey(String storageAccountAccessKey)
Set the storageAccountAccessKey property: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.- Parameters:
storageAccountAccessKey
- the storageAccountAccessKey value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
retentionDays
public Integer retentionDays()
Get the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.- Returns:
- the retentionDays value.
-
withRetentionDays
public SqlPoolBlobAuditingPolicyProperties withRetentionDays(Integer retentionDays)
Set the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.- Parameters:
retentionDays
- the retentionDays value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
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
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:
- the auditActionsAndGroups value.
-
withAuditActionsAndGroups
public SqlPoolBlobAuditingPolicyProperties 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
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:
auditActionsAndGroups
- the auditActionsAndGroups value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
storageAccountSubscriptionId
public UUID storageAccountSubscriptionId()
Get the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.- Returns:
- the storageAccountSubscriptionId value.
-
withStorageAccountSubscriptionId
public SqlPoolBlobAuditingPolicyProperties withStorageAccountSubscriptionId(UUID storageAccountSubscriptionId)
Set the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.- Parameters:
storageAccountSubscriptionId
- the storageAccountSubscriptionId value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
isStorageSecondaryKeyInUse
public Boolean isStorageSecondaryKeyInUse()
Get the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.- Returns:
- the isStorageSecondaryKeyInUse value.
-
withIsStorageSecondaryKeyInUse
public SqlPoolBlobAuditingPolicyProperties withIsStorageSecondaryKeyInUse(Boolean isStorageSecondaryKeyInUse)
Set the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.- Parameters:
isStorageSecondaryKeyInUse
- the isStorageSecondaryKeyInUse value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
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:
- the isAzureMonitorTargetEnabled value.
-
withIsAzureMonitorTargetEnabled
public SqlPoolBlobAuditingPolicyProperties 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:
isAzureMonitorTargetEnabled
- the isAzureMonitorTargetEnabled value to set.- Returns:
- the SqlPoolBlobAuditingPolicyProperties object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-