Update-AzVirtualHubBgpConnection

Module:

Az.Network Module

The Update-AzVirtualHubBgpConnection cmdlet updates an existing HubBgpConnection resource (Virtual WAN Hub BGP Connection).

Syntax

ByVirtualHubNameByHubVirtualNetworkConnectionObject (Default)

Update-AzVirtualHubBgpConnection
    -ResourceGroupName <String>
    -VirtualHubName <String>
    -Name <String>
    -PeerIp <String>
    -PeerAsn <UInt32>
    -VirtualHubVnetConnection <PSHubVirtualNetworkConnection>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Update-AzVirtualHubBgpConnection
    -ResourceGroupName <String>
    -VirtualHubName <String>
    -Name <String>
    -PeerIp <String>
    -PeerAsn <UInt32>
    -VirtualHubVnetConnectionId <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVirtualHubObjectByHubVirtualNetworkConnectionObject

Update-AzVirtualHubBgpConnection
    -Name <String>
    -PeerIp <String>
    -PeerAsn <UInt32>
    -VirtualHubVnetConnection <PSHubVirtualNetworkConnection>
    -VirtualHub <PSVirtualHub>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId

Update-AzVirtualHubBgpConnection
    -Name <String>
    -PeerIp <String>
    -PeerAsn <UInt32>
    -VirtualHubVnetConnectionId <String>
    -VirtualHub <PSVirtualHub>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject

Update-AzVirtualHubBgpConnection
    -PeerIp <String>
    -PeerAsn <UInt32>
    -VirtualHubVnetConnection <PSHubVirtualNetworkConnection>
    -ResourceId <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId

Update-AzVirtualHubBgpConnection
    -PeerIp <String>
    -PeerAsn <UInt32>
    -VirtualHubVnetConnectionId <String>
    -ResourceId <String>
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject

Update-AzVirtualHubBgpConnection
    -VirtualHubVnetConnection <PSHubVirtualNetworkConnection>
    -InputObject <PSBgpConnection>
    [-PeerIp <String>]
    [-PeerAsn <UInt32>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId

Update-AzVirtualHubBgpConnection
    -VirtualHubVnetConnectionId <String>
    -InputObject <PSBgpConnection>
    [-PeerIp <String>]
    [-PeerAsn <UInt32>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByHubBgpConnectionObject

Update-AzVirtualHubBgpConnection
    -InputObject <PSBgpConnection>
    [-PeerIp <String>]
    [-PeerAsn <UInt32>]
    [-VirtualHubVnetConnection <PSHubVirtualNetworkConnection>]
    [-VirtualHubVnetConnectionId <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AzVirtualHubBgpConnection cmdlet updates an existing HubBgpConnection resource (Virtual WAN Hub BGP Connection).

Examples

Example 1

New-AzResourceGroup -Location "West US" -Name "testRG"
$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "192.168.1.0/24"
$backendSubnet  = New-AzVirtualNetworkSubnetConfig -Name backendSubnet  -AddressPrefix "192.168.2.0/24"
$remoteVirtualNetwork = New-AzVirtualNetwork -Name "testVirtualNetwork" -ResourceGroupName "testRG" -Location "West US" -AddressPrefix "192.168.0.0/16" -Subnet $frontendSubnet,$backendSubnet
$virtualWan = New-AzVirtualWan -ResourceGroupName "testRG" -Name "testWan" -Location "West US"
New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "testHub" -AddressPrefix "10.0.1.0/24"
$hubVnetConnection = New-AzVirtualHubVnetConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testVnetConnection" -RemoteVirtualNetwork $remoteVirtualNetwork
New-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -PeerIp 192.168.1.5 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection
Update-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -PeerIp 192.168.1.6 -PeerAsn 20000 -Name "testBgpConnection" -VirtualHubVnetConnection $hubVnetConnection

Name                        : testBgpConnection
Id                          : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/bgpConnections/testBgpConnection
HubVirtualNetworkConnection : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualHubs/testHub/hubVirtualNetworkConnections/testVnetConnection
PeerAsn                     : 20000
PeerIp                      : 192.168.1.6

The above will create a resource group, Virtual WAN, Virtual Network, Virtual WAN Hub in West US and connect the Virtual Network to the Virtual WAN Hub in that resource group in Azure. A Virtual WAN Hub BGP Connection will be created thereafter which will peer the Virtual WAN Hub with the network appliance deployed in the Virtual Network. This Virtual WAN Hub BGP Connection is then updated to have a different Peer IP.

Parameters

-AsJob

Run cmdlet in the background

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The virtual hub bgp connection resource.

Parameter properties

Type:	PSBgpConnection
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	VirtualHubBgpConnection

Parameter sets

ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The resource name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ResourceName, BgpConnectionName

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PeerAsn

The peer ASN.

Parameter properties

Type:	UInt32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PeerIp

The peer IP.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

The resource id.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	BgpConnectionId

Parameter sets

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VirtualHub

The virtual hub resource.

Parameter properties

Type:	PSVirtualHub
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ParentObject, ParentVirtualHub

Parameter sets

ByVirtualHubObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VirtualHubName

The virtual hub name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ParentResourceName, ParentVirtualHubName

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VirtualHubVnetConnection

The VirtualHubVnetConnection resource.

Parameter properties

Type:	PSHubVirtualNetworkConnection
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionObjectByHubVirtualNetworkConnectionObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-VirtualHubVnetConnectionId

The VirtualHubVnetConnection resource id.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVirtualHubNameByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByVirtualHubObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionResourceIdByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

ByHubBgpConnectionObjectByHubVirtualNetworkConnectionResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSVirtualHub

PSBgpConnection

PSHubVirtualNetworkConnection

String

Outputs

PSBgpConnection

Related Links

• New-AzVirtualHubBgpConnection
• Get-AzVirtualHubBgpConnection
• Remove-AzVirtualHubBgpConnection