Share via

az nginx deployment waf-policy

Note

This reference is part of the nginx extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az nginx deployment waf-policy command. Learn more about extensions.

Manage Waf Policy.

Commands

Name Description Type Status
az nginx deployment waf-policy create

Create a WAF policy.

 Extension GA
az nginx deployment waf-policy delete

Delete a specific WAF policy.

 Extension GA
az nginx deployment waf-policy list

List all WAF policies in a deployment.

 Extension GA
az nginx deployment waf-policy show

Get a specific WAF policy.

 Extension GA
az nginx deployment waf-policy update

Update a WAF policy.

 Extension GA
az nginx deployment waf-policy wait

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

 Extension GA

az nginx deployment waf-policy create

Create a WAF policy.

az nginx deployment waf-policy create --deployment-name
                                      --name --waf-policy-name
                                      --resource-group
                                      [--content]
                                      [--filepath]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

WafPolicy_Create

az nginx deployment waf-policy create --resource-group myResourceGroup --deployment-name myDeployment --waf-policy-name myWafPolicy

Required Parameters

--deployment-name

The name of targeted NGINX deployment.

--name --waf-policy-name -n

The name of the WafPolicy.

--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.

--content

The byte content of the Policy.

Property Value
Parameter group: Properties Arguments
--filepath

The file path where the Policy is to be saved.

Property Value
Parameter group: Properties 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
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 nginx deployment waf-policy delete

Delete a specific WAF policy.

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

Examples

WafPolicy_Delete

az nginx deployment waf-policy delete --resource-group myResourceGroup --deployment-name myDeployment --waf-policy-name myWafPolicy

Optional Parameters

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

--deployment-name

The name of targeted NGINX deployment.

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
--name --waf-policy-name -n

The name of the WafPolicy.

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 nginx deployment waf-policy list

List all WAF policies in a deployment.

az nginx deployment waf-policy list --deployment-name
                                    --resource-group
                                    [--max-items]
                                    [--next-token]

Examples

WafPolicy_List

az nginx deployment waf-policy list --resource-group myResourceGroup --deployment-name myDeployment

Required Parameters

--deployment-name

The name of targeted NGINX deployment.

--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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination 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 nginx deployment waf-policy show

Get a specific WAF policy.

az nginx deployment waf-policy show [--deployment-name]
                                    [--ids]
                                    [--name --waf-policy-name]
                                    [--resource-group]
                                    [--subscription]

Examples

WafPolicy_Get

az nginx deployment waf-policy show --resource-group myResourceGroup --deployment-name myDeployment --waf-policy-name myWafPolicy

Optional Parameters

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

--deployment-name

The name of targeted NGINX deployment.

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
--name --waf-policy-name -n

The name of the WafPolicy.

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 nginx deployment waf-policy update

Update a WAF policy.

az nginx deployment waf-policy update [--add]
                                      [--content]
                                      [--deployment-name]
                                      [--filepath]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--name --waf-policy-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--remove]
                                      [--resource-group]
                                      [--set]
                                      [--subscription]

Examples

WafPolicy_Update

az nginx deployment waf-policy update --resource-group myResourceGroup --deployment-name myDeployment --waf-policy-name myWafPolicy

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
--content

The byte content of the Policy.

Property Value
Parameter group: Properties Arguments
--deployment-name

The name of targeted NGINX deployment.

Property Value
Parameter group: Resource Id Arguments
--filepath

The file path where the Policy is to be saved.

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
--name --waf-policy-name -n

The name of the WafPolicy.

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
--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
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 nginx deployment waf-policy wait

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

az nginx deployment waf-policy wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--deployment-name]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name --waf-policy-name]
                                    [--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
--deleted

Wait until deleted.

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

The name of targeted NGINX deployment.

Property Value
Parameter group: Resource Id Arguments
--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
--name --waf-policy-name -n

The name of the WafPolicy.

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
--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