Set-AzVirtualNetworkGatewayConnection

モジュール:: Az.Network Module

仮想ネットワークゲートウェイ接続を構成します。

構文

Default (既定)

Set-AzVirtualNetworkGatewayConnection
    -VirtualNetworkGatewayConnection <PSVirtualNetworkGatewayConnection>
    [-EnableBgp <Boolean>]
    [-DpdTimeoutInSeconds <Int32>]
    [-ConnectionMode <String>]
    [-UsePolicyBasedTrafficSelectors <Boolean>]
    [-UseLocalAzureIpAddress <Boolean>]
    [-IpsecPolicies <PSIpsecPolicy[]>]
    [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>]
    [-IngressNatRule <PSResourceId[]>]
    [-EgressNatRule <PSResourceId[]>]
    [-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>]
    [-Force]
    [-AsJob]
    [-AuthenticationType <String>]
    [-CertificateAuthentication <PSCertificateAuthentication>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateResourceWithTags

Set-AzVirtualNetworkGatewayConnection
    -VirtualNetworkGatewayConnection <PSVirtualNetworkGatewayConnection>
    -Tag <Hashtable>
    [-EnableBgp <Boolean>]
    [-DpdTimeoutInSeconds <Int32>]
    [-ConnectionMode <String>]
    [-UsePolicyBasedTrafficSelectors <Boolean>]
    [-UseLocalAzureIpAddress <Boolean>]
    [-IpsecPolicies <PSIpsecPolicy[]>]
    [-TrafficSelectorPolicy <PSTrafficSelectorPolicy[]>]
    [-IngressNatRule <PSResourceId[]>]
    [-EgressNatRule <PSResourceId[]>]
    [-GatewayCustomBgpIpAddress <PSGatewayCustomBgpIpConfiguration[]>]
    [-Force]
    [-AsJob]
    [-AuthenticationType <String>]
    [-CertificateAuthentication <PSCertificateAuthentication>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Set-AzVirtualNetworkGatewayConnection コマンドレットは、仮想ネットワークゲートウェイ接続を構成します。

例

例 1:

$conn = Get-AzVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG
Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn

Confirm
Are you sure you want to overwrite resource '1'
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y


Name                    : 1
ResourceGroupName       : myRG
Location                : westus
Id                      : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi
                          crosoft.Network/connections/1
Etag                    : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid            : 00000000-0000-0000-0000-000000000000
ProvisioningState       : Succeeded
Tags                    :
AuthorizationKey        :
VirtualNetworkGateway1  : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M
                          icrosoft.Network/virtualNetworkGateways/myGateway"
VirtualNetworkGateway2  : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic
                          rosoft.Network/virtualNetworkGateways/S2SConnGW"
LocalNetworkGateway2    :
Peer                    :
RoutingWeight           : 0
SharedKey               :
ConnectionStatus        : Connected
EgressBytesTransferred  : 91334484
IngressBytesTransferred : 100386089
TunnelConnectionStatus  : []

例 2: 既存の VirtualNetworkGatewayConnection にタグを追加/更新する

$conn = Get-AzVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG
Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -Tag @{ testtagKey="SomeTagKey"; testtagValue="SomeKeyValue" }

Confirm
Are you sure you want to overwrite resource '1'
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y


Name                    : 1
ResourceGroupName       : myRG
Location                : westus
Id                      : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi
                          crosoft.Network/connections/1
Etag                    : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid            : 00000000-0000-0000-0000-000000000000
ProvisioningState       : Succeeded
Tags                    :
                          Name          Value
                          ============  ============
                          testtagValue  SomeKeyValue
                          testtagKey    SomeTagKey
AuthorizationKey        :
VirtualNetworkGateway1  : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M
                          icrosoft.Network/virtualNetworkGateways/myGateway"
VirtualNetworkGateway2  : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic
                          rosoft.Network/virtualNetworkGateways/S2SConnGW"
LocalNetworkGateway2    :
Peer                    :
RoutingWeight           : 0
SharedKey               :
ConnectionStatus        : Connected
EgressBytesTransferred  : 91334484
IngressBytesTransferred : 100386089
TunnelConnectionStatus  : []

例 3: 既存の VirtualNetworkGatewayConnection に natRules を追加または削除する

$conn = Get-AzVirtualNetworkGatewayConnection -Name 1 -ResourceGroupName myRG
$egressNatrule = Get-AzVirtualNetworkGatewayNatRule -ResourceGroupName myRG -Name "natRule1" -ParentResourceName "gw1"
Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -IngressNatRule @() -EgressNatRule $egressNatrule

Confirm
Are you sure you want to overwrite resource '1'
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y


Name                    : 1
ResourceGroupName       : myRG
Location                : westus
Id                      : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Mi
                          crosoft.Network/connections/1
Etag                    : W/"00000000-0000-0000-0000-000000000000"
ResourceGuid            : 00000000-0000-0000-0000-000000000000
ProvisioningState       : Succeeded
Tags                    :
                          Name          Value
                          ============  ============
                          testtagValue  SomeKeyValue
                          testtagKey    SomeTagKey
AuthorizationKey        :
VirtualNetworkGateway1  : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/M
                          icrosoft.Network/virtualNetworkGateways/myGateway"
VirtualNetworkGateway2  : "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/S2SVnetConn/providers/Mic
                          rosoft.Network/virtualNetworkGateways/S2SConnGW"
LocalNetworkGateway2    :
Peer                    :
RoutingWeight           : 0
SharedKey               :
ConnectionStatus        : Connected
EgressBytesTransferred  : 91334484
IngressBytesTransferred : 100386089
TunnelConnectionStatus  : []
IngressNatRules         : []
EgressNatRules          : [
                            {
                              "Id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule1"
                            }
                          ]

最初のコマンドは、リソースグループ myRG に属する 1 という名前の仮想ネットワークゲートウェイ接続を取得し、$connという名前の変数に格納します。 2 番目のコマンドは、natRule1 という名前の仮想ネットワークゲートウェイ natRule を取得し、$egressNatruleという名前の変数に格納します。 3 番目のコマンドは、すべての IngressNatRules を削除して仮想ネットワークゲートウェイ接続を設定し、EgressNatrule を EgressNatRules に追加します。

例 3: 既存の VirtualNetworkGatewayConnection に GatewayCustomBgpIpAddress を追加/削除する

$address1 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/default" -CustomBgpIpAddress "169.254.21.1"
$address2 = New-AzGatewayCustomBgpIpConfigurationObject -IpConfigurationId "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/ActiveActive" -CustomBgpIpAddress "169.254.21.3"
$conn = Get-AzVirtualNetworkGatewayConnection -ResourceGroupName PS_testing -ResourceName Conn

Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -GatewayCustomBgpIpAddress $address1,$address2

Name                        : Conn
ResourceGroupName           : PS_testing
Location                    : eastus
Id                          : /subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/connections/Conn
Etag                        : W/"e867e7bb-fa2e-436e-8822-70c556ec0f03"
ResourceGuid                : 9c33f4f7-b09c-4080-932e-a44405a8c252
ProvisioningState           : Succeeded
Tags                        :
AuthorizationKey            :
VirtualNetworkGateway1      : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw"
VirtualNetworkGateway2      :
LocalNetworkGateway2        : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/localNetworkGateways/testLng"
Peer                        :
RoutingWeight               : 3
SharedKey                   : abc
ExpressRouteGatewayBypass   : False
EnablePrivateLinkFastPath   : False
ConnectionStatus            : Unknown
EgressBytesTransferred      : 0
IngressBytesTransferred     : 0
TunnelConnectionStatus      : []
IngressNatRules             : []
EgressNatRules              : []
GatewayCustomBgpIpAddresses : [
                                {
                                  "IpconfigurationId":
                              "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/default",
                                  "CustomBgpIpAddress": "169.254.21.1"
                                },
                                {
                                  "IpconfigurationId":
                              "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw/ipConfigurations/ActiveActive",
                                  "CustomBgpIpAddress": "169.254.21.3"
                                }
                              ]

これにより、新しい AzGatewayCustomBgpIpConfigurationObjects が作成され、これらの GatewayCustomBgpIpAddress を使用してゲートウェイ接続が更新されます。

例 4: 既存の VirtualNetworkGatewayConnection への GatewayCustomBgpIpAddress の削除

$conn = Get-AzVirtualNetworkGatewayConnection -ResourceGroupName PS_testing -ResourceName Conn
Set-AzVirtualNetworkGatewayConnection -VirtualNetworkGatewayConnection $conn -GatewayCustomBgpIpAddress @()

Name                      : Conn
ResourceGroupName         : PS_testing
Location                  : eastus
Id                        : /subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/connections/Conn
Etag                      : W/"863d9b89-a030-42ba-9f71-58d5bc3336a9"
ResourceGuid              : 9c33f4f7-b09c-4080-932e-a44405a8c252
ProvisioningState         : Succeeded
Tags                      :
AuthorizationKey          :
VirtualNetworkGateway1    : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/virtualNetworkGateways/testGw"
VirtualNetworkGateway2    :
LocalNetworkGateway2      : "/subscriptions/83704d68-d560-4c67-b1c7-12404db89dc3/resourceGroups/PS_testing/providers/Microsoft.Network/localNetworkGateways/testLng"
Peer                      :
RoutingWeight             : 3
SharedKey                 : abc
ExpressRouteGatewayBypass : False
EnablePrivateLinkFastPath : False
ConnectionStatus          : NotConnected
EgressBytesTransferred    : 0
IngressBytesTransferred   : 0
TunnelConnectionStatus    : []
IngressNatRules           : []
EgressNatRules            : []
GatewayCustomBgpIpAddresses : []

これにより、ゲートウェイ接続が更新され、GatewayCustomBgpIpAddress が削除されます。

パラメーター

-AsJob

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-AuthenticationType

この VPN 接続の認証の種類: PSK または証明書

パラメーターのプロパティ

型:	String
規定値:	None
指定可能な値:	PSK, Certificate
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-CertificateAuthentication

この VPN 接続の証明書認証構成

パラメーターのプロパティ

型:	PSCertificateAuthentication
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Confirm

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	cf

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ConnectionMode

仮想ネットワークゲートウェイ接続モード。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DefaultProfile

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

パラメーターのプロパティ

型:	IAzureContextContainer
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DpdTimeoutInSeconds

接続のデッドピア検出タイムアウト (秒単位)。

パラメーターのプロパティ

型:	Nullable<T>[Int32]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-EgressNatRule

この接続に関連付けられているエグレス NAT 規則の一覧。

パラメーターのプロパティ

型:	PSResourceId[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-EnableBgp

S2S VPN トンネル経由で BGP セッションを使用するかどうか

パラメーターのプロパティ

型:	Nullable<T>[Boolean]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Force

リソースを上書きする場合は、確認を求めないでください

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-GatewayCustomBgpIpAddress

この接続で使用される仮想ネットワークゲートウェイの GatewayCustomBgpIpAddress。

パラメーターのプロパティ

型:	PSGatewayCustomBgpIpConfiguration[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-IngressNatRule

この接続に関連付けられているイングレス NAT 規則の一覧。

パラメーターのプロパティ

型:	PSResourceId[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-IpsecPolicies

IPSec ポリシーの一覧。

パラメーターのプロパティ

型:	PSIpsecPolicy[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Tag

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

パラメーターのプロパティ

型:	Hashtable
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

UpdateResourceWithTags

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-TrafficSelectorPolicy

トラフィックセレクターポリシーの一覧。

パラメーターのプロパティ

型:	PSTrafficSelectorPolicy[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-UseLocalAzureIpAddress

S2S 接続に PrivateIP を使用するかどうか

パラメーターのプロパティ

型:	Nullable<T>[Boolean]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UsePolicyBasedTrafficSelectors

S2S 接続にポリシーベースのトラフィックセレクターを使用するかどうか

パラメーターのプロパティ

型:	Nullable<T>[Boolean]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-VirtualNetworkGatewayConnection

The VirtualNetworkGatewayConnection

パラメーターのプロパティ

型:	PSVirtualNetworkGatewayConnection
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	True
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	ウィスコンシン

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。詳細については、about_CommonParametersを参照してください。

次の方法で共有

Set-AzVirtualNetworkGatewayConnection

構文

Default (既定)

UpdateResourceWithTags

説明

例

例 1:

例 2: 既存の VirtualNetworkGatewayConnection にタグを追加/更新する

例 3: 既存の VirtualNetworkGatewayConnection に natRules を追加または削除する

例 3: 既存の VirtualNetworkGatewayConnection に GatewayCustomBgpIpAddress を追加/削除する

例 4: 既存の VirtualNetworkGatewayConnection への GatewayCustomBgpIpAddress の削除

パラメーター

-AsJob

パラメーターのプロパティ

パラメーター セット

-AuthenticationType

パラメーターのプロパティ

パラメーター セット

-CertificateAuthentication

パラメーターのプロパティ

パラメーター セット

-Confirm

パラメーターのプロパティ

パラメーター セット

-ConnectionMode

パラメーターのプロパティ

パラメーター セット

-DefaultProfile

パラメーターのプロパティ

パラメーター セット

-DpdTimeoutInSeconds

パラメーターのプロパティ

パラメーター セット

-EgressNatRule

パラメーターのプロパティ

パラメーター セット

-EnableBgp

パラメーターのプロパティ

パラメーター セット

-Force

パラメーターのプロパティ

パラメーター セット

-GatewayCustomBgpIpAddress

パラメーターのプロパティ

パラメーター セット

-IngressNatRule

パラメーターのプロパティ

パラメーター セット

-IpsecPolicies

パラメーターのプロパティ

パラメーター セット

-Tag

パラメーターのプロパティ

パラメーター セット

-TrafficSelectorPolicy

パラメーターのプロパティ

パラメーター セット

-UseLocalAzureIpAddress

パラメーターのプロパティ

パラメーター セット

-UsePolicyBasedTrafficSelectors

パラメーターのプロパティ

パラメーター セット

-VirtualNetworkGatewayConnection

パラメーターのプロパティ

パラメーター セット

-WhatIf

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

PSVirtualNetworkGatewayConnection

Nullable<T>

Nullable<T>

PSIpsecPolicy

PSTrafficSelectorPolicy

PSGatewayCustomBgpIpConfiguration

出力

PSVirtualNetworkGatewayConnection

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット