database_security_alert_policies

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

Overview

Name	database_security_alert_policies
Type	Resource
Id	azure.sql.database_security_alert_policies

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the database security alert policy.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	SystemData of SecurityAlertPolicyResource.

list_by_database

Successfully retrieved the database security alert policy.

Name	Datatype	Description
properties	object	Resource properties.
systemData	object	SystemData of SecurityAlertPolicyResource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, securityAlertPolicyName, subscriptionId		Gets a database's security alert policy.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets a list of database's security alert policies.
create_or_update	insert	resourceGroupName, serverName, databaseName, securityAlertPolicyName, subscriptionId		Creates or updates a database'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
databaseName	string	The name of the database for which the security alert policy is defined.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
securityAlertPolicyName	string	The name of the security alert policy.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a database's security alert policy.

SELECT
properties,
systemData
FROM azure.sql.database_security_alert_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND securityAlertPolicyName = '{{ securityAlertPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Gets a list of database's security alert policies.

SELECT
properties,
systemData
FROM azure.sql.database_security_alert_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a database's security alert policy.

INSERT INTO azure.sql.database_security_alert_policies (
data__properties,
resourceGroupName,
serverName,
databaseName,
securityAlertPolicyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ securityAlertPolicyName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

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