az network application-gateway listener
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
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
Name or ID of the frontend port.
Name of the application gateway.
Name of the listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Name or ID of the frontend IP configuration. If only one exists, omit to use as default.
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.
Do not wait for the long-running operation to finish.
Name or ID of the SSL certificate to use.
Name or ID of the SSL profile to use.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway listener delete
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
Name of the application gateway.
Name of the listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway listener list
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
Name of the application gateway.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway listener show
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
Name of the application gateway.
Name of the listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway listener update
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
Name of the application gateway.
Name of the listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Name or ID of the frontend IP configuration. If only one exists, omit to use as default.
Name or ID of the frontend port.
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.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of the SSL certificate to use.
Name or ID of the SSL profile to use.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network application-gateway listener wait
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Name of the application gateway.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.