Share via

az network application-gateway redirect-config

  • Reference

Manage redirect configurations of an application gateway.

Commands

Name Description Type Status
az network application-gateway redirect-config create

Create a redirect configuration.

 Core GA
az network application-gateway redirect-config delete

Delete a redirect configuration.

 Core GA
az network application-gateway redirect-config list

List redirect configurations.

 Core GA
az network application-gateway redirect-config show

Get the details of a redirect configuration.

 Core GA
az network application-gateway redirect-config update

Update a redirect configuration.

 Core GA
az network application-gateway redirect-config wait

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

 Core GA

az network application-gateway redirect-config create

Edit

Create a redirect configuration.

az network application-gateway redirect-config create --gateway-name
                                                      --name
                                                      --resource-group
                                                      --type {Found, Permanent, SeeOther, Temporary}
                                                      [--include-path {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--include-query-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--target-listener]
                                                      [--target-url]

Examples

Create a redirect configuration to a http-listener called MyBackendListener.

az network application-gateway redirect-config create -g MyResourceGroup --gateway-name MyAppGateway -n MyRedirectConfig --type Permanent --include-path true --include-query-string true --target-listener MyBackendListener

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the redirect configuration.

--resource-group -g

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

--type -t

HTTP redirection type.

Accepted values: Found, Permanent, SeeOther, Temporary

Optional Parameters

--include-path

Whether to include path in the redirected url.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--include-query-string

Whether to include query string in the redirected url.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--target-listener

Name or ID of the HTTP listener to redirect the request to.

--target-url

URL to redirect the request to.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network application-gateway redirect-config delete

Edit

Delete a redirect configuration.

az network application-gateway redirect-config delete --gateway-name
                                                      --name
                                                      --resource-group
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete a redirect configuration.

az network application-gateway redirect-config delete -g MyResourceGroup --gateway-name MyAppGateway -n MyRedirectConfig

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the redirect configuration.

--resource-group -g

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

Optional Parameters

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network application-gateway redirect-config list

Edit

List redirect configurations.

az network application-gateway redirect-config list --gateway-name
                                                    --resource-group

Examples

List redirect configurations.

az network application-gateway redirect-config list -g MyResourceGroup --gateway-name MyAppGateway

Required Parameters

--gateway-name

Name of the application gateway.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network application-gateway redirect-config show

Edit

Get the details of a redirect configuration.

az network application-gateway redirect-config show --gateway-name
                                                    --name
                                                    --resource-group

Examples

Get the details of a redirect configuration.

az network application-gateway redirect-config show -g MyResourceGroup --gateway-name MyAppGateway -n MyRedirectConfig

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the redirect configuration.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network application-gateway redirect-config update

Edit

Update a redirect configuration.

az network application-gateway redirect-config update --gateway-name
                                                      --name
                                                      --resource-group
                                                      [--add]
                                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--include-path {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--include-query-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                      [--remove]
                                                      [--set]
                                                      [--target-listener]
                                                      [--target-url]
                                                      [--type {Found, Permanent, SeeOther, Temporary}]

Examples

Update a redirect configuration to a different http-listener.

az network application-gateway redirect-config update -g MyResourceGroup --gateway-name MyAppGateway -n MyRedirectConfig --type Permanent --target-listener MyNewBackendListener

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the redirect configuration.

--resource-group -g

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

Optional Parameters

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

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--include-path

Whether to include path in the redirected url.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--include-query-string

Whether to include query string in the redirected url.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

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

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.

--set

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

--target-listener

Name or ID of the HTTP listener to redirect the request to.

--target-url

URL to redirect the request to.

--type -t

HTTP redirection type.

Accepted values: Found, Permanent, SeeOther, Temporary
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az network application-gateway redirect-config wait

Edit

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

az network application-gateway redirect-config wait [--created]
                                                    [--custom]
                                                    [--deleted]
                                                    [--exists]
                                                    [--gateway-name]
                                                    [--ids]
                                                    [--interval]
                                                    [--resource-group]
                                                    [--subscription]
                                                    [--timeout]
                                                    [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--gateway-name

Name of the application gateway.

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

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.