Edit

Share via

Set-AzureVirtualNetworkGatewayKey

  • Reference
Module:
Azure

Sets the key for an Azure virtual network gateway.

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

Set-AzureVirtualNetworkGatewayKey
   -GatewayId <String>
   -ConnectedEntityId <String>
   -SharedKey <String>
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Set-AzureVirtualNetworkGatewayKey cmdlet sets the key for an Azure virtual network gateway.

Parameters

-ConnectedEntityId

Specifies the ID of a connected entity.

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

-GatewayId

Specifies the ID of a 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

-SharedKey

Specifies a shared key.

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