Update-AzVpnSite

Module:

Az.Network

Updates a VPN site.

Syntax

Update-AzVpnSite
      -ResourceGroupName <String>
      -Name <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceGroupName <String>
      -Name <String>
      -VirtualWanResourceGroupName <String>
      -VirtualWanName <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceGroupName <String>
      -Name <String>
      -VirtualWanId <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceGroupName <String>
      -Name <String>
      -VirtualWan <PSVirtualWan>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -InputObject <PSVpnSite>
      -VirtualWanResourceGroupName <String>
      -VirtualWanName <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -InputObject <PSVpnSite>
      -VirtualWanId <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -InputObject <PSVpnSite>
      -VirtualWan <PSVirtualWan>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -InputObject <PSVpnSite>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceId <String>
      -VirtualWanResourceGroupName <String>
      -VirtualWanName <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceId <String>
      -VirtualWanId <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceId <String>
      -VirtualWan <PSVirtualWan>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzVpnSite
      -ResourceId <String>
      [-IpAddress <String>]
      [-AddressSpace <String[]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-VpnSiteLink <PSVpnSiteLink[]>]
      [-O365Policy <PSO365PolicyProperties>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzVpnSite cmdlet updates a VPN site.

Examples

Example 1

New-AzResourceGroup -Location "West US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
$vpnSiteAddressSpaces = New-Object string[] 2
$vpnSiteAddressSpaces[0] = "192.168.2.0/24"
$vpnSiteAddressSpaces[1] = "192.168.3.0/24"
New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10"
New-AzVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "2.3.5.5"

ResourceGroupName : testRG
Name              : testVpnSite
Id                : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite
Location          : eastus2euap
IpAddress         : 2.3.4.5
VirtualWan        : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN
AddressSpace      : {192.168.2.0/24, 192.168.3.0/24}
BgpSettings       :
Type              : Microsoft.Network/vpnSites
ProvisioningState : Succeeded

The above will create a resource group, Virtual WAN in West US in "testRG" resource group in Azure.

Then it creates a VpnSite to represent a customer branch and links it to the Virtual WAN.

Once the site is created, it updates the IpAddress of the site using the Set-AzVpnSite command.

Parameters

-AddressSpace

The address prefixes of the virtual network. Use this or AddressSpaceObject but not both.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BgpAsn

The BGP ASN for this VpnSite.

Type:	UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BgpPeeringAddress

The BGP Peering Address for this VpnSite.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BgpPeeringWeight

The BGP Peering weight for this VpnSite.

Type:	UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceModel

The device model of the remote vpn device.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceVendor

The device vendor of the remote vpn device.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

The vpn site object to be modified

Type:	PSVpnSite
Aliases:	VpnSite
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IpAddress

IP address of local network gateway.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LinkSpeedInMbps

The device model of the remote vpn device.

Type:	UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The resource name.

Type:	String
Aliases:	ResourceName, VpnSiteName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-O365Policy

The office 365 traffic breakout policy for this VpnSite.

Type:	PSO365PolicyProperties
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The resource group name.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

The Azure resource ID for the vpn site.

Type:	String
Aliases:	VpnSiteId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

A hashtable which represents resource tags.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualWan

The VirtualWan this VpnSite needs to be connected to.

Type:	PSVirtualWan
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualWanId

The ResourceId VirtualWan this VpnSite needs to be connected to.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualWanName

The name of the VirtualWan this VpnSite needs to be connected to.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualWanResourceGroupName

The resource group name of the VirtualWan this VpnSite needs to be connected to.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-VpnSiteLink

The list of VpnSiteLinks that this VpnSite have.

Type:	PSVpnSiteLink[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSVpnSite

String

Outputs

PSVpnSite

Related Links

• Get-AzVpnSite
• New-AzVpnSite
• Remove-AzVpnSite