SALES: 1-800-867-1380

Set-AzureVNetGateway

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Set-AzureVNetGateway

This topic is deprecated and will be removed in the future. It describes the cmdlet in the 0.8.7 version of the Microsoft Azure PowerShell module. To find out the version of the module you're using, from the Azure PowerShell console, type (get-module azure).version.

Syntax

Parameter Set: Connect
Set-AzureVNetGateway [-Connect] [-VNetName] <String> [-LocalNetworkSiteName] <String> [ <CommonParameters>]

Parameter Set: Disconnect
Set-AzureVNetGateway [-Disconnect] [-VNetName] <String> [-LocalNetworkSiteName] <String> [ <CommonParameters>]




Detailed Description

For a more recent version of the reference, see Azure Management Cmdlets.

The Set-AzureVNetGateway cmdlet enables or disables a virtual network gateway for the specified 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

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Disconnect

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


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?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VNetName<String>

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


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

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

This command enables the virtual network gateway between the 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 Azure virtual network, "MyProdNet" and the VPN device for the local network site "MyBranchOffice".


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

Related topics

Get-AzureVNetGateway

Get-AzureVNetConfig

Remove-AzureVNetGateway

Set-AzureVNetConfig

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft