public final class ExtendedServerBlobAuditingPolicyInner
extends com.azure.core.management.ProxyResource
Constructor and Description |
---|
ExtendedServerBlobAuditingPolicyInner() |
Modifier and Type | Method and 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.
|
String |
predicateExpression()
Get the predicateExpression property: Specifies condition of where clause when creating an audit.
|
Integer |
queueDelayMs()
Get the queueDelayMs property: Specifies the amount of time in milliseconds that can elapse before audit actions
are forced to be processed.
|
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.
|
ExtendedServerBlobAuditingPolicyInner |
withAuditActionsAndGroups(List<String> auditActionsAndGroups)
Set the auditActionsAndGroups property: Specifies the Actions-Groups and Actions to audit.
|
ExtendedServerBlobAuditingPolicyInner |
withIsAzureMonitorTargetEnabled(Boolean isAzureMonitorTargetEnabled)
Set the isAzureMonitorTargetEnabled property: Specifies whether audit events are sent to Azure Monitor.
|
ExtendedServerBlobAuditingPolicyInner |
withIsStorageSecondaryKeyInUse(Boolean isStorageSecondaryKeyInUse)
Set the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's
secondary key.
|
ExtendedServerBlobAuditingPolicyInner |
withPredicateExpression(String predicateExpression)
Set the predicateExpression property: Specifies condition of where clause when creating an audit.
|
ExtendedServerBlobAuditingPolicyInner |
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.
|
ExtendedServerBlobAuditingPolicyInner |
withRetentionDays(Integer retentionDays)
Set the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.
|
ExtendedServerBlobAuditingPolicyInner |
withState(BlobAuditingPolicyState state)
Set the state property: Specifies the state of the policy.
|
ExtendedServerBlobAuditingPolicyInner |
withStorageAccountAccessKey(String storageAccountAccessKey)
Set the storageAccountAccessKey property: Specifies the identifier key of the auditing storage account.
|
ExtendedServerBlobAuditingPolicyInner |
withStorageAccountSubscriptionId(UUID storageAccountSubscriptionId)
Set the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.
|
ExtendedServerBlobAuditingPolicyInner |
withStorageEndpoint(String storageEndpoint)
Set the storageEndpoint property: Specifies the blob storage endpoint (e.g.
|
public ExtendedServerBlobAuditingPolicyInner()
public String predicateExpression()
public ExtendedServerBlobAuditingPolicyInner withPredicateExpression(String predicateExpression)
predicateExpression
- the predicateExpression value to set.public BlobAuditingPolicyState state()
public ExtendedServerBlobAuditingPolicyInner withState(BlobAuditingPolicyState state)
state
- the state value to set.public String storageEndpoint()
public ExtendedServerBlobAuditingPolicyInner withStorageEndpoint(String storageEndpoint)
storageEndpoint
- the storageEndpoint value to set.public String storageAccountAccessKey()
public ExtendedServerBlobAuditingPolicyInner withStorageAccountAccessKey(String storageAccountAccessKey)
storageAccountAccessKey
- the storageAccountAccessKey value to set.public Integer retentionDays()
public ExtendedServerBlobAuditingPolicyInner withRetentionDays(Integer retentionDays)
retentionDays
- the retentionDays value to set.public List<String> auditActionsAndGroups()
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).
public ExtendedServerBlobAuditingPolicyInner withAuditActionsAndGroups(List<String> auditActionsAndGroups)
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).
auditActionsAndGroups
- the auditActionsAndGroups value to set.public UUID storageAccountSubscriptionId()
public ExtendedServerBlobAuditingPolicyInner withStorageAccountSubscriptionId(UUID storageAccountSubscriptionId)
storageAccountSubscriptionId
- the storageAccountSubscriptionId value to set.public Boolean isStorageSecondaryKeyInUse()
public ExtendedServerBlobAuditingPolicyInner withIsStorageSecondaryKeyInUse(Boolean isStorageSecondaryKeyInUse)
isStorageSecondaryKeyInUse
- the isStorageSecondaryKeyInUse value to set.public Boolean isAzureMonitorTargetEnabled()
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).
public ExtendedServerBlobAuditingPolicyInner withIsAzureMonitorTargetEnabled(Boolean isAzureMonitorTargetEnabled)
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).
isAzureMonitorTargetEnabled
- the isAzureMonitorTargetEnabled value to set.public Integer queueDelayMs()
public ExtendedServerBlobAuditingPolicyInner withQueueDelayMs(Integer queueDelayMs)
queueDelayMs
- the queueDelayMs value to set.public void validate()
IllegalArgumentException
- thrown if the instance is not valid.Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.