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.mysql_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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
creationTime	string (date-time)	Specifies the UTC creation time of the policy.
provisioningState	string	Provisioning state of the Threat Protection. Known values are: "Succeeded", "Updating", "Canceled", and "Failed".
state	string	Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. Known values are: "Enabled" and "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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
creationTime	string (date-time)	Specifies the UTC creation time of the policy.
provisioningState	string	Provisioning state of the Threat Protection. Known values are: "Succeeded", "Updating", "Canceled", and "Failed".
state	string	Specifies the state of the Advanced Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific database or server. Known values are: "Enabled" and "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, advanced_threat_protection_name, subscription_id		Get a server's Advanced Threat Protection state.
list	select	resource_group_name, server_name, subscription_id		Gets a list of server's Advanced Threat Protection states.
update	update	resource_group_name, server_name, advanced_threat_protection_name, subscription_id		Updates a server's Advanced Threat Protection state.
update_put	exec	resource_group_name, server_name, advanced_threat_protection_name, subscription_id		Updates a server's Advanced Threat Protection state.

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
advanced_threat_protection_name	string	The name of the Advanced Threat Protection state. "Default" Required.
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

SELECT examples

get

Get a server's Advanced Threat Protection state.

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

list

Gets a list of server's Advanced Threat Protection states.

SELECT
id,
name,
creationTime,
provisioningState,
state,
systemData,
type
FROM azure.mysql_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
;

UPDATE examples

update

Updates a server's Advanced Threat Protection state.

UPDATE azure.mysql_flexible_servers.advanced_threat_protection_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND advanced_threat_protection_name = '{{ advanced_threat_protection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

update_put

Updates a server's Advanced Threat Protection state.

EXEC azure.mysql_flexible_servers.advanced_threat_protection_settings.update_put 
@resource_group_name='{{ resource_group_name }}' --required, 
@server_name='{{ server_name }}' --required, 
@advanced_threat_protection_name='{{ advanced_threat_protection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;