Stop-AzVirtualNetworkGatewaySiteFailoverTest
指定したピアリングの場所の仮想ネットワーク ゲートウェイでのフェールオーバー シミュレーションを停止します。
構文
Default (既定)
Stop-AzVirtualNetworkGatewaySiteFailoverTest
-ResourceGroupName <String>
-VirtualNetworkGatewayName <String>
-PeeringLocation <String>
-WasSimulationSuccessful <Boolean>
-Detail <System.Collections.Generic.List`1[Microsoft.Azure.Management.Network.Models.FailoverConnectionDetails]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Stop-AzVirtualNetworkGatewaySiteFailoverTest コマンドレットは、仮想ネットワーク ゲートウェイに対して以前に開始されたフェールオーバー シミュレーションを停止するために使用されます。 テストは、テストが実行された PeeringLocation によって識別されます。
テストを停止するときは、 -WasSimulationSuccessful パラメーターを使用してシミュレーションが成功したかどうかを指定する必要があります。また、 -Detail パラメーターを使用してフェールオーバー シミュレーションに関する詳細情報も指定する必要があります。
このコマンドレットを使用すると、フェールオーバー テストを終了し、テストが成功したかどうかなど、シミュレーション結果に関する重要な情報をキャプチャできます。
例
例 1
$detail = @(
[Microsoft.Azure.Management.Network.Models.FailoverConnectionDetails]@{
FailoverConnectionName = "test_failover_gateway_connection"
FailoverLocation = "eastus2"
IsVerified = $true
}
)
Stop-AzVirtualNetworkGatewaySiteFailoverTest -ResourceGroupName "test_failover_rg" -VirtualNetworkGatewayName "test_failoverGw" -PeeringLocation "WestEurope" -Detail $detail -WasSimulationSuccessful $true
この例では、仮想ネットワーク ゲートウェイのフェールオーバー シミュレーションを停止する方法を示します。 コマンドレット Stop-AzVirtualNetworkGatewaySiteFailoverTest は、次のパラメーターと共に使用されます。
ResourceGroupName: 仮想ネットワーク ゲートウェイを含むリソース グループ ("test_failover_rg") を指定します。
VirtualNetworkGatewayName: フェールオーバー テストを停止する仮想ネットワーク ゲートウェイ ("test_failoverGw") を指定します。
PeeringLocation: フェールオーバー テストが停止されているピアリングの場所 ("WestEurope") を指定します。
詳細: 名前、場所、検証の状態など、フェールオーバー接続の詳細が表示されます。
WasSimulationSuccessful: フェールオーバー シミュレーションが成功したことを示します ($true)。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Detail
フェールオーバー シミュレーションの詳細。
パラメーターのプロパティ
| 型: | |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PeeringLocation
停止するフェールオーバー テストのピアリングの場所。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
仮想ネットワーク ゲートウェイのリソース グループ名。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-VirtualNetworkGatewayName
仮想ネットワーク ゲートウェイの名前。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WasSimulationSuccessful
シミュレーションが成功したかどうか。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | 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を参照してください。
