server_security_alert_policies

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

Overview

Name	server_security_alert_policies
Type	Resource
Id	azure.sql.server_security_alert_policies

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the server threat detection policy.

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

list_by_server

Successfully retrieved the server threat detection policies.

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, securityAlertPolicyName, subscriptionId		Get a server's security alert policy.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Get the server's threat detection policies.
create_or_update	insert	resourceGroupName, serverName, securityAlertPolicyName, subscriptionId		Creates or updates a threat detection 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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
securityAlertPolicyName	string	The name of the threat detection policy.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Get a server's security alert policy.

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

list_by_server

Get the server's threat detection policies.

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

INSERT examples

create_or_update

Creates or updates a threat detection policy.

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

Manifest

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