az network application-gateway redirect-config

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage redirect configurations.

Commands

az network application-gateway redirect-config create	Create a redirect configuration.
az network application-gateway redirect-config delete	Delete a redirect configuration.
az network application-gateway redirect-config list	List redirect configurations.
az network application-gateway redirect-config show	Get the details of a redirect configuration.
az network application-gateway redirect-config update	Update a redirect configuration.

az network application-gateway redirect-config create

Create a redirect configuration.

az network application-gateway redirect-config create --gateway-name
                                                      --name
                                                      --resource-group
                                                      --type {Found, Permanent, SeeOther, Temporary}
                                                      [--include-path {false, true}]
                                                      [--include-query-string {false, true}]
                                                      [--no-wait]
                                                      [--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

The 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

Include path in the redirected url.

accepted values: false, true

--include-query-string

Include query string in the redirected url.

accepted values: false, true

--no-wait

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

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

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

Delete a redirect configuration.

az network application-gateway redirect-config delete [--gateway-name]
                                                      [--ids]
                                                      [--name]
                                                      [--no-wait]
                                                      [--resource-group]

Examples

Delete a redirect configuration.

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

Optional Parameters

--gateway-name

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

--name -n

The name of the redirect configuration.

--no-wait

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

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

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

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

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

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

Get the details of a redirect configuration.

az network application-gateway redirect-config show [--gateway-name]
                                                    [--ids]
                                                    [--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

Optional Parameters

--gateway-name

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

--name -n

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

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

Update a redirect configuration.

az network application-gateway redirect-config update [--add]
                                                      [--force-string]
                                                      [--gateway-name]
                                                      [--ids]
                                                      [--include-path {false, true}]
                                                      [--include-query-string {false, true}]
                                                      [--name]
                                                      [--no-wait]
                                                      [--remove]
                                                      [--resource-group]
                                                      [--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

Update a redirect configuration. (autogenerated)

az network application-gateway redirect-config update --gateway-name MyAppGateway --include-path true --include-query-string true --name MyRedirectConfig --resource-group MyResourceGroup --target-listener MyNewBackendListener --type Permanent

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.

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

--include-path

Include path in the redirected url.

accepted values: false, true

--include-query-string

Include query string in the redirected url.

accepted values: false, true

--name -n

The name of the redirect configuration.

--no-wait

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

--remove

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

--resource-group -g

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

--set

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

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

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