az network application-gateway listener

  • Reference

Manage listeners of an application gateway.

Commands

Name Description Type Status
az network application-gateway listener create

Create a listener.

 Core GA
az network application-gateway listener delete

Delete a listener.

 Core GA
az network application-gateway listener list

List listeners.

 Core GA
az network application-gateway listener show

Get the details of a listener.

 Core GA
az network application-gateway listener update

Update a listener.

 Core GA
az network application-gateway listener wait

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

 Core GA

az network application-gateway listener create

Edit

Create a listener.

az network application-gateway listener create --frontend-port
                                               --gateway-name
                                               --name
                                               --resource-group
                                               [--frontend-ip]
                                               [--host-names]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ssl-cert]
                                               [--ssl-profile-id]

Examples

Create a listener.

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

Required Parameters

--frontend-port

Name or ID of the frontend port.

--gateway-name

Name of the application gateway.

--name -n

Name of the listener.

--resource-group -g

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

Optional Parameters

--frontend-ip

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

--host-names

List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ssl-cert

Name or ID of the SSL certificate to use.

--ssl-profile-id

Name or ID of the SSL profile to use.

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

Edit

Delete a listener.

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

Examples

Delete a listener.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the listener.

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

Edit

List listeners.

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

Examples

List listeners.

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

Edit

Get the details of a listener.

az network application-gateway listener show --gateway-name
                                             --name
                                             --resource-group

Examples

Get the details of a listener.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the 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.

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

Edit

Update a listener.

az network application-gateway listener update --gateway-name
                                               --name
                                               --resource-group
                                               [--add]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--frontend-ip]
                                               [--frontend-port]
                                               [--host-names]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--remove]
                                               [--set]
                                               [--ssl-cert]
                                               [--ssl-profile-id]

Examples

Update a listener to use a different frontend port.

az network application-gateway listener update -g MyResourceGroup --gateway-name MyAppGateway -n MyListener --frontend-port MyNewFrontendPort

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the listener.

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

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

--frontend-port

Name or ID of the frontend port.

--host-names

List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--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 OR --remove propertyToRemove.

--set

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

--ssl-cert

Name or ID of the SSL certificate to use.

--ssl-profile-id

Name or ID of the SSL profile to use.

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

Edit

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

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