Microsoft.Network ddosCustomPolicies 2022-01-01

  • Article

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@2022-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    protocolCustomSettings: [
      {
        protocol: 'string'
        sourceRateOverride: 'string'
        triggerRateOverride: 'string'
        triggerSensitivityOverride: 'string'
      }
    ]
  }
}

Property values

ddosCustomPolicies

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

DdosCustomPolicyPropertiesFormat

Name Description Value
protocolCustomSettings The protocol-specific DDoS policy customization parameters. ProtocolCustomSettingsFormat[]

ProtocolCustomSettingsFormat

Name Description Value
protocol The protocol for which the DDoS protection policy is being customized. 'Syn'
'Tcp'
'Udp'
sourceRateOverride The customized DDoS protection source rate. string
triggerRateOverride The customized DDoS protection trigger rate. string
triggerSensitivityOverride The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic. 'Default'
'High'
'Low'
'Relaxed'

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": "2022-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "protocolCustomSettings": [
      {
        "protocol": "string",
        "sourceRateOverride": "string",
        "triggerRateOverride": "string",
        "triggerSensitivityOverride": "string"
      }
    ]
  }
}

Property values

ddosCustomPolicies

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

DdosCustomPolicyPropertiesFormat

Name Description Value
protocolCustomSettings The protocol-specific DDoS policy customization parameters. ProtocolCustomSettingsFormat[]

ProtocolCustomSettingsFormat

Name Description Value
protocol The protocol for which the DDoS protection policy is being customized. 'Syn'
'Tcp'
'Udp'
sourceRateOverride The customized DDoS protection source rate. string
triggerRateOverride The customized DDoS protection trigger rate. string
triggerSensitivityOverride The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic. 'Default'
'High'
'Low'
'Relaxed'

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@2022-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      protocolCustomSettings = [
        {
          protocol = "string"
          sourceRateOverride = "string"
          triggerRateOverride = "string"
          triggerSensitivityOverride = "string"
        }
      ]
    }
  })
}

Property values

ddosCustomPolicies

Name Description Value
type The resource type "Microsoft.Network/ddosCustomPolicies@2022-01-01"
name The resource name string (required)
location Resource location. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
properties Properties of the DDoS custom policy. DdosCustomPolicyPropertiesFormat

DdosCustomPolicyPropertiesFormat

Name Description Value
protocolCustomSettings The protocol-specific DDoS policy customization parameters. ProtocolCustomSettingsFormat[]

ProtocolCustomSettingsFormat

Name Description Value
protocol The protocol for which the DDoS protection policy is being customized. "Syn"
"Tcp"
"Udp"
sourceRateOverride The customized DDoS protection source rate. string
triggerRateOverride The customized DDoS protection trigger rate. string
triggerSensitivityOverride The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic. "Default"
"High"
"Low"
"Relaxed"