Set-AzureRmVpnClientIpsecParameter

既存の仮想ネットワーク ゲートウェイの vpn ipsec パラメーターを設定します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmVpnClientIpsecParameter
   -VirtualNetworkGatewayName <String>
   -ResourceGroupName <String>
   -VpnClientIPsecParameter <PSVpnClientIPsecParameters>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmVpnClientIpsecParameter
   -VirtualNetworkGatewayName <String>
   -ResourceGroupName <String>
   -VpnClientIPsecParameter <PSVpnClientIPsecParameters>
   -InputObject <PSVirtualNetworkGateway>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmVpnClientIpsecParameter
   -VirtualNetworkGatewayName <String>
   -ResourceGroupName <String>
   -VpnClientIPsecParameter <PSVpnClientIPsecParameters>
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzureRmVpnClientIpsecParameter コマンドレットは、既存の仮想ネットワーク ゲートウェイの vpn ipsec パラメーターを設定します。 仮想ネットワーク ゲートウェイが作成されると、ゲートウェイに既定の vpn ipsec ポリシーのセットが設定されます。 ポイント対サイト ユーザーが特定のカスタム ipsec ポリシーを使用して VPN Gateway に接続する場合、ユーザーはまず VPN Gateway でその ipsec ポリシーを設定する必要があります。 Set-AzureRmVpnClientIpsecParameter には、これを行う方法が用意されています。

例 1: カスタム vpn ipsec ポリシーを既存の仮想ネットワーク ゲートウェイに設定します。

PS C:\>$vpnclientipsecparams = New-AzureRmVpnClientIpsecParameter -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86473 -SADataSize 429498 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2
PS C:\> $setvpnIpsecParams = Set-AzureRmVpnClientIpsecParameter -VirtualNetworkGatewayName "ContosoLocalGateway" -ResourceGroupName "ContosoResourceGroup" -VpnClientIPsecParameter $vpnclientipsecparams

次の使用例は、ContosoResourceGroup という名前のリソース グループから ContosoVirtualGateway という名前の既存の仮想ネットワーク ゲートウェイにカスタム vpn ipsec ポリシーを設定します。 New-AzureRmVpnClientIpsecParameter コマンドレットは、ResourceGroup 内の既存の仮想ネットワーク ゲートウェイに対してユーザーが設定できる、渡された 1 つまたはすべてのパラメーターの値を使用する vpn ipsec パラメーター オブジェクトを作成するために使用されます。 この作成された VpnClientIPsecParameters オブジェクトは Set-AzureRmVpnClientIpsecParameter コマンドに渡され、上の例に示すように、仮想ネットワーク ゲートウェイで指定された Vpn ipsec カスタム ポリシーを設定します。 このコマンドは、設定されたパラメーターを示す VpnClientIPsecParameters のオブジェクトを返します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

仮想ネットワーク のゲートウェイ オブジェクト

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

-ResourceGroupName

リソース グループ名。

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

-ResourceId

Azure リソース ID。

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

-VirtualNetworkGatewayName

仮想ネットワーク ゲートウェイ名。

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

-VpnClientIPsecParameter

Vpn クライアントの ipsec パラメーター。 このパラメーター値は、PS コマンド let:New-AzureRmVpnClientIpsecParameter を使用して構築できます。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSVpnClientIPsecParameters

パラメーター: VpnClientIPsecParameter (ByValue)

PSVirtualNetworkGateway

Parameters: InputObject (ByValue)

String

出力

PSVpnClientIPsecParameters