workspace_managed_sql_server_security_alert_policies

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

Overview

Name	workspace_managed_sql_server_security_alert_policies
Type	Resource
Id	azure.synapse.workspace_managed_sql_server_security_alert_policies

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved security alert policy.

Name	Datatype	Description
properties	object	Resource properties.

list

Successfully retrieved threat detection policies.

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, securityAlertPolicyName		Get a workspace managed sql server's security alert policy.
list	select	subscriptionId, resourceGroupName, workspaceName		Get workspace managed sql server's threat detection policies.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, securityAlertPolicyName		Create or Update a workspace managed sql server's 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. The name is case insensitive.
securityAlertPolicyName	string	The name of the security alert policy.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a workspace managed sql server's security alert policy.

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

list

Get workspace managed sql server's threat detection policies.

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

INSERT examples

create_or_update

Create or Update a workspace managed sql server's threat detection policy.

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

Manifest

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