Edit

Share via

Get-AzureVNetGatewayKey

  • Reference
Module:
Azure

Gets the pre-shared key for the connection between a virtual network gateway and a local network site.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

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

Description

The Get-AzureVNetGatewayKey cmdlet gets the pre-shared key for the connection between a virtual network gateway and a local network site.

Parameters

-LocalNetworkSiteName

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

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

-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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VNetName

Specifies the virtual network for which this cmdlet gets the shared key for connections.

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