Update-AzureRmVpnGateway

リファレンス

モジュール:: AzureRM.Network

Update-AzureRmVpnGateway は、スケーラブルな VPN ゲートウェイを適切な目標状態に更新します。

警告

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

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

構文

Update-AzureRmVpnGateway
      -ResourceGroupName <String>
      -Name <String>
      [-VpnConnection <PSVpnConnection[]>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureRmVpnGateway
      -InputObject <PSVpnGateway>
      [-VpnConnection <PSVpnConnection[]>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzureRmVpnGateway
      -ResourceId <String>
      [-VpnConnection <PSVpnConnection[]>]
      [-VpnGatewayScaleUnit <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Update-AzureRmVpnGateway は、スケーラブルな VPN ゲートウェイを適切な目標状態に更新します。 AzureRmVpnGateway は、VirtualHub 内のサイト間接続用のソフトウェア定義接続です。このゲートウェイは、ユーザーが指定したスケールユニットに基づいてサイズ変更とスケーリングを行います。 VPNSite と呼ばれるブランチ/サイトからスケーラブルゲートウェイへの接続を設定できます。各接続は、2 つのアクティブ/アクティブトンネルで構成されます。

例

例 1

PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG"
PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
PS C:\> $virtualHub = New-AzureRmVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
PS C:\> $vpnGateway = New-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -BGPPeeringWeight 10 -VpnGatewayScaleUnit 2
PS C:\> Set-AzureRmVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VpnGatewayScaleUnit 3

ResourceGroupName   : testRG
Name                : testvpngw
Id                  : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnGateways/testvpngw
Location            : West US
VpnGatewayScaleUnit : 3
VirtualHub          : /subscriptions/{subscriptionId}/resourceGroups/Ali_pS_Test/providers/Microsoft.Network/virtualHubs/westushub
BgpSettings         : {}
Type                : Microsoft.Network/vpnGateways
ProvisioningState   : Succeeded

上記では、Azure の "testRG" リソースグループに、リソースグループ Virtual WAN、Virtual Network、Virtual Hub を米国西部に作成します。その後、2 スケールユニットの仮想ハブに VPN ゲートウェイが作成されます。

ゲートウェイが作成されると、Set-AzureRmVpnGateway を使用してゲートウェイを 3 スケールユニットにアップグレードします。

パラメーター

-AsJob

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

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

-Confirm

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

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

-DefaultProfile

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

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

-InputObject

変更する VPN ゲートウェイオブジェクト

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

-Name

仮想 WAN 名。

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

-ResourceGroupName

リソースグループ名。

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

-ResourceId

変更する VpnGateway の Azure リソース ID。

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

-Tag

リソースタグを表すハッシュテーブル。

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

-VpnConnection

この VpnGateway に必要な VpnConnection の一覧。

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

-VpnGatewayScaleUnit

この VpnGateway のスケールユニット。

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

-WhatIf

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

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

入力

PSVpnGateway

String

出力