Share via

az network ddos-custom-policy

Manage Ddos Custom Policy.

Commands

Name Description Type Status
az network ddos-custom-policy create

Create a DDoS custom policy.

 Core GA
az network ddos-custom-policy delete

Delete the specified DDoS custom policy.

 Core GA
az network ddos-custom-policy show

Get information about the specified DDoS custom policy.

 Core GA
az network ddos-custom-policy update

Update a DDoS custom policy.

 Core GA
az network ddos-custom-policy wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az network ddos-custom-policy create

Edit

Create a DDoS custom policy.

az network ddos-custom-policy create --ddos-custom-policy-name --name
                                     --resource-group
                                     [--detection-mode]
                                     [--detection-rule-name]
                                     [--location]
                                     [--no-wait]
                                     [--packets-per-second]
                                     [--tags]
                                     [--traffic-type]

Examples

Create DDoS custom policy

az network ddos-custom-policy create --resource-group rg1 --ddos-custom-policy-name test-ddos-custom-policy \
    --location centraluseuap --detection-rule-name detectionRuleTcp \
    --detection-mode TrafficThreshold --traffic-type Tcp --packets-per-second 1000000

Required Parameters

--ddos-custom-policy-name --name -n

The name of the DDoS custom policy.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--detection-mode

The detection mode for the DDoS detection rule.

Property Value
Parameter group: Detection Rules Arguments
--detection-rule-name

The name of the DDoS detection rule.

Property Value
Parameter group: Detection Rules Arguments
--location -l

Resource location.

Property Value
Parameter group: Parameters Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--packets-per-second

The customized packets per second threshold.

Property Value
Parameter group: Detection Rules Arguments
--tags

Resource tags.

Property Value
Parameter group: Parameters Arguments
--traffic-type

The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon.

Property Value
Parameter group: Detection Rules Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network ddos-custom-policy delete

Edit

Delete the specified DDoS custom policy.

az network ddos-custom-policy delete [--ddos-custom-policy-name --name]
                                     [--ids]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Examples

Delete DDoS custom policy

az network ddos-custom-policy delete --resource-group rg1 --ddos-custom-policy-name test-ddos-custom-policy

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ddos-custom-policy-name --name -n

The name of the DDoS custom policy.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network ddos-custom-policy show

Edit

Get information about the specified DDoS custom policy.

az network ddos-custom-policy show [--ddos-custom-policy-name --name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]

Examples

Get DDoS custom policy

az network ddos-custom-policy show --resource-group rg1 --ddos-custom-policy-name test-ddos-custom-policy

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ddos-custom-policy-name --name -n

The name of the DDoS custom policy.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network ddos-custom-policy update

Edit

Update a DDoS custom policy.

az network ddos-custom-policy update [--add]
                                     [--ddos-custom-policy-name --name]
                                     [--detection-rules]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--subscription]
                                     [--tags]

Examples

Create DDoS custom policy

az network ddos-custom-policy update --resource-group rg1 --ddos-custom-policy-name test-ddos-custom-policy --location centraluseuap --detection-rules "[{name:detectionRuleTcp,detection-mode:TrafficThreshold,traffic-detection-rule:{traffic-type:Tcp,packets-per-second:1000000}}]"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--ddos-custom-policy-name --name -n

The name of the DDoS custom policy.

Property Value
Parameter group: Resource Id Arguments
--detection-rules

The list of DDoS detection rules associated with the custom policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--location -l

Resource location.

Property Value
Parameter group: Parameters Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network ddos-custom-policy wait

Edit

Place the CLI in a waiting state until a condition is met.

az network ddos-custom-policy wait [--created]
                                   [--custom]
                                   [--ddos-custom-policy-name --name]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--ddos-custom-policy-name --name -n

The name of the DDoS custom policy.

Property Value
Parameter group: Resource Id Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False