Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureVNetGateway

Set-AzureVNetGateway

microsoft.windowsazure.commands.servicemanagement.dll, microsoft.windowsazure.commands.servicemanagement.network.dll

Synopsis

Enables or disables a Microsoft Azure Virtual Network Gateway.

Syntax

Set-AzureVNetGateway [-Connect] [-VNetName] [-LocalNetworkSiteName] [<CommonParameters>]

Set-AzureVNetGateway [-Disconnect] [-VNetName] [-LocalNetworkSiteName] [<CommonParameters>]

Detailed Description

The Set-AzureVNetGateway cmdlet enables or disables a virtual network gateway for the specified Microsoft Azure virtual network. A virtual network gateway is a virtual private network (VPN) endpoint for connecting to a virtual network.The Set-AzureVNetGateway cmdlet supports two functional parameters: Connect and Disconnect. These parameters allow you to enable or disable the VPN connection between the specified LocalNetworkSiteName and the specified virtual network.

Parameters

-Connect <SwitchParameter>

Enables the VPN connection between the specified virtual network and the local network site.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-VNetName <String>

Specifies the name of the Microsoft Azure virtual network to connect or disconnect.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LocalNetworkSiteName <String>

Specifies the name of the local network site for which the VPN connection will be enabled or disabled.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Disconnect <SwitchParameter>

Disables the VPN connection between the specified virtual network and the local network site.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Test <switchparameter>

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

This command enables the virtual network gateway between the Microsoft Azure virtual network, "MyProdNet" and the VPN device for the local network site, "MyBranchOffice".

PS C:\> Set-AzureVNetGateway -Connect –VnetName "MyProdNet" –LocalNetworkSiteName "MyBranchOffice"

-------------------------- Example 2 --------------------------

This command disables the virtual network gateway between the Microsoft Azure virtual network, "MyProdNet" and the VPN device for the local network site "MyBranchOffice".

PS C:\> Set-AzureVNetGateway -Disconnect –VnetName "MyProdNet" –LocalNetworkSiteName "MyBranchOffice"