Update-AzureRmVpnSite

  • リファレンス
モジュール:
AzureRM.Network

顧客ブランチを表す VpnSite を目的の目標状態に更新します。

警告

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

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

構文

Update-AzureRmVpnSite
      -ResourceGroupName <String>
      -Name <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceGroupName <String>
      -Name <String>
      -VirtualWanResourceGroupName <String>
      -VirtualWanName <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceGroupName <String>
      -Name <String>
      -VirtualWanId <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceGroupName <String>
      -Name <String>
      -VirtualWan <PSVirtualWan>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -InputObject <PSVpnSite>
      -VirtualWanResourceGroupName <String>
      -VirtualWanName <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -InputObject <PSVpnSite>
      -VirtualWanId <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -InputObject <PSVpnSite>
      -VirtualWan <PSVirtualWan>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -InputObject <PSVpnSite>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceId <String>
      -VirtualWanResourceGroupName <String>
      -VirtualWanName <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceId <String>
      -VirtualWanId <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceId <String>
      -VirtualWan <PSVirtualWan>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzureRmVpnSite
      -ResourceId <String>
      [-IpAddress <String>]
      [-AddressSpace <System.Collections.Generic.List`1[System.String]>]
      [-DeviceModel <String>]
      [-DeviceVendor <String>]
      [-LinkSpeedInMbps <UInt32>]
      [-BgpAsn <UInt32>]
      [-BgpPeeringAddress <String>]
      [-BgpPeeringWeight <UInt32>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

顧客ブランチを表す VpnSite を目的の目標状態に更新します。

例

例 1

PS C:\> New-AzureRmResourceGroup -Location "West US" -Name "testRG"
PS C:\> $virtualWan = New-AzureRmVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West US"
PS C:\> $vpnSiteAddressSpaces = New-Object string[] 2
PS C:\> $vpnSiteAddressSpaces[0] = "192.168.2.0/24"
PS C:\> $vpnSiteAddressSpaces[1] = "192.168.3.0/24"
PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "1.2.3.4" -AddressSpace $vpnSiteAddressSpaces -DeviceModel "SomeDevice" -DeviceVendor "SomeDeviceVendor" -LinkSpeedInMbps "10"
PS C:\> New-AzureRmVpnSite -ResourceGroupName "testRG" -Name "testVpnSite" -Location "West US" -VirtualWan $virtualWan -IpAddress "2.3.5.5"

ResourceGroupName : testRG
Name              : testVpnSite
Id                : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/vpnSites/testVpnSite
Location          : eastus2euap
IpAddress         : 2.3.4.5
VirtualWan        : /subscriptions/{subscriptionId}/resourceGroups/testRG/providers/Microsoft.Network/virtualWans/myVirtualWAN
AddressSpace      : {192.168.2.0/24, 192.168.3.0/24}
BgpSettings       :
Type              : Microsoft.Network/vpnSites
ProvisioningState : Succeeded

上記では、Azure の "testRG" リソース グループにリソース グループ Virtual WAN を米国西部に作成します。

次に、顧客ブランチを表す VpnSite を作成し、Virtual WAN にリンクします。

サイトが作成されると、Set-AzureRmVpnSite コマンドを使用してサイトの IpAddress が更新されます。

パラメーター

-AddressSpace

仮想ネットワークのアドレス プレフィックス。 このオブジェクトまたは AddressSpaceObject は使用しますが、両方は使用しないでください。

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

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

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

-BgpAsn

この VpnSite の BGP ASN。

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

-BgpPeeringAddress

この VpnSite の BGP ピアリング アドレス。

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

-BgpPeeringWeight

この VpnSite の BGP ピアリングの重み。

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

-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

-DeviceModel

リモート VPN デバイスのデバイス モデル。

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

-DeviceVendor

リモート VPN デバイスのデバイス ベンダー。

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

-InputObject

変更する VPN サイト オブジェクト

Type:PSVpnSite
Aliases:VpnSite
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IpAddress

ローカル ネットワーク ゲートウェイの IP アドレス。

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

-LinkSpeedInMbps

リモート VPN デバイスのデバイス モデル。

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

-Name

リソースの名前。

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

-ResourceGroupName

リソース グループ名。

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

-ResourceId

VPN サイトの Azure リソース ID。

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

-Tag

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

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

-VirtualWan

この VpnSite を接続する必要がある VirtualWan。

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

-VirtualWanId

この VpnSite の ResourceId VirtualWan に接続する必要があります。

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

-VirtualWanName

この VpnSite を接続する必要がある VirtualWan の名前。

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

-VirtualWanResourceGroupName

この VpnSite を接続する必要がある VirtualWan のリソース グループ名。

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

-WhatIf

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

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

入力

PSVpnSite

String

出力

PSVpnSite