Set-AzureVNetGatewayIPsecParameters

Sets IPsec parameters 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

Set-AzureVNetGatewayIPsecParameters
   -VNetName <String>
   -LocalNetworkSiteName <String>
   [-EncryptionType <String>]
   [-PfsGroup <String>]
   [-SADataSizeKilobytes <Int32>]
   [-SALifetimeSeconds <Int32>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Set-AzureVNetGatewayIPsecParameters cmdlet sets Internet Protocol security (IPsec) and Internet Key Exchange (IKE) parameters for the connection between a virtual network gateway and a local network site.

Parameters

-EncryptionType

Specifies the encryption type for the virtual network gateway. Valid values are:

  • NoEncryption
  • RequireEncryption
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocalNetworkSiteName

Specifies the name of the local network site connection on which this cmdlet configures the IPsec and IKE parameters.

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

-PfsGroup

Specifies the perfect forward secrecy (PFS) group. Valid values are:

  • PFS1
  • None
Type:String
Position:Named
Default value:None
Required:False
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

-SADataSizeKilobytes

Specifies the size, in kilobytes, of the security association (SA).

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

-SALifetimeSeconds

Specifies the period, in seconds, of the security association.

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

-VNetName

Specifies the virtual network for which this cmdlet sets IPsec parameters for the connection.

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