database_advanced_threat_protection_settings

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

Overview

Name	database_advanced_threat_protection_settings
Type	Resource
Id	azure.sql.database_advanced_threat_protection_settings

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the database's Advanced Threat Protection state.

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

list_by_database

Successfully retrieved the database Advanced Threat Protection states.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, databaseName, advancedThreatProtectionName, subscriptionId		Gets a database's Advanced Threat Protection state.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets a list of database's Advanced Threat Protection states.
create_or_update	insert	resourceGroupName, serverName, databaseName, advancedThreatProtectionName, subscriptionId		Creates or updates a database'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
advancedThreatProtectionName	string	The name of the Advanced Threat Protection state.
databaseName	string	The name of the database.
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.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a database's Advanced Threat Protection state.

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

list_by_database

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

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

INSERT examples

create_or_update

Creates or updates a database's Advanced Threat Protection state.

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

Manifest

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