Set-AzureRmVirtualNetworkGateway

モジュール:

AzureRM.Network

仮想ネットワーク ゲートウェイを更新します。

警告

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

AzureRM モジュールの機能は今後も使用できますが、メンテナンスやサポートは行われないため、引き続きの使用はユーザーの判断に委ねられ、リスクが発生することがあります。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmVirtualNetworkGateway
   -VirtualNetworkGateway <PSVirtualNetworkGateway>
   [-GatewaySku <String>]
   [-GatewayDefaultSite <PSLocalNetworkGateway>]
   [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>]
   [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>]
   [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>]
   [-Asn <UInt32>]
   [-PeerWeight <Int32>]
   [-EnableActiveActiveFeature]
   [-DisableActiveActiveFeature]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzureRmVirtualNetworkGateway
   -VirtualNetworkGateway <PSVirtualNetworkGateway>
   [-GatewaySku <String>]
   [-GatewayDefaultSite <PSLocalNetworkGateway>]
   [-VpnClientAddressPool <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientProtocol <System.Collections.Generic.List`1[System.String]>]
   [-VpnClientRootCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate]>]
   [-VpnClientRevokedCertificates <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate]>]
   [-VpnClientIpsecPolicy <System.Collections.Generic.List`1[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy]>]
   [-Asn <UInt32>]
   [-PeerWeight <Int32>]
   [-EnableActiveActiveFeature]
   [-DisableActiveActiveFeature]
   -RadiusServerAddress <String>
   -RadiusServerSecret <SecureString>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzureRmVirtualNetworkGateway コマンドレットは、仮想ネットワーク ゲートウェイを更新します。

例

例 1: 目標の状態を仮想ネットワーク ゲートウェイに設定する

PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
PS C:\> Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -Asn 1337

最初のコマンドは、リソース グループ ResourceGroup001 に属する Gateway01 という名前の仮想ネットワーク ゲートウェイを取得し、それを $Gateway という名前の変数に格納します。2 番目のコマンドは、変数 $Gatewayに格納されている仮想ネットワーク ゲートウェイの目標状態を設定します。 また、このコマンドは ASN を 1337 に設定します。

例 2: 目標の状態を仮想ネットワーク ゲートウェイに設定する

PS C:\>$Gateway = Get-AzureRmVirtualNetworkGateway -ResourceGroupName "ResourceGroup001" -Name "Gateway001"
PS C:\> $vpnclientipsecpolicy = New-AzureRmVpnClientIpsecPolicy -IpsecEncryption AES256 -IpsecIntegrity SHA256 -SALifeTimeSeconds 86472 -SADataSizeKilobytes 429497 -IkeEncryption AES256 -IkeIntegrity SHA256 -DhGroup DHGroup2 -PfsGroup None
PS C:\> $gateway = Set-AzureRmVirtualNetworkGateway -VirtualNetworkGateway $Gateway -VpnClientIpsecPolicy $vpnclientipsecpolicy

最初のコマンドは、リソース グループ ResourceGroup001 に属する Gateway01 という名前の仮想ネットワーク ゲートウェイを取得し、それを $Gateway という名前の変数に格納します。2 番目のコマンドは、指定された ipsec パラメーターに従って Vpn ipsec ポリシー オブジェクトを作成します。 3 番目のコマンドは、変数$Gatewayに格納されている仮想ネットワーク ゲートウェイの目標状態を設定します。 このコマンドは、仮想ネットワーク ゲートウェイの$vpnclientipsecpolicy オブジェクトで指定されたカスタム vpn ipsec ポリシーも設定します。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Asn

IPsec トンネル内で Border Gateway Protocol (BGP) セッションを設定するために使用される仮想ネットワーク ゲートウェイ自律システム番号 (ASN) を指定します。

型:	UInt32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableActiveActiveFeature

アクティブ/アクティブ機能を無効にします。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnableActiveActiveFeature

アクティブ/アクティブ機能を有効にします。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-GatewayDefaultSite

強制トンネリングに使用する既定のサイトを指定します。 既定のサイトが指定されている場合、ゲートウェイの仮想プライベート ネットワーク (VPN) からのすべてのインターネット トラフィックがそのサイトにルーティングされます。

型:	PSLocalNetworkGateway
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-GatewaySku

仮想ネットワーク ゲートウェイの在庫保持ユニット (SKU) を指定します。 このパラメーターの有効値は、次のとおりです。

• Basic
• Standard
• HighPerformance
• VpnGw1
• VpnGw2
• VpnGw3
• VpnGw1AZ
• VpnGw2AZ
• VpnGw3AZ
• ErGw1AZ
• ErGw2AZ
• ErGw3AZ

型:	String
指定可能な値:	Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PeerWeight

この仮想ネットワーク ゲートウェイから BGP 経由で学習されたルートに追加される重みを指定します

型:	Int32
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-RadiusServerAddress

P2S 外部 Radius サーバー アドレス。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-RadiusServerSecret

P2S 外部 Radius サーバー シークレット。

型:	SecureString
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VirtualNetworkGateway

基本の変更をオフにする仮想ネットワーク ゲートウェイ オブジェクトを指定します。 Get-AzureRmVirtualNetworkGateway コマンドレットを使用して、仮想ネットワーク ゲートウェイ オブジェクトを取得できます。

型:	PSVirtualNetworkGateway
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VpnClientAddressPool

このコマンドレットが VPN クライアントの IP アドレスの割り当てに使用するアドレス空間を指定します。 これは、仮想ネットワークまたはオンプレミスの範囲と重複しないようにする必要があります。

型:	List<T>[String]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VpnClientIpsecPolicy

P2S VPN クライアント トンネリング プロトコルの IPSec ポリシーの一覧。

型:	List<T>[PSIpsecPolicy]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VpnClientProtocol

P2S VPN クライアント トンネリング プロトコルの一覧

型:	List<T>[String]
指定可能な値:	SSTP, IkeV2, OpenVPN
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VpnClientRevokedCertificates

失効した VPN クライアント証明書の一覧を指定します。 これらのいずれかに一致する証明書を提示する VPN クライアントは削除されます。

型:	List<T>[PSVpnClientRevokedCertificate]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VpnClientRootCertificates

VPN クライアント認証に使用する VPN クライアント ルート証明書の一覧を指定します。 VPN クライアントに接続するには、これらのルート証明書のいずれかから生成された証明書を提示する必要があります。

型:	List<T>[PSVpnClientRootCertificate]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSVirtualNetworkGateway

パラメーター: VirtualNetworkGateway (ByValue)

String

PSLocalNetworkGateway

List<T>[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

List<T>[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRootCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]

List<T>[[Microsoft.Azure.Commands.Network.Models.PSVpnClientRevokedCertificate, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]

List<T>[[Microsoft.Azure.Commands.Network.Models.PSIpsecPolicy, Microsoft.Azure.Commands.Network, Version=6.4.1.0, Culture=neutral, PublicKeyToken=null]]

UInt32

Int32

SecureString

出力

PSVirtualNetworkGateway

メモ

• キーワード: azure, azurerm, arm, リソース, 管理, マネージャー, ネットワーク, ネットワーク

関連リンク

• Get-AzureRmVirtualNetworkGateway
• New-AzureRmVirtualNetworkGateway
• Remove-AzureRmVirtualNetworkGateway
• Reset-AzureRmVirtualNetworkGateway
• Resize-AzureRmVirtualNetworkGateway