az network lb outbound-rule

Manage outbound rules of a load balancer.

Commands

az network lb outbound-rule create

Create an outbound-rule.

az network lb outbound-rule delete

Delete an outbound-rule.

az network lb outbound-rule list

List outbound rules.

az network lb outbound-rule show

Get the details of an outbound rule.

az network lb outbound-rule update

Update an outbound-rule.

az network lb outbound-rule create

Create an outbound-rule.

az network lb outbound-rule create --address-pool
                                   --frontend-ip-configs
                                   --lb-name
                                   --name
                                   --protocol {All, Tcp, Udp}
                                   --resource-group
                                   [--enable-tcp-reset {false, true}]
                                   [--idle-timeout]
                                   [--outbound-ports]
                                   [--subscription]

Examples

Create an outbound-rule. (autogenerated)

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

Name or ID of the backend address pool.

--frontend-ip-configs

Space-separated list of frontend IP configuration names or IDs.

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

--protocol

Network transport protocol.

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

--enable-tcp-reset

Receive bidirectional TCP reset on TCP flow idle timeout or unexpected connection termination. Only used when protocol is set to TCP.

accepted values: false, true
--idle-timeout

Idle timeout in minutes.

--outbound-ports

The number of outbound ports to be used for NAT.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network lb outbound-rule delete

Delete an outbound-rule.

az network lb outbound-rule delete --lb-name
                                   --name
                                   --resource-group
                                   [--subscription]

Examples

Delete an outbound-rule. (autogenerated)

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

Required Parameters

--lb-name

The name of the load balancer.

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network lb outbound-rule list

List outbound rules.

az network lb outbound-rule list --lb-name
                                 --resource-group
                                 [--query-examples]
                                 [--subscription]

Examples

List outbound rules. (autogenerated)

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

Required Parameters

--lb-name

The name of the load balancer.

--resource-group -g

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network lb outbound-rule show

Get the details of an outbound rule.

az network lb outbound-rule show --lb-name
                                 --name
                                 --resource-group
                                 [--query-examples]
                                 [--subscription]

Examples

Get the details of an outbound rule. (autogenerated)

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

Required Parameters

--lb-name

The name of the load balancer.

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network lb outbound-rule update

Update an outbound-rule.

az network lb outbound-rule update [--add]
                                   [--address-pool]
                                   [--enable-tcp-reset {false, true}]
                                   [--force-string]
                                   [--frontend-ip-configs]
                                   [--idle-timeout]
                                   [--ids]
                                   [--lb-name]
                                   [--name]
                                   [--outbound-ports]
                                   [--protocol {All, Tcp, Udp}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]

Examples

Update an outbound-rule. (autogenerated)

az network lb outbound-rule update --enable-tcp-reset true --lb-name MyLb --name MyOutboundRule --outbound-ports 10000 --resource-group MyResourceGroup

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

Name or ID of the backend address pool.

--enable-tcp-reset

Receive bidirectional TCP reset on TCP flow idle timeout or unexpected connection termination. Only used when protocol is set to TCP.

accepted values: false, true
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--frontend-ip-configs

Space-separated list of frontend IP configuration names or IDs.

--idle-timeout

Idle timeout in minutes.

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

--lb-name

The load balancer name.

--name -n

The name of the outbound rule.

--outbound-ports

The number of outbound ports to be used for NAT.

--protocol

Network transport protocol.

accepted values: All, Tcp, Udp
--remove

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

--resource-group -g

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

--set

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.