Share via

Microsoft.Network ddosCustomPolicies 2025-05-01

Bicep resource definition

The ddosCustomPolicies 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.Network/ddosCustomPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/ddosCustomPolicies@2025-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    detectionRules: [
      {
        id: 'string'
        name: 'string'
        properties: {
          detectionMode: 'string'
          trafficDetectionRule: {
            packetsPerSecond: int
            trafficType: 'string'
          }
        }
      }
    ]
    frontEndIpConfiguration: [
      {
        id: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Network/ddosCustomPolicies

Name Description Value
location Resource location. string
name The resource name string (required)
properties Properties of the DDoS custom policy. DdosCustomPolicyPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates

DdosCustomPolicyPropertiesFormat

Name Description Value
detectionRules The list of DDoS detection rules associated with the custom policy. DdosDetectionRule[]
frontEndIpConfiguration The list of frontend IP configurations associated with the custom policy. SubResource[]

DdosDetectionRule

Name Description Value
id Resource ID. string
name The name of the DDoS detection rule. string
properties Properties of the DDoS detection rule. DdosDetectionRulePropertiesFormat

DdosDetectionRulePropertiesFormat

Name Description Value
detectionMode The detection mode for the DDoS detection rule. 'TrafficThreshold'
trafficDetectionRule The traffic detection rule details. TrafficDetectionRule

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

TrafficDetectionRule

Name Description Value
packetsPerSecond The customized packets per second threshold. int
trafficType The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon. 'Tcp'
'TcpSyn'
'Udp'

ARM template resource definition

The ddosCustomPolicies 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.Network/ddosCustomPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/ddosCustomPolicies",
  "apiVersion": "2025-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "detectionRules": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "detectionMode": "string",
          "trafficDetectionRule": {
            "packetsPerSecond": "int",
            "trafficType": "string"
          }
        }
      }
    ],
    "frontEndIpConfiguration": [
      {
        "id": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Network/ddosCustomPolicies

Name Description Value
apiVersion The api version '2025-05-01'
location Resource location. string
name The resource name string (required)
properties Properties of the DDoS custom policy. DdosCustomPolicyPropertiesFormat
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/ddosCustomPolicies'

DdosCustomPolicyPropertiesFormat

Name Description Value
detectionRules The list of DDoS detection rules associated with the custom policy. DdosDetectionRule[]
frontEndIpConfiguration The list of frontend IP configurations associated with the custom policy. SubResource[]

DdosDetectionRule

Name Description Value
id Resource ID. string
name The name of the DDoS detection rule. string
properties Properties of the DDoS detection rule. DdosDetectionRulePropertiesFormat

DdosDetectionRulePropertiesFormat

Name Description Value
detectionMode The detection mode for the DDoS detection rule. 'TrafficThreshold'
trafficDetectionRule The traffic detection rule details. TrafficDetectionRule

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

TrafficDetectionRule

Name Description Value
packetsPerSecond The customized packets per second threshold. int
trafficType The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon. 'Tcp'
'TcpSyn'
'Udp'

Usage Examples

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

To create a Microsoft.Network/ddosCustomPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/ddosCustomPolicies@2025-05-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      detectionRules = [
        {
          id = "string"
          name = "string"
          properties = {
            detectionMode = "string"
            trafficDetectionRule = {
              packetsPerSecond = int
              trafficType = "string"
            }
          }
        }
      ]
      frontEndIpConfiguration = [
        {
          id = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.Network/ddosCustomPolicies

Name Description Value
location Resource location. string
name The resource name string (required)
properties Properties of the DDoS custom policy. DdosCustomPolicyPropertiesFormat
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/ddosCustomPolicies@2025-05-01"

DdosCustomPolicyPropertiesFormat

Name Description Value
detectionRules The list of DDoS detection rules associated with the custom policy. DdosDetectionRule[]
frontEndIpConfiguration The list of frontend IP configurations associated with the custom policy. SubResource[]

DdosDetectionRule

Name Description Value
id Resource ID. string
name The name of the DDoS detection rule. string
properties Properties of the DDoS detection rule. DdosDetectionRulePropertiesFormat

DdosDetectionRulePropertiesFormat

Name Description Value
detectionMode The detection mode for the DDoS detection rule. 'TrafficThreshold'
trafficDetectionRule The traffic detection rule details. TrafficDetectionRule

ResourceTags

Name Description Value

SubResource

Name Description Value
id Resource ID. string

TrafficDetectionRule

Name Description Value
packetsPerSecond The customized packets per second threshold. int
trafficType The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon. 'Tcp'
'TcpSyn'
'Udp'
  • Last updated on