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

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

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

-Asn

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

Type:	UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
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

-DisableActiveActiveFeature

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

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

-EnableActiveActiveFeature

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

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

-GatewayDefaultSite

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

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

-GatewaySku

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

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

Type:	String
Accepted values:	Basic, Standard, HighPerformance, UltraPerformance, VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ, ErGw1AZ, ErGw2AZ, ErGw3AZ
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PeerWeight

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

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

-RadiusServerAddress

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

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

-RadiusServerSecret

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

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

-VirtualNetworkGateway

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

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

-VpnClientAddressPool

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

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

-VpnClientIpsecPolicy

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

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

-VpnClientProtocol

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

Type:	List<T>[String]
Accepted values:	SSTP, IkeV2, OpenVPN
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VpnClientRevokedCertificates

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

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

-VpnClientRootCertificates

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

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

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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

出力