az network lb outbound-rule

  • Reference

Manage outbound rules of a load balancer.

Commands

Name Description Type Status
az network lb outbound-rule create

Create an outbound-rule.

 Core GA
az network lb outbound-rule delete

Delete an outbound-rule.

 Core GA
az network lb outbound-rule list

List outbound rules.

 Core GA
az network lb outbound-rule show

Get the details of an outbound rule.

 Core GA
az network lb outbound-rule update

Update an outbound-rule.

 Core GA
az network lb outbound-rule wait

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

 Core GA

az network lb outbound-rule create

Edit

Create an outbound-rule.

az network lb outbound-rule create --address-pool
                                   --lb-name
                                   --name
                                   --protocol {All, Tcp, Udp}
                                   --resource-group
                                   [--allocated-outbound-ports]
                                   [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--frontend-ip-configs]
                                   [--idle-timeout]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create an outbound-rule.

az network lb outbound-rule create --address-pool MyAddressPool --frontend-ip-configs myfrontendoutbound --idle-timeout 5 --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --protocol Udp --resource-group MyResourceGroup

Required Parameters

--address-pool --backend-address-pool

The name or ID of the backend address pool.

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

--protocol

The protocol for the outbound rule in load balancer.

accepted values: All, Tcp, Udp
--resource-group -g

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

Optional Parameters

--allocated-outbound-ports --outbound-ports

The number of outbound ports to be used for NAT.

--enable-tcp-reset

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--frontend-ip-configs

The List of frontend IP configuration IDs or names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--idle-timeout --idle-timeout-in-minutes

The timeout for the TCP idle connection.

--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 lb outbound-rule delete

Edit

Delete an outbound-rule.

az network lb outbound-rule delete --lb-name
                                   --name
                                   --resource-group
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete an outbound-rule.

az az network lb outbound-rule delete --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

--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 lb outbound-rule list

Edit

List outbound rules.

az network lb outbound-rule list --lb-name
                                 --resource-group

Examples

List outbound rules.

az network lb outbound-rule list --lb-name MyLb --resource-group MyResourceGroup

Required Parameters

--lb-name

The load balancer name.

--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 lb outbound-rule show

Edit

Get the details of an outbound rule.

az network lb outbound-rule show --lb-name
                                 --name
                                 --resource-group

Examples

Get the details of an outbound rule.

az network lb outbound-rule show --lb-name MyLb --name MyOutboundRule --resource-group MyResourceGroup

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

--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 lb outbound-rule update

Edit

Update an outbound-rule.

az network lb outbound-rule update --lb-name
                                   --name
                                   --resource-group
                                   [--add]
                                   [--address-pool]
                                   [--allocated-outbound-ports]
                                   [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--frontend-ip-configs]
                                   [--idle-timeout]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--protocol {All, Tcp, Udp}]
                                   [--remove]
                                   [--set]

Examples

Update an outbound-rule.

az network lb outbound-rule update --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

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

--address-pool --backend-address-pool

The name or ID of the backend address pool.

--allocated-outbound-ports --outbound-ports

The number of outbound ports to be used for NAT.

--enable-tcp-reset

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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-configs

The List of frontend IP configuration IDs or names. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--idle-timeout --idle-timeout-in-minutes

The timeout for the TCP idle connection.

--no-wait

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

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

The protocol for the outbound rule in load balancer.

accepted values: All, Tcp, Udp
--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=.

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 lb outbound-rule wait

Edit

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

az network lb outbound-rule wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--lb-name]
                                 [--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
--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
--lb-name

The load balancer name.

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