SqlPoolBlobAuditingPolicy Interface
public interface SqlPoolBlobAuditingPolicy
An immutable client-side representation of SqlPoolBlobAuditingPolicy.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| abstract List<String> |
auditActionsAndGroups()
Gets the audit |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Sql |
innerModel()
Gets the inner com. |
| abstract Boolean |
isAzureMonitorTargetEnabled()
Gets the is |
| abstract Boolean |
isStorageSecondaryKeyInUse()
Gets the is |
| abstract String |
kind()
Gets the kind property: Resource kind. |
| abstract String |
name()
Gets the name property: The name of the resource. |
|
abstract
Sql |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Sql |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
| abstract Integer |
retentionDays()
Gets the retention |
|
abstract
Blob |
state()
Gets the state property: Specifies the state of the policy. |
| abstract String |
storageAccountAccessKey()
Gets the storage |
| abstract UUID |
storageAccountSubscriptionId()
Gets the storage |
| abstract String |
storageEndpoint()
Gets the storage |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Sql |
Method Details
auditActionsAndGroups
public abstract List
Gets 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 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:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
innerModel
public abstract SqlPoolBlobAuditingPolicyInner innerModel()
Gets the inner com.azure.resourcemanager.synapse.fluent.models.SqlPoolBlobAuditingPolicyInner object.
Returns:
isAzureMonitorTargetEnabled
public abstract Boolean isAzureMonitorTargetEnabled()
Gets 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:
isStorageSecondaryKeyInUse
public abstract Boolean isStorageSecondaryKeyInUse()
Gets the isStorageSecondaryKeyInUse property: Specifies whether storageAccountAccessKey value is the storage's secondary key.
Returns:
kind
public abstract String kind()
Gets the kind property: Resource kind.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
refresh
public abstract SqlPoolBlobAuditingPolicy refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract SqlPoolBlobAuditingPolicy refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
retentionDays
public abstract Integer retentionDays()
Gets the retentionDays property: Specifies the number of days to keep in the audit logs in the storage account.
Returns:
state
public abstract BlobAuditingPolicyState state()
Gets the state property: Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
Returns:
storageAccountAccessKey
public abstract String storageAccountAccessKey()
Gets the storageAccountAccessKey property: Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.
Returns:
storageAccountSubscriptionId
public abstract UUID storageAccountSubscriptionId()
Gets the storageAccountSubscriptionId property: Specifies the blob storage subscription Id.
Returns:
storageEndpoint
public abstract String storageEndpoint()
Gets the storageEndpoint property: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint is required.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract SqlPoolBlobAuditingPolicy.Update update()
Begins update for the SqlPoolBlobAuditingPolicy resource.
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for