az network application-gateway http-listener
Manage HTTP listeners of an application gateway.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network application-gateway http-listener create |
Create an HTTP listener. |
Core | GA |
az network application-gateway http-listener delete |
Delete an HTTP listener. |
Core | GA |
az network application-gateway http-listener list |
List HTTP listeners. |
Core | GA |
az network application-gateway http-listener show |
Get the details of an HTTP listener. |
Core | GA |
az network application-gateway http-listener update |
Update an HTTP listener. |
Core | GA |
az network application-gateway http-listener wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
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 {0, 1, f, false, n, no, t, true, y, yes}]
[--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
Name or ID of the frontend port.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Name of the application gateway.
Name of the HTTP listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name or ID of the frontend IP configuration.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Host name to use for multisite gateways.
Space-separated list of host names 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.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name or ID of the SSL certificate to use.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Name or ID of a SSL profile resource.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Name or ID of a web application firewall policy resource.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network application-gateway http-listener delete
Delete an HTTP listener.
az network application-gateway http-listener delete --gateway-name
--name
--resource-group
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
Examples
Delete an HTTP listener.
az network application-gateway http-listener delete -g MyResourceGroup --gateway-name MyAppGateway -n MyHttpListener
Required Parameters
Name of the application gateway.
Name of the HTTP listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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
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.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network application-gateway http-listener show
Get the details of an HTTP listener.
az network application-gateway http-listener show --gateway-name
--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
Required Parameters
Name of the application gateway.
Name of the HTTP 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.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network application-gateway http-listener update
Update an HTTP listener.
az network application-gateway http-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-name]
[--host-names]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--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
Required Parameters
Name of the application gateway.
Name of the HTTP listener.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name or ID of the frontend IP configuration.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Name or ID of the frontend port.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Host name to use for multisite gateways.
Space-separated list of host names 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.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name or ID of the SSL certificate to use.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Name or ID of a SSL profile resource.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Name or ID of a web application firewall policy resource.
Property | Value |
---|---|
Parameter group: | Gateway Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network application-gateway http-listener wait
Place the CLI in a waiting state until a condition is met.
az network application-gateway http-listener wait [--created]
[--custom]
[--deleted]
[--exists]
[--gateway-name]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Name of the application gateway.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |