Application Gateway - az network application-gateway

Provides application-level routing and load balancing services.

Commands

az network application-gateway address-pool Manage backend address pools for an application gateway.
az network application-gateway address-pool create Create a backend address pool.
az network application-gateway address-pool delete Delete a backend address pool.
az network application-gateway address-pool list List backend address pools.
az network application-gateway address-pool show Show details of a backend address pool.
az network application-gateway address-pool update Update a backend address pool.
az network application-gateway auth-cert Manage authorization certificates for an application gateway.
az network application-gateway auth-cert create Create an authorization certificate.
az network application-gateway auth-cert delete Delete an authorization certificate.
az network application-gateway auth-cert list List authorization certificates.
az network application-gateway auth-cert show Show details of an authorization certificate.
az network application-gateway auth-cert update Update an authorization certificate.
az network application-gateway create Create an application gateway.
az network application-gateway delete Delete an application gateway.
az network application-gateway frontend-ip Manage frontend IP addresses for an application gateway.
az network application-gateway frontend-ip create Create a frontend IP address.
az network application-gateway frontend-ip delete Delete a frontend IP address.
az network application-gateway frontend-ip list List frontend IP addresses.
az network application-gateway frontend-ip show Show details of a frontend IP address.
az network application-gateway frontend-ip update Update a frontend IP address.
az network application-gateway frontend-port Manage frontend ports for an application gateway.
az network application-gateway frontend-port create Create a frontend port.
az network application-gateway frontend-port delete Delete a frontend port.
az network application-gateway frontend-port list List frontend ports.
az network application-gateway frontend-port show Show details of a frontend port.
az network application-gateway frontend-port update Update a frontend port.
az network application-gateway http-listener Manage HTTP listeners for an application gateway.
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 Show details of an HTTP listener.
az network application-gateway http-listener update Update an HTTP listener.
az network application-gateway http-settings Manage HTTP settings for an application gateway.
az network application-gateway http-settings create Create HTTP settings.
az network application-gateway http-settings delete Delete HTTP settings.
az network application-gateway http-settings list List HTTP settings.
az network application-gateway http-settings show Show details of HTTP settings.
az network application-gateway http-settings update Update HTTP settings.
az network application-gateway list List application gateways.
az network application-gateway probe Use probes to gather information, such as utilization, and then evaluate it by using rules.
az network application-gateway probe create Create a probe.
az network application-gateway probe delete Delete a probe.
az network application-gateway probe list List probes.
az network application-gateway probe show Show details of a probe.
az network application-gateway probe update Update a probe.
az network application-gateway redirect-config Manage redirect configurations.
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 Show details of a redirect configuration.
az network application-gateway redirect-config update Update a redirect configuration.
az network application-gateway rule Evaluate probe information and define routing rules.
az network application-gateway rule create Create a rule.
az network application-gateway rule delete Delete a rule.
az network application-gateway rule list List rules.
az network application-gateway rule show Show details of a rule.
az network application-gateway rule update Update a rule.
az network application-gateway show Show details of an application gateway.
az network application-gateway show-backend-health Show details about the backend health of an application gateway.
az network application-gateway ssl-cert Manage SSL certificates for an application gateway.
az network application-gateway ssl-cert create Upload an SSL certificate.
az network application-gateway ssl-cert delete Delete an SSL certificate.
az network application-gateway ssl-cert list List SSL certificates.
az network application-gateway ssl-cert show Show details of an SSL certificate.
az network application-gateway ssl-cert update Update an SSL certificate.
az network application-gateway ssl-policy Manage the SSL policy for an application gateway.
az network application-gateway ssl-policy list-options Lists available Ssl options for configuring Ssl policy.
az network application-gateway ssl-policy predefined Information on predefined SSL policies.
az network application-gateway ssl-policy predefined list Lists all SSL predefined policies for configuring Ssl policy.
az network application-gateway ssl-policy predefined show Gets Ssl predefined policy with the specified policy name.
az network application-gateway ssl-policy set Update or clear SSL policy settings.
az network application-gateway ssl-policy show Show the SSL policy settings.
az network application-gateway start Start an application gateway.
az network application-gateway stop Stop an application gateway.
az network application-gateway update Update an application gateway.
az network application-gateway url-path-map Manage URL path maps for an application gateway.
az network application-gateway url-path-map create Create a URL path map.
az network application-gateway url-path-map delete Delete a URL path map.
az network application-gateway url-path-map list List URL path maps.
az network application-gateway url-path-map rule Manage the rules for a URL path map.
az network application-gateway url-path-map rule create Create a rule for a URL path map.
az network application-gateway url-path-map rule delete Delete a rule for a URL path map.
az network application-gateway url-path-map show Show details of a URL path map.
az network application-gateway url-path-map update Update a URL path map.
az network application-gateway waf-config Configure the settings of a web application firewall.
az network application-gateway waf-config list-rule-sets (PREVIEW) Lookup information on available WAF rule sets, rule groups, and rule IDs.
az network application-gateway waf-config set Update the firewall configuration of a web application.
az network application-gateway waf-config show Show the firewall configuration of a web application.
az network application-gateway wait Place the CLI in a waiting state until a condition of the application gateway is met.

az network application-gateway create

Create an application gateway.

az network application-gateway create --name
--resource-group
[--capacity]
[--cert-file]
[--cert-password]
[--connection-draining-timeout]
[--frontend-port]
[--http-settings-cookie-based-affinity {Disabled, Enabled}]
[--http-settings-port]
[--http-settings-protocol {Http, Https}]
[--location]
[--no-wait]
[--private-ip-address]
[--public-ip-address]
[--public-ip-address-allocation]
[--routing-rule-type {Basic, PathBasedRouting}]
[--servers]
[--sku {Standard_Large, Standard_Medium, Standard_Small, WAF_Large, WAF_Medium}]
[--subnet]
[--subnet-address-prefix]
[--tags]
[--validate]
[--vnet-address-prefix]
[--vnet-name]

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

Optional Parameters

--capacity

The number of instances to use with the application gateway.

default value: 2
--cert-file

The path to the PFX certificate file.

--cert-password

The certificate password.

--connection-draining-timeout

The time in seconds after a backend server is removed during which on open connection remains active. Range: 0 (disabled) to 3600.

--frontend-port

The front end port number.

--http-settings-cookie-based-affinity

Enable or disable HTTP settings cookie-based affinity.

accepted values: Disabled, Enabled
default value: disabled
--http-settings-port

The HTTP settings port.

default value: 80
--http-settings-protocol

The HTTP settings protocol.

accepted values: Http, Https
default value: Http
--location -l

Location. You can configure the default location using az configure --defaults location=.

--no-wait

Do not wait for the long running operation to finish.

--private-ip-address

Static private IP address to use.

--public-ip-address

Name or ID of a public IP address. Uses existing resource or creates new if specified, or none if omitted.

--public-ip-address-allocation

The kind of IP allocation to use when creating a new public IP.

default value: Dynamic
--routing-rule-type

The request routing rule type.

accepted values: Basic, PathBasedRouting
default value: Basic
--servers

Space separated list of IP addresses or DNS names corresponding to backend servers.

--sku

The name of the SKU.

accepted values: Standard_Large, Standard_Medium, Standard_Small, WAF_Large, WAF_Medium
default value: Standard_Medium
--subnet

Name or ID of the subnet. Will create resource if it does not exist. If name specified, also specify --vnet-name.

default value: default
--subnet-address-prefix

The CIDR prefix to use when creating a new subnet.

default value: 10.0.0.0/24
--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

--validate

Generate and validate the ARM template without creating any resources.

--vnet-address-prefix

The CIDR prefix to use when creating a new VNet.

default value: 10.0.0.0/16
--vnet-name

The virtual network (VNet) name.

az network application-gateway delete

Delete an application gateway.

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

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long running operation to finish.

az network application-gateway list

List application gateways.

az network application-gateway list [--resource-group]

Optional Parameters

--resource-group -g

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

az network application-gateway show

Show details of an application gateway.

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

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

az network application-gateway show-backend-health

Show details about the backend health of an application gateway.

az network application-gateway show-backend-health --name
--resource-group
[--expand]

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

Optional Parameters

--expand

Expands BackendAddressPool and BackendHttpSettings referenced in backend health.

az network application-gateway start

Start an application gateway.

az network application-gateway start --name
--resource-group

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

az network application-gateway stop

Stop an application gateway.

az network application-gateway stop --name
--resource-group

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

az network application-gateway update

Update an application gateway.

az network application-gateway update --name
--resource-group
[--add]
[--capacity]
[--no-wait]
[--remove]
[--set]
[--sku {Standard_Large, Standard_Medium, Standard_Small, WAF_Large, WAF_Medium}]
[--tags]

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .

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

--set

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

--sku

The name of the SKU.

accepted values: Standard_Large, Standard_Medium, Standard_Small, WAF_Large, WAF_Medium
--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

az network application-gateway wait

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

az network application-gateway wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]

Required Parameters

--name -n

The name of the application gateway.

--resource-group -g

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

Optional Parameters

--created

Wait till created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait till deleted.

--exists

Wait till the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait till updated with provisioningState at 'Succeeded'.