Update-AzVpnGateway
スケーラブルな VPN ゲートウェイを更新します。
構文
Update-AzVpnGateway
-ResourceGroupName <String>
-Name <String>
[-VpnConnection <PSVpnConnection[]>]
[-VpnGatewayNatRule <PSVpnGatewayNatRule[]>]
[-VpnGatewayScaleUnit <UInt32>]
[-BgpPeeringAddress <PSIpConfigurationBgpPeeringAddress[]>]
[-EnableBgpRouteTranslationForNat <Boolean>]
[-Tag <Hashtable>]
[-Asn <UInt32>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzVpnGateway
-InputObject <PSVpnGateway>
[-VpnConnection <PSVpnConnection[]>]
[-VpnGatewayNatRule <PSVpnGatewayNatRule[]>]
[-VpnGatewayScaleUnit <UInt32>]
[-BgpPeeringAddress <PSIpConfigurationBgpPeeringAddress[]>]
[-EnableBgpRouteTranslationForNat <Boolean>]
[-Tag <Hashtable>]
[-Asn <UInt32>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzVpnGateway
-ResourceId <String>
[-VpnConnection <PSVpnConnection[]>]
[-VpnGatewayNatRule <PSVpnGatewayNatRule[]>]
[-VpnGatewayScaleUnit <UInt32>]
[-BgpPeeringAddress <PSIpConfigurationBgpPeeringAddress[]>]
[-EnableBgpRouteTranslationForNat <Boolean>]
[-Tag <Hashtable>]
[-Asn <UInt32>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Update-AzVpnGateway コマンドレットは、スケーラブルな VPN ゲートウェイを更新します。
Azure VPN ゲートウェイは、VirtualHub 内のサイト間接続用のソフトウェア定義接続です。 このゲートウェイは、ユーザーが指定したスケール ユニットに基づいてサイズ変更とスケーリングを行います。 VPN サイトと呼ばれるブランチ/サイトからスケーラブル ゲートウェイへの接続を設定できます。 各接続は、2 つのアクティブ/アクティブ トンネルで構成されます。
例
例 1
New-AzResourceGroup -Location "West US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
$vpnGateway = New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2
Update-AzVpnGateway -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 ゲートウェイが作成されます。
ゲートウェイが作成されると、Update-AzVpnGateway を使用してゲートウェイを 3 スケール ユニットにアップグレードします。
例 2
New-AzResourceGroup -Location "West US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
$vpnGateway = New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2
$ipconfigurationId1 = 'Instance0'
$addresslist1 = @('169.254.21.5')
$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1
$ipconfigurationId2 = 'Instance1'
$addresslist2 = @('169.254.21.10')
$gw1ipconfBgp2 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId2 -CustomAddress $addresslist2
$gw = Get-AzVpnGateway -ResourceGroupName testRg -Name testgw
Update-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -BgpPeeringAddress @($gw1ipconfBgp1,$gw1ipconfBgp2)
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-AzVpnGateway を使用して BgpPeeringAddress が更新されます。
例 3
$gw = Get-AzVpnGateway -ResourceGroupName "testRg" -Name "testgw"
$gw.BgpSettings.BgpPeeringAddresses
$gw.BgpSettings.BgpPeeringAddresses[0].CustomBgpIpAddresses=$null
$gw.BgpSettings.BgpPeeringAddresses[1].CustomBgpIpAddresses=$null
$gw.BgpSettings.BgpPeeringAddresses
Update-AzVpnGateway -InputObject $gw
上記の例では、既定の BgpPeeringAddress を使用するように Virtual WAN VPN Gateway を更新します。
例 4
New-AzResourceGroup -Location "West US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
$vpnGateway = New-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -VirtualHubId $virtualHub.Id -VpnGatewayScaleUnit 2
$ipconfigurationId1 = 'Instance0'
$addresslist1 = @()
$gw1ipconfBgp1 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId1 -CustomAddress $addresslist1
$ipconfigurationId2 = 'Instance1'
$addresslist2 = @()
$gw1ipconfBgp2 = New-AzIpConfigurationBgpPeeringAddressObject -IpConfigurationId $ipconfigurationId2 -CustomAddress $addresslist2
$gw = Get-AzVpnGateway -ResourceGroupName testRg -Name testgw
Update-AzVpnGateway -ResourceGroupName "testRG" -Name "testvpngw" -BgpPeeringAddress @($gw1ipconfBgp1,$gw1ipconfBgp2)
上記の例では、既定の BgpPeeringAddress を使用するように Virtual WAN VPN Gateway を更新します。
Update-AzVpnGateway を使用して BgpPeeringAddress を更新します
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Asn
VPN 経由の BGP 用 VPN ゲートウェイの ASN
型: | UInt32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-BgpPeeringAddress
この VpnGateway bgpsettings の BGP ピアリング アドレス。
型: | PSIpConfigurationBgpPeeringAddress[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EnableBgpRouteTranslationForNat
この VpnGateway で NAT の Bgp ルート変換を有効または無効にするフラグ。
型: | Nullable<T>[Boolean] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InputObject
変更する VPN ゲートウェイ オブジェクト
型: | PSVpnGateway |
Aliases: | VpnGateway |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
VPN ゲートウェイ名。
型: | 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 |
-VpnGatewayNatRule
この VpnGateway に関連付けられている VpnGatewayNatRules の一覧。
型: | PSVpnGatewayNatRule[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VpnGatewayScaleUnit
この VpnGateway のスケール ユニット。
型: | UInt32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
出力
関連リンク
Azure PowerShell