server_threat_protection_settings

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

Overview

Name	server_threat_protection_settings
Type	Resource
Id	azure.postgresql.server_threat_protection_settings

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the server advanced threat protection settings.

Name	Datatype	Description
properties	object	Advanced Threat Protection properties.

list_by_server

Successfully retrieved the server threat detection policy.

Name	Datatype	Description
properties	object	Advanced Threat Protection properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, threatProtectionName		Get a server's Advanced Threat Protection settings.
list_by_server	select	subscriptionId, resourceGroupName, serverName		Get a list of server's Threat Protection state.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, threatProtectionName		Creates or updates a server's Advanced Threat Protection settings.

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.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
threatProtectionName	string	The name of the Threat Protection state.

SELECT examples

get

Get a server's Advanced Threat Protection settings.

SELECT
properties
FROM azure.postgresql.server_threat_protection_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND threatProtectionName = '{{ threatProtectionName }}' -- required
;

list_by_server

Get a list of server's Threat Protection state.

SELECT
properties
FROM azure.postgresql.server_threat_protection_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a server's Advanced Threat Protection settings.

INSERT INTO azure.postgresql.server_threat_protection_settings (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
threatProtectionName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ threatProtectionName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_threat_protection_settings
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the server_threat_protection_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_threat_protection_settings resource.
    - name: serverName
      value: string
      description: Required parameter for the server_threat_protection_settings resource.
    - name: threatProtectionName
      value: string
      description: Required parameter for the server_threat_protection_settings resource.
    - name: properties
      value: object
      description: |
        Advanced Threat Protection properties.