az network application-gateway http-listener

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 HTTP listeners of an application gateway.

Commands

az network application-gateway http-listener create	Create an HTTP listener.
az network application-gateway http-listener delete	Delete an HTTP listener.
az network application-gateway http-listener list	List HTTP listeners.
az network application-gateway http-listener show	Get the details of an HTTP listener.
az network application-gateway http-listener update	Update an HTTP listener.

az network application-gateway http-listener create

Create an HTTP listener.

az network application-gateway http-listener create --frontend-port
                                                    --gateway-name
                                                    --name
                                                    --resource-group
                                                    [--frontend-ip]
                                                    [--host-name]
                                                    [--host-names]
                                                    [--no-wait]
                                                    [--ssl-cert]
                                                    [--ssl-profile-id]
                                                    [--waf-policy]

Examples

Create an HTTP listener.

az network application-gateway http-listener create -g MyResourceGroup --gateway-name MyAppGateway \
    --frontend-port MyFrontendPort -n MyHttpListener --frontend-ip MyAppGatewayPublicIp

Required Parameters

--frontend-port

The name or ID of the frontend port.

--gateway-name

Name of the application gateway.

--name -n

The name of the HTTP listener.

--resource-group -g

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

Optional Parameters

--frontend-ip

The name or ID of the frontend IP configuration. If only one exists, omit to use as default.

--host-name

Host name to use for multisite gateways.

--host-names

Space-separated list of host names that allows special wildcard characters as well.

--no-wait

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

--ssl-cert

The name or ID of the SSL certificate to use.

--ssl-profile-id

SSL profile resource of the application gateway.

--waf-policy

Name or ID of a Firewall Policy resource.

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 http-listener delete

Delete an HTTP listener.

az network application-gateway http-listener delete [--gateway-name]
                                                    [--ids]
                                                    [--name]
                                                    [--no-wait]
                                                    [--resource-group]

Examples

Delete an HTTP listener.

az network application-gateway http-listener delete -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpListener

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

--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 http-listener list

List HTTP listeners.

az network application-gateway http-listener list --gateway-name
                                                  --resource-group

Examples

List HTTP listeners.

az network application-gateway http-listener 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 http-listener show

Get the details of an HTTP listener.

az network application-gateway http-listener show [--gateway-name]
                                                  [--ids]
                                                  [--name]
                                                  [--resource-group]

Examples

Get the details of an HTTP listener.

az network application-gateway http-listener show -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpListener

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

--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 http-listener update

Update an HTTP listener.

az network application-gateway http-listener update [--add]
                                                    [--force-string]
                                                    [--frontend-ip]
                                                    [--frontend-port]
                                                    [--gateway-name]
                                                    [--host-name]
                                                    [--host-names]
                                                    [--ids]
                                                    [--name]
                                                    [--no-wait]
                                                    [--remove]
                                                    [--resource-group]
                                                    [--set]
                                                    [--ssl-cert]
                                                    [--ssl-profile-id]
                                                    [--waf-policy]

Examples

Update an HTTP listener to use a different hostname.

az network application-gateway http-listener update -g MyResourceGroup --gateway-name MyAppGateway \
    -n MyHttpListener --host-name www.mynewhost.com

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.

--frontend-ip

The name or ID of the frontend IP configuration.

--frontend-port

The name or ID of the frontend port.

--gateway-name

Name of the application gateway.

--host-name

Host name to use for multisite gateways.

--host-names

Space-separated list of host names that allows special wildcard characters as well.

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

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

--ssl-cert

The name or ID of the SSL certificate to use.

--ssl-profile-id

SSL profile resource of the application gateway.

--waf-policy

Name or ID of a Firewall Policy resource.

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.