Ddos Custom Policies - Create Or Update
Creates or updates a DDoS custom policy.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}?api-version=2025-03-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
ddos
|
path | True |
string |
The name of the DDoS custom policy. |
|
resource
|
path | True |
string |
The name of the resource group. |
|
subscription
|
path | True |
string |
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
|
api-version
|
query | True |
string |
Client API version. |
Request Body
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource ID. |
| location |
string |
Resource location. |
| properties.detectionRules |
The list of DDoS detection rules associated with the custom policy. |
|
| properties.frontEndIpConfiguration |
The list of frontend IP configurations associated with the custom policy. |
|
| tags |
object |
Resource tags. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Update successful. The operation returns the resulting DDoS custom policy resource. |
|
| 201 Created |
Create successful. The operation returns the resulting DDoS custom policy resource. |
|
| Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
Create DDoS custom policy
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy?api-version=2025-03-01
{
"location": "centraluseuap",
"properties": {
"detectionRules": [
{
"name": "detectionRuleTcp",
"properties": {
"detectionMode": "TrafficThreshold",
"trafficDetectionRule": {
"trafficType": "Tcp",
"packetsPerSecond": 1000000
}
}
}
]
}
}
Sample response
{
"name": "test-ddos-custom-policy",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy",
"type": "Microsoft.Network/ddosCustomPolicies",
"location": "centraluseuap",
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-000000000000",
"detectionRules": [
{
"name": "detectionRuleTcp",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy/ddosDetectionRules/detectionRuleTcp",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"type": "Microsoft.Network/ddosCustomPolicies/ddosDetectionRules",
"properties": {
"provisioningState": "Succeeded",
"detectionMode": "TrafficThreshold",
"trafficDetectionRule": {
"trafficType": "Tcp",
"packetsPerSecond": 1000000
}
}
}
]
}
}
{
"name": "test-ddos-custom-policy",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy",
"type": "Microsoft.Network/ddosCustomPolicies",
"location": "centraluseuap",
"properties": {
"provisioningState": "Succeeded",
"resourceGuid": "00000000-0000-0000-0000-000000000000",
"detectionRules": [
{
"name": "detectionRuleTcp",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy/ddosDetectionRules/detectionRuleTcp",
"etag": "W/\"00000000-0000-0000-0000-00000000\"",
"type": "Microsoft.Network/ddosCustomPolicies/ddosDetectionRules",
"properties": {
"provisioningState": "Succeeded",
"detectionMode": "TrafficThreshold",
"trafficDetectionRule": {
"trafficType": "Tcp",
"packetsPerSecond": 1000000
}
}
}
]
}
}
Definitions
| Name | Description |
|---|---|
|
Cloud |
An error response from the service. |
|
Cloud |
An error response from the service. |
|
Ddos |
A DDoS custom policy in a resource group. |
|
Ddos |
The detection mode for the DDoS detection rule. |
|
Ddos |
A DDoS detection rule resource. |
|
Ddos |
The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon. |
|
Provisioning |
The current provisioning state. |
|
Sub |
Reference to another subresource. |
|
Traffic |
Ddos Custom Policy traffic detection rule. |
CloudError
An error response from the service.
| Name | Type | Description |
|---|---|---|
| error |
Cloud error body. |
CloudErrorBody
An error response from the service.
| Name | Type | Description |
|---|---|---|
| code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
| details |
A list of additional details about the error. |
|
| message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
| target |
string |
The target of the particular error. For example, the name of the property in error. |
DdosCustomPolicy
A DDoS custom policy in a resource group.
| Name | Type | Description |
|---|---|---|
| etag |
string |
A unique read-only string that changes whenever the resource is updated. |
| id |
string |
Resource ID. |
| location |
string |
Resource location. |
| name |
string |
Resource name. |
| properties.detectionRules |
The list of DDoS detection rules associated with the custom policy. |
|
| properties.frontEndIpConfiguration |
The list of frontend IP configurations associated with the custom policy. |
|
| properties.provisioningState |
The provisioning state of the DDoS custom policy resource. |
|
| properties.resourceGuid |
string |
The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. |
| tags |
object |
Resource tags. |
| type |
string |
Resource type. |
DdosDetectionMode
The detection mode for the DDoS detection rule.
| Value | Description |
|---|---|
| TrafficThreshold |
DdosDetectionRule
A DDoS detection rule resource.
| Name | Type | Description |
|---|---|---|
| etag |
string |
A unique read-only string that changes whenever the resource is updated. |
| id |
string |
The resource ID of the DDoS detection rule. |
| name |
string |
The name of the DDoS detection rule. |
| properties.detectionMode |
The detection mode for the DDoS detection rule. |
|
| properties.provisioningState |
The provisioning state of the DDoS detection rule. |
|
| properties.trafficDetectionRule |
The traffic detection rule details. |
|
| type |
string |
The resource type. |
DdosTrafficType
The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon.
| Value | Description |
|---|---|
| Tcp | |
| Udp | |
| TcpSyn |
ProvisioningState
The current provisioning state.
| Value | Description |
|---|---|
| Succeeded | |
| Updating | |
| Deleting | |
| Failed |
SubResource
Reference to another subresource.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource ID. |
TrafficDetectionRule
Ddos Custom Policy traffic detection rule.
| Name | Type | Description |
|---|---|---|
| packetsPerSecond |
integer (int32) |
The customized packets per second threshold. |
| trafficType |
The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon. |