workspace_managed_sql_server_extended_blob_auditing_policies

Creates, updates, deletes, gets or lists a workspace_managed_sql_server_extended_blob_auditing_policies resource.

Overview

Name	workspace_managed_sql_server_extended_blob_auditing_policies
Type	Resource
Id	azure.synapse.workspace_managed_sql_server_extended_blob_auditing_policies

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
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.
auditActionsAndGroups	array	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 . 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 .
isAzureMonitorTargetEnabled	boolean	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 _ or Diagnostic Settings PowerShell _.
isDevopsAuditEnabled	boolean	Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API _ or Diagnostic Settings PowerShell _.
isStorageSecondaryKeyInUse	boolean	Specifies whether storageAccountAccessKey value is the storage's secondary key.
predicateExpression	string	Specifies condition of where clause when creating an audit.
queueDelayMs	integer	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.
retentionDays	integer	Specifies the number of days to keep in the audit logs in the storage account.
state	string	Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Known values are: "Enabled" and "Disabled".
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: #. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). #. 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 _.
storageAccountSubscriptionId	string	Specifies the blob storage subscription Id.
storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
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.
auditActionsAndGroups	array	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 . 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 .
isAzureMonitorTargetEnabled	boolean	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 _ or Diagnostic Settings PowerShell _.
isDevopsAuditEnabled	boolean	Specifies the state of devops audit. If state is Enabled, devops logs will be sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled', 'IsAzureMonitorTargetEnabled' as true and 'IsDevopsAuditEnabled' as true When using REST API to configure auditing, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should also be created. Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview For more information, see Diagnostic Settings REST API _ or Diagnostic Settings PowerShell _.
isStorageSecondaryKeyInUse	boolean	Specifies whether storageAccountAccessKey value is the storage's secondary key.
predicateExpression	string	Specifies condition of where clause when creating an audit.
queueDelayMs	integer	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.
retentionDays	integer	Specifies the number of days to keep in the audit logs in the storage account.
state	string	Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Known values are: "Enabled" and "Disabled".
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: #. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD). #. 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 _.
storageAccountSubscriptionId	string	Specifies the blob storage subscription Id.
storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, blob_auditing_policy_name, subscription_id		Get server's extended blob auditing policy. Get a workspace SQL server's extended blob auditing policy.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List server's extended blob auditing policies. List workspace managed sql server's extended blob auditing policies.
create_or_update	insert	resource_group_name, workspace_name, blob_auditing_policy_name, subscription_id		Create or Update server's extended blob auditing policy. Create or Update a workspace managed sql server's extended blob auditing policy.
create_or_update	replace	resource_group_name, workspace_name, blob_auditing_policy_name, subscription_id		Create or Update server's extended blob auditing policy. Create or Update a workspace managed sql server's extended blob auditing policy.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
blob_auditing_policy_name	string	The name of the blob auditing policy. "default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get server's extended blob auditing policy. Get a workspace SQL server's extended blob auditing policy.

SELECT
id,
name,
auditActionsAndGroups,
isAzureMonitorTargetEnabled,
isDevopsAuditEnabled,
isStorageSecondaryKeyInUse,
predicateExpression,
queueDelayMs,
retentionDays,
state,
storageAccountAccessKey,
storageAccountSubscriptionId,
storageEndpoint,
type
FROM azure.synapse.workspace_managed_sql_server_extended_blob_auditing_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND blob_auditing_policy_name = '{{ blob_auditing_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

List server's extended blob auditing policies. List workspace managed sql server's extended blob auditing policies.

SELECT
id,
name,
auditActionsAndGroups,
isAzureMonitorTargetEnabled,
isDevopsAuditEnabled,
isStorageSecondaryKeyInUse,
predicateExpression,
queueDelayMs,
retentionDays,
state,
storageAccountAccessKey,
storageAccountSubscriptionId,
storageEndpoint,
type
FROM azure.synapse.workspace_managed_sql_server_extended_blob_auditing_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update server's extended blob auditing policy. Create or Update a workspace managed sql server's extended blob auditing policy.

INSERT INTO azure.synapse.workspace_managed_sql_server_extended_blob_auditing_policies (
properties,
resource_group_name,
workspace_name,
blob_auditing_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ blob_auditing_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: workspace_managed_sql_server_extended_blob_auditing_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workspace_managed_sql_server_extended_blob_auditing_policies resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the workspace_managed_sql_server_extended_blob_auditing_policies resource.
  - name: blob_auditing_policy_name
    value: "{{ blob_auditing_policy_name }}"
    description: Required parameter for the workspace_managed_sql_server_extended_blob_auditing_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workspace_managed_sql_server_extended_blob_auditing_policies resource.
  - name: properties
    value:
      predicateExpression: "{{ predicateExpression }}"
      state: "{{ state }}"
      storageEndpoint: "{{ storageEndpoint }}"
      storageAccountAccessKey: "{{ storageAccountAccessKey }}"
      retentionDays: {{ retentionDays }}
      auditActionsAndGroups:
        - "{{ auditActionsAndGroups }}"
      storageAccountSubscriptionId: "{{ storageAccountSubscriptionId }}"
      isStorageSecondaryKeyInUse: {{ isStorageSecondaryKeyInUse }}
      isAzureMonitorTargetEnabled: {{ isAzureMonitorTargetEnabled }}
      queueDelayMs: {{ queueDelayMs }}
      isDevopsAuditEnabled: {{ isDevopsAuditEnabled }}

REPLACE examples

create_or_update

Create or Update server's extended blob auditing policy. Create or Update a workspace managed sql server's extended blob auditing policy.

REPLACE azure.synapse.workspace_managed_sql_server_extended_blob_auditing_policies
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND blob_auditing_policy_name = '{{ blob_auditing_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;