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
properties	object	Resource properties.

list

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, securityAlertPolicyName		Get a Sql pool's security alert policy.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get a list of Sql pool's security alert policies.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, securityAlertPolicyName		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
securityAlertPolicyName	string	The name of the security alert policy.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a Sql pool's security alert policy.

SELECT
properties
FROM azure.synapse.sql_pool_security_alert_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND securityAlertPolicyName = '{{ securityAlertPolicyName }}' -- required
;

list

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

SELECT
properties
FROM azure.synapse.sql_pool_security_alert_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.synapse.sql_pool_security_alert_policies (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
securityAlertPolicyName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ securityAlertPolicyName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_security_alert_policies
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_security_alert_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_security_alert_policies resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_security_alert_policies resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_security_alert_policies resource.
    - name: securityAlertPolicyName
      value: string
      description: Required parameter for the sql_pool_security_alert_policies resource.
    - name: properties
      value: object
      description: |
        Resource properties.