Set-AzureVNetGatewayKey

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

Set-AzureVNetGatewayKey

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: Default
Set-AzureVNetGatewayKey [-VNetName] <String> [-LocalNetworkSiteName] <String> [-SharedKey] <String> [ <CommonParameters>]

Detailed Description

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

The Set-AzureVNetGatewayKey cmdlet sets the IPsec/IKE pre-shared key for the cross premises site-to-site VPN tunnel between the Azure virtual network and your on-premises local site.

Parameters

-LocalNetworkSiteName<String>

Specifies the name of the local network site to which the VPN tunnel connects.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SharedKey<String>

Specifies the value of the new IPsec/IKE pre-shared key. The SharedKey value is an alphanumeric string of 1-128 letters.

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.

Aliases	none
Required?	true
Position?	1
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

• None

  You cannot pipe input to this cmdlet.

Outputs

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

• Microsoft.WindowsAzure.Commands.ServiceManagement.Model.SharedKeyContext

Examples

Example 1: Set a shared key value

This command "sets" the IPsec/IKE pre-shared key for the cross premises site-to-site VPN tunnel between the MyAzureVirtualNetwork Azure virtual network and the MyOnPremSite local site to "a1b2c3d4".

PS C:\> Set-AzureVNetGatewayKey -VNetName "MyAzureVirtualNetwork" -LocalNetworkSiteName "MyOnPremSite" -SharedKey "a1b2c3d4"