az network vhub bgpconnection

Note

This reference is part of the virtual-wan extension for the Azure CLI (version 2.39.0 or higher). The extension will automatically install the first time you run an az network vhub bgpconnection command. Learn more about extensions.

Manage virtual hub bgpconnections.

Commands

az network vhub bgpconnection create

Create a virtual hub bgpconnection.

az network vhub bgpconnection delete

Delete a virtual hub bgpconnection.

az network vhub bgpconnection list

List virtual hub bgpconnections.

az network vhub bgpconnection show

Get the details of a virtual hub bgpconnection.

az network vhub bgpconnection update

Update settings of a virtual hub bgpconnection.

az network vhub bgpconnection wait

Place the CLI in a waiting state until a condition of virtual hub bgpconnection is met.

az network vhub bgpconnection create

Create a virtual hub bgpconnection.

az network vhub bgpconnection create --name
                                     --resource-group
                                     --vhub-name
                                     [--no-wait]
                                     [--peer-asn]
                                     [--peer-ip]
                                     [--vhub-conn]

Examples

Create a virtual hub bgpconnection.

az network vhub bgpconnection create -n MyConnection -g MyRG --vhub-name MyHub --peer-asn 20000  --peer-ip "10.5.0.3"
  --vhub-conn <vhub_connection_resource_id>

Required Parameters

--name -n

Name of the bgpconnection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--no-wait

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

--peer-asn

Peer ASN.

--peer-ip

Peer IP.

--vhub-conn

The resource id of vhub connection.

az network vhub bgpconnection delete

Delete a virtual hub bgpconnection.

az network vhub bgpconnection delete --name
                                     --resource-group
                                     --vhub-name
                                     [--no-wait]
                                     [--yes]

Examples

Delete a virtual hub bgpconnection.

az network vhub bgpconnection delete -n MyConnection --vhub-name MyHub -g MyRG

Required Parameters

--name -n

Name of the bgpconnection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

az network vhub bgpconnection list

List virtual hub bgpconnections.

az network vhub bgpconnection list --resource-group
                                   --vhub-name

Examples

List bgpconnections in a given virtual hub.

az network vhub bgpconnection list --vhub-name MyHub -g MyRG

Required Parameters

--resource-group -g

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

--vhub-name

Name of the virtual hub.

az network vhub bgpconnection show

Get the details of a virtual hub bgpconnection.

az network vhub bgpconnection show --name
                                   --resource-group
                                   --vhub-name

Examples

Get the details of a virtual hub bgpconnection.

az network vhub bgpconnection show -n MyConnection --vhub-name MyHub -g MyRG

Required Parameters

--name -n

Name of the bgpconnection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

az network vhub bgpconnection update

Update settings of a virtual hub bgpconnection.

az network vhub bgpconnection update --name
                                     --resource-group
                                     --vhub-name
                                     [--add]
                                     [--force-string]
                                     [--no-wait]
                                     [--peer-asn]
                                     [--peer-ip]
                                     [--remove]
                                     [--set]
                                     [--vhub-conn]

Examples

Update a virtual hub bgpconnection.

az network vhub bgpconnection update -n MyConnection --vhub-name MyHub -g MyRG --peer-asn 15000

Required Parameters

--name -n

Name of the bgpconnection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

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

--force-string

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

--no-wait

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

--peer-asn

Peer ASN.

--peer-ip

Peer IP.

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

--vhub-conn

The resource id of vhub connection.

az network vhub bgpconnection wait

Place the CLI in a waiting state until a condition of virtual hub bgpconnection is met.

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

Required Parameters

--name -n

Name of the bgpconnection.

--resource-group -g

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

--vhub-name

Name of the virtual hub.

Optional Parameters

--created

Wait until 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 until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.