Get-AzureVNetGatewayKey
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Get-AzureVNetGatewayKey
Returns a shared key that can be used to configure a VPN device.
Parameter Set: Default
Get-AzureVNetGatewayKey [-VNetName] <String> [-LocalNetworkSiteName] <String> [ <CommonParameters>]
This topic describes the cmdlet in the .6.19 version of the Windows Azure PowerShell module. To find out the version of the module you're using, from the Windows Azure PowerShell console, type (get-module azure).version.
The Get-AzureVNetGatewayKey cmdlet returns the shared key used by the VPN device on the specified LocalNetworkSiteName to authenticate to the Windows Azure Virtual Network Gateway for the specified Windows Azure virtual network.
-LocalNetworkSiteName<String>
Specifies the local network site name for which to retrieve a shared key.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VNetName<String>
Specifies the name of the Windows Azure virtual network that the VPN device connects to.
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
-------------- Example 1 --------------
This command retrieves a shared-key to allow the VPN device at the specified local network site to authenticate to the specified virtual network.
PS C:\> Get-AzureVNetGatewayKey –VNetName "MyVirtualNetwork" –LocalNetworkSiteName "MyBranchOffice"