Microsoft.Security advancedThreatProtectionSettings

• Latest
• 2019-01-01
• 2017-08-01-preview

Bicep resource definition

The advancedThreatProtectionSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/advancedThreatProtectionSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Security/advancedThreatProtectionSettings@2019-01-01' = {
  scope: resourceSymbolicName or scope
  name: 'current'
  properties: {
    isEnabled: bool
  }
}

Property values

AdvancedThreatProtectionProperties

Name	Description	Value
isEnabled	Indicates whether Advanced Threat Protection is enabled.	bool

Microsoft.Security/advancedThreatProtectionSettings

Name	Description	Value
name	The resource name	'current' (required)
properties	The Advanced Threat Protection settings.	AdvancedThreatProtectionProperties
scope	Use when creating a resource at a scope that is different than the deployment scope.	Set this property to the symbolic name of a resource to apply the extension resource.

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create a Cosmos DB account with Microsoft Defender enabled	Using this ARM template, you can deploy an Azure Cosmos DB account with Microsoft Defender for Azure Cosmos DB enabled. Microsoft Defender for Azure Cosmos DB is an Azure-native layer of security that detects attempts to exploit databases in your Azure Cosmos DB accounts. Microsoft Defender for Azure Cosmos DB detects potential SQL injections, known bad actors based on Microsoft Threat Intelligence, suspicious access patterns, and potential exploitations of your database through compromised identities or malicious insiders.
Storage account with Advanced Threat Protection	This template allows you to deploy an Azure Storage account with Advanced Threat Protection enabled.

ARM template resource definition

The advancedThreatProtectionSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/advancedThreatProtectionSettings resource, add the following JSON to your template.

{
  "type": "Microsoft.Security/advancedThreatProtectionSettings",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "isEnabled": "bool"
  }
}

Property values

AdvancedThreatProtectionProperties

Name	Description	Value
isEnabled	Indicates whether Advanced Threat Protection is enabled.	bool

Microsoft.Security/advancedThreatProtectionSettings

Name	Description	Value
apiVersion	The api version	'2019-01-01'
name	The resource name	'current' (required)
properties	The Advanced Threat Protection settings.	AdvancedThreatProtectionProperties
type	The resource type	'Microsoft.Security/advancedThreatProtectionSettings'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Cosmos DB account with Microsoft Defender enabled	Using this ARM template, you can deploy an Azure Cosmos DB account with Microsoft Defender for Azure Cosmos DB enabled. Microsoft Defender for Azure Cosmos DB is an Azure-native layer of security that detects attempts to exploit databases in your Azure Cosmos DB accounts. Microsoft Defender for Azure Cosmos DB detects potential SQL injections, known bad actors based on Microsoft Threat Intelligence, suspicious access patterns, and potential exploitations of your database through compromised identities or malicious insiders.
Storage account with Advanced Threat Protection	This template allows you to deploy an Azure Storage account with Advanced Threat Protection enabled.

Terraform (AzAPI provider) resource definition

The advancedThreatProtectionSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Security/advancedThreatProtectionSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Security/advancedThreatProtectionSettings@2019-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      isEnabled = bool
    }
  })
}

Property values

AdvancedThreatProtectionProperties

Name	Description	Value
isEnabled	Indicates whether Advanced Threat Protection is enabled.	bool

Microsoft.Security/advancedThreatProtectionSettings

Name	Description	Value
name	The resource name	'current' (required)
parent_id	The ID of the resource to apply this extension resource to.	string (required)
properties	The Advanced Threat Protection settings.	AdvancedThreatProtectionProperties
type	The resource type	"Microsoft.Security/advancedThreatProtectionSettings@2019-01-01"