Share via

Microsoft.Network ddosCustomPolicies 2021-05-01

  • Article
Choose a deployment language

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.

Bicep 
resource symbolicname 'Microsoft.Network/ddosCustomPolicies@2021-05-01' = {
  location: 'string'
  name: 'string'
  properties: {
    protocolCustomSettings: [
      {
        protocol: 'string'
        sourceRateOverride: 'string'
        triggerRateOverride: 'string'
        triggerSensitivityOverride: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

DdosCustomPolicyPropertiesFormat

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

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

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'

ResourceTags

Name Description Value

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.

JSON 
{
  "type": "Microsoft.Network/ddosCustomPolicies",
  "apiVersion": "2021-05-01",
  "name": "string",
  "location": "string",
  "properties": {
    "protocolCustomSettings": [
      {
        "protocol": "string",
        "sourceRateOverride": "string",
        "triggerRateOverride": "string",
        "triggerSensitivityOverride": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

DdosCustomPolicyPropertiesFormat

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

Microsoft.Network/ddosCustomPolicies

Name Description Value
apiVersion The api version '2021-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'

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'

ResourceTags

Name Description Value

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.

Terraform 
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/ddosCustomPolicies@2021-05-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      protocolCustomSettings = [
        {
          protocol = "string"
          sourceRateOverride = "string"
          triggerRateOverride = "string"
          triggerSensitivityOverride = "string"
        }
      ]
    }
  })
}

Property Values

DdosCustomPolicyPropertiesFormat

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

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@2021-05-01"

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'

ResourceTags

Name Description Value