Set-AzVpnClientIpsecParameter
既存の仮想ネットワーク ゲートウェイの vpn ipsec パラメーターを設定します。
構文
ByFactoryName (既定)
Set-AzVpnClientIpsecParameter
-VirtualNetworkGatewayName <String>
-ResourceGroupName <String>
-VpnClientIPsecParameter <PSVpnClientIPsecParameters>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByFactoryObject
Set-AzVpnClientIpsecParameter
-VirtualNetworkGatewayName <String>
-ResourceGroupName <String>
-VpnClientIPsecParameter <PSVpnClientIPsecParameters>
-InputObject <PSVirtualNetworkGateway>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceId
Set-AzVpnClientIpsecParameter
-VirtualNetworkGatewayName <String>
-ResourceGroupName <String>
-VpnClientIPsecParameter <PSVpnClientIPsecParameters>
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzVpnClientIpsecParameter コマンドレットは、既存の仮想ネットワーク ゲートウェイの vpn ipsec パラメーターを設定します。
仮想ネットワーク ゲートウェイが作成されると、ゲートウェイに既定の vpn ipsec ポリシーのセットが設定されます。 ポイント対サイト ユーザーが特定のカスタム ipsec ポリシーを使用して VPN Gateway に接続する場合、ユーザーはまず VPN Gateway でその ipsec ポリシーを設定する必要があります。
Set-AzVpnClientIpsecParameter には、これを行う方法が用意されています。
例
例 1: カスタム vpn ipsec ポリシーを既存の仮想ネットワーク ゲートウェイに設定します。
$vpnclientipsecparams = New-AzVpnClientIpsecParameter -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTime 86473 -SADataSize 429498 -IkeEncryption AES256 -IkeIntegrity SHA384 -DhGroup DHGroup2 -PfsGroup PFS2
$setvpnIpsecParams = Set-AzVpnClientIpsecParameter -VirtualNetworkGatewayName "ContosoLocalGateway" -ResourceGroupName "ContosoResourceGroup" -VpnClientIPsecParameter $vpnclientipsecparams
次の使用例は、ContosoResourceGroup という名前のリソース グループから ContosoVirtualGateway という名前の既存の仮想ネットワーク ゲートウェイにカスタム vpn ipsec ポリシーを設定します。
New-AzVpnClientIpsecParameter コマンドレットは、ResourceGroup 内の既存の仮想ネットワーク ゲートウェイに対してユーザーが設定できる、渡された 1 つまたはすべてのパラメーターの値を使用する vpn ipsec パラメーター オブジェクトを作成するために使用されます。
この作成された VpnClientIPsecParameters オブジェクトを Set-AzVpnClientIpsecParameter コマンドに渡して、上記の例に示すように、仮想ネットワーク ゲートウェイで指定された Vpn ipsec カスタム ポリシーを設定します。 このコマンドは、設定されたパラメーターを示す VpnClientIPsecParameters のオブジェクトを返します。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
仮想ネットワーク ゲートウェイ オブジェクト
ByFactoryObject
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループ名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceId
Azure リソース ID。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByResourceId
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-VirtualNetworkGatewayName
仮想ネットワーク ゲートウェイ名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-VpnClientIPsecParameter
Vpn クライアントの ipsec パラメーター。 このパラメーター値は、PS コマンド let を使用して構築できます:New-AzVpnClientIpsecParameter
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力