advanced_threat_protection_settings

Creates, updates, deletes, gets or lists an advanced_threat_protection_settings resource.

Overview

Name	advanced_threat_protection_settings
Type	Resource
Id	azure.postgresql_flexible_servers.advanced_threat_protection_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Specifies the creation time (UTC) of the policy.
state	string	Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
creationTime	string (date-time)	Specifies the creation time (UTC) of the policy.
state	string	Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, threat_protection_name, subscription_id		Gets state of advanced threat protection settings for a server.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists state of advanced threat protection settings for a server.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string
threat_protection_name	string	Name of the advanced threat protection settings. "Default" Required.

SELECT examples

get

Gets state of advanced threat protection settings for a server.

SELECT
id,
name,
creationTime,
state,
systemData,
type
FROM azure.postgresql_flexible_servers.advanced_threat_protection_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND threat_protection_name = '{{ threat_protection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists state of advanced threat protection settings for a server.

SELECT
id,
name,
creationTime,
state,
systemData,
type
FROM azure.postgresql_flexible_servers.advanced_threat_protection_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;