Set-​Azure​VNet​Gateway​Key

Sets the pre-shared key for the connection between an Azure VPN gateway and a local network site.

Syntax

Set-AzureVNetGatewayKey
   -LocalNetworkSiteName <String>
   [-Profile <AzureSMProfile>]
   -SharedKey <String>
   -VNetName <String>
   [<CommonParameters>]

Description

The Set-AzureVNetGatewayKey cmdlet sets the pre-shared key for the connection between an Azure virtual private network (VPN) gateway and an on-premises local network site. The key must be equal to the key configured on the gateway of the local network site. If the keys do not match, a connection cannot establish.

Required Parameters

-LocalNetworkSiteName

Specifies the name of the local network site that connects to the virtual network gateway.

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

Specifies the shared key to assign to the VPN gateway. The value must be an alpha-numerical string no longer than 128 characters.

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

Specifies the virtual network for which this cmdlet sets the shared key for the connection.

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

Optional Parameters

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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