sql_pool_security_alert_policies

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

Overview

Name	sql_pool_security_alert_policies
Type	Resource
Id	azure.synapse.sql_pool_security_alert_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.
creationTime	string (date-time)	Specifies the UTC creation time of the policy.
disabledAlerts	array	Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdmins	boolean	Specifies that the alert is sent to the account administrators.
emailAddresses	array	Specifies an array of e-mail addresses to which the alert is sent.
retentionDays	integer	Specifies the number of days to keep in the Threat Detection audit logs.
state	string	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool. Known values are: "New", "Enabled", and "Disabled".
storageAccountAccessKey	string	Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
creationTime	string (date-time)	Specifies the UTC creation time of the policy.
disabledAlerts	array	Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action.
emailAccountAdmins	boolean	Specifies that the alert is sent to the account administrators.
emailAddresses	array	Specifies an array of e-mail addresses to which the alert is sent.
retentionDays	integer	Specifies the number of days to keep in the Threat Detection audit logs.
state	string	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool. Known values are: "New", "Enabled", and "Disabled".
storageAccountAccessKey	string	Specifies the identifier key of the Threat Detection audit storage account.
storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
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, sql_pool_name, security_alert_policy_name, subscription_id		Get a Sql pool's security alert policy. Get a Sql pool's security alert policy.
list	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		List Sql pool's security alert policies. Get a list of Sql pool's security alert policies.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, security_alert_policy_name, subscription_id		Create or update a Sql pool's security alert policy. Create or update a Sql pool's security alert policy.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, security_alert_policy_name, subscription_id		Create or update a Sql pool's security alert policy. Create or update a Sql pool's security alert 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
security_alert_policy_name	string	The name of the security alert policy. "default" Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get a Sql pool's security alert policy. Get a Sql pool's security alert policy.

SELECT
id,
name,
creationTime,
disabledAlerts,
emailAccountAdmins,
emailAddresses,
retentionDays,
state,
storageAccountAccessKey,
storageEndpoint,
type
FROM azure.synapse.sql_pool_security_alert_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND security_alert_policy_name = '{{ security_alert_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Sql pool's security alert policies. Get a list of Sql pool's security alert policies.

SELECT
id,
name,
creationTime,
disabledAlerts,
emailAccountAdmins,
emailAddresses,
retentionDays,
state,
storageAccountAccessKey,
storageEndpoint,
type
FROM azure.synapse.sql_pool_security_alert_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a Sql pool's security alert policy. Create or update a Sql pool's security alert policy.

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

Manifest

# Description fields are for documentation purposes
- name: sql_pool_security_alert_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_security_alert_policies resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_security_alert_policies resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_security_alert_policies resource.
  - name: security_alert_policy_name
    value: "{{ security_alert_policy_name }}"
    description: Required parameter for the sql_pool_security_alert_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_security_alert_policies resource.
  - name: properties
    value:
      state: "{{ state }}"
      disabledAlerts:
        - "{{ disabledAlerts }}"
      emailAddresses:
        - "{{ emailAddresses }}"
      emailAccountAdmins: {{ emailAccountAdmins }}
      storageEndpoint: "{{ storageEndpoint }}"
      storageAccountAccessKey: "{{ storageAccountAccessKey }}"
      retentionDays: {{ retentionDays }}

REPLACE examples

create_or_update

Create or update a Sql pool's security alert policy. Create or update a Sql pool's security alert policy.

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