az network lb outbound-rule

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

Create an outbound-rule.

az network lb outbound-rule create --address-pool --backend-address-pool
                                   --lb-name
                                   --name
                                   --protocol {All, Tcp, Udp}
                                   --resource-group
                                   [--allocated-outbound-ports --outbound-ports]
                                   [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--frontend-ip-configs]
                                   [--idle-timeout --idle-timeout-in-minutes]
                                   [--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.

Property	Value
Parameter group:	Properties Arguments

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

--protocol

The protocol for the outbound rule in load balancer.

Property	Value
Parameter group:	Properties Arguments
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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

The number of outbound ports to be used for NAT.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Properties Arguments

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

The timeout for the TCP idle connection.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb outbound-rule delete

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb outbound-rule list

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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb outbound-rule show

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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb outbound-rule update

Update an outbound-rule.

az network lb outbound-rule update --lb-name
                                   --name
                                   --resource-group
                                   [--add]
                                   [--address-pool --backend-address-pool]
                                   [--allocated-outbound-ports --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 --idle-timeout-in-minutes]
                                   [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

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

The name or ID of the backend address pool.

Property	Value
Parameter group:	Properties Arguments

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

The number of outbound ports to be used for NAT.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Properties Arguments

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

The timeout for the TCP idle connection.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--protocol

The protocol for the outbound rule in load balancer.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	All, Tcp, Udp

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network lb outbound-rule wait

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--lb-name

The load balancer name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False