Resize-AzureRmVirtualNetworkGateway

NAME Resize-AzureRmVirtualNetworkGateway



SYNOPSIS

Resizes an existing virtual network gateway.





SYNTAX

Resize-AzureRmVirtualNetworkGateway [-DefaultProfile <IAzureContextContainer>] -GatewaySku {Basic | Standard | HighPerformance | UltraPerformance

| VpnGw1 | VpnGw2 | VpnGw3} -VirtualNetworkGateway <PSVirtualNetworkGateway> [<CommonParameters>]





DESCRIPTION

The Resize-AzureRmVirtualNetworkGateway cmdlet enables you to change the stock-keeping unit (SKU) for a virtual network gateway. SKUs determine

the capabilities of a gateway, including such things as throughput and the maximum number of IP tunnels that are allowed. Azure supports Basic,

Standard, High-Performance, VpnGw1, VpnGw2 and VpnGw3 SKUs (sometimes referred to as Small, Medium, and Large SKUs). For detailed information

about the capabilities of each SKU type, see https://azure.microsoft.com/en-us/docum ... ngateways/.



Keep in mind that SKUs differ in pricing as well as capabilities. For more information, see

https://azure.microsoft.com/en-us/prici ... n-gateway/.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-GatewaySku <String>

Specifies the new type of gateway SKU. The acceptable values for this parameter are:



- Basic



- Standard



- High Performance



- VpnGw1



- VpnGw2



- VpnGw3



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VirtualNetworkGateway <PSVirtualNetworkGateway>

Specifies an object reference to the virtual network gateway to be resized. You can create this object reference by using the

Get-AzureRmVirtualNetworkGateway and specifying the name of the gateway.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



This cmdlet accepts pipelined instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.





OUTPUTS



This cmdlet modifies existing instances of the Microsoft.Azure.Commands.Network.Models.PSVirtualNetworkGateway object.





NOTES





You cannot resize from Basic/Standard/HighPerformance SKUs to the new VpnGw1/VpnGw2/VpnGw3 SKUs. See

https://docs.microsoft.com/en-us/azure/ ... pngateways for instructions.



Example 1: Change the size of a virtual network gateway



PS C:\\>$Gateway = Get-AzureRmVirtualNetworkGateway -Name "ContosoVirtualGateway"

PS C:\\> Resize-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -GatewaySku "Basic"



This example changes the size of a virtual network gateway named ContosoVirtualGateway.



The first command creates an object reference to ContosoVirtualGateway; this object reference is stored in a variable named $Gateway.



The second command then uses the Resize-AzureRmVirtualNetworkGateway cmdlet to set the GatewaySku property to Basic.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... orkgateway

Get-AzureRmVpnClientPackage

Get-AzureRmVirtualNetworkGateway

Set-AzureRmVirtualNetworkGatewayVpnClientConfig