Share via

az network lb address-pool tunnel-interface

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage tunnel interfaces of a load balancer.

Commands

Name Description Type Status
az network lb address-pool tunnel-interface add

Add one tunnel interface into the load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface list

List all tunnel interfacees of the load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface remove

Remove one tunnel interface from the load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface show

Get one tunnel interface of load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface update

Update one tunnel interface of load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface wait

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

 Core Preview

az network lb address-pool tunnel-interface add

Edit
Preview

Command group 'az network lb address-pool tunnel-interface' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add one tunnel interface into the load balance tunnel interface pool.

az network lb address-pool tunnel-interface add --address-pool --address-pool-name
                                                --identifier
                                                --lb-name
                                                --protocol {Native, None, VXLAN}
                                                --resource-group
                                                --type {External, Internal, None}
                                                [--index]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--port]

Examples

Add one tunnel interface into the load balance tunnel interface pool.

az network lb address-pool tunnel-interface add -g MyResourceGroup --lb-name MyLb --address-pool MyAddressPool --type external --protocol vxlan --identifier 901 --port 10000

Required Parameters

--address-pool --address-pool-name

The name of the backend address pool.

--identifier

Identifier of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties Arguments
--lb-name

The name of the load balancer.

--protocol

Protocol of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties Arguments
Accepted values: Native, None, VXLAN
--resource-group -g

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

--type

Traffic type of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties Arguments
Accepted values: External, Internal, None

Optional Parameters

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

--index

Index of the tunnel interfaces to change.

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

Port of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties 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 address-pool tunnel-interface list

Edit
Preview

Command group 'az network lb address-pool tunnel-interface' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all tunnel interfacees of the load balance tunnel interface pool.

az network lb address-pool tunnel-interface list --address-pool --address-pool-name
                                                 --lb-name
                                                 --resource-group

Examples

List all tunnel interfacees of the load balance tunnel interface pool.

az network lb address-pool tunnel-interface list -g MyResourceGroup --lb-name MyLb --address-pool MyAddressPool

Required Parameters

--address-pool --address-pool-name

The name of the backend address pool.

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

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 address-pool tunnel-interface remove

Edit
Preview

Command group 'az network lb address-pool tunnel-interface' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove one tunnel interface from the load balance tunnel interface pool.

az network lb address-pool tunnel-interface remove --address-pool --address-pool-name
                                                   --index
                                                   --lb-name
                                                   --resource-group
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove one tunnel interface from the load balance tunnel interface pool.

az network lb address-pool tunnel-interface remove -g MyResourceGroup --lb-name MyLb --address-pool MyAddressPool --index 0

Required Parameters

--address-pool --address-pool-name

The name of the backend address pool.

--index

Index of the tunnel interfaces to change.

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

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 address-pool tunnel-interface show

Edit
Preview

Command group 'az network lb address-pool tunnel-interface' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get one tunnel interface of load balance tunnel interface pool.

az network lb address-pool tunnel-interface show --address-pool --address-pool-name
                                                 --index
                                                 --lb-name
                                                 --resource-group

Examples

Get one tunnel interface from the load balance tunnel interface pool.

az network lb address-pool tunnel-interface show -g MyResourceGroup --lb-name MyLb --address-pool MyAddressPool --index 0

Required Parameters

--address-pool --address-pool-name

The name of the backend address pool.

--index

Index of the tunnel interfaces to change.

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

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 address-pool tunnel-interface update

Edit
Preview

Command group 'az network lb address-pool tunnel-interface' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update one tunnel interface of load balance tunnel interface pool.

az network lb address-pool tunnel-interface update --address-pool --address-pool-name
                                                   --index
                                                   --lb-name
                                                   --resource-group
                                                   [--add]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--identifier]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--port]
                                                   [--protocol {Native, None, VXLAN}]
                                                   [--remove]
                                                   [--set]
                                                   [--type {External, Internal, None}]

Examples

update one tunnel interface of load balance tunnel interface pool.

az network lb address-pool tunnel-interface update -g MyResourceGroup --lb-name MyLb --address-pool MyAddressPool --type external --protocol vxlan --identifier 901 --port 10000 --index 0

Required Parameters

--address-pool --address-pool-name

The name of the backend address pool.

--index

Index of the tunnel interfaces to change.

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

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

Identifier of gateway load balancer tunnel interface.

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

Port of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties Arguments
--protocol

Protocol of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties Arguments
Accepted values: Native, None, VXLAN
--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
--type

Traffic type of gateway load balancer tunnel interface.

Property Value
Parameter group: Properties Arguments
Accepted values: External, Internal, None
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 address-pool tunnel-interface wait

Edit
Preview

Command group 'az network lb address-pool tunnel-interface' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az network lb address-pool tunnel-interface wait [--address-pool --address-pool-name]
                                                 [--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.

--address-pool --address-pool-name

The name of the backend address pool.

Property Value
Parameter group: Resource Id Arguments
--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 name of the load balancer.

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