Remove-AzExpressRouteGateway

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

Remove-AzExpressRouteGateway コマンドレットは、Azure ExpressRoute ゲートウェイを削除します。 これは、Azure Virtual WAN のソフトウェア定義接続に固有のゲートウェイです。

構文

Remove-AzExpressRouteGateway
      -ResourceGroupName <String>
      -Name <String>
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzExpressRouteGateway
      -InputObject <PSExpressRouteGateway>
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzExpressRouteGateway
      -ResourceId <String>
      [-PassThru]
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzExpressRouteGateway コマンドレットは、Azure ExpressRoute ゲートウェイを削除します。 これは、Azure Virtual WAN のソフトウェア定義接続に固有のゲートウェイです。

例

例 1

New-AzResourceGroup -Location "West Central US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US"
$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2
Remove-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -Passthru

この例では、リソース グループ、Virtual WAN、Virtual Hub、スケーラブルな ExpressRoute ゲートウェイを米国中部に作成し、直ちに削除します。 仮想ゲートウェイを削除するときにプロンプトを表示しない場合は、-Force フラグを使用します。 これにより、ExpressRouteGateway と、それにアタッチされているすべての ExpressRouteConnection が削除されます。

例 2

New-AzResourceGroup -Location "West Central US" -Name "testRG"
$virtualWan = New-AzVirtualWan -ResourceGroupName testRG -Name myVirtualWAN -Location "West Central US"
$virtualHub = New-AzVirtualHub -VirtualWan $virtualWan -ResourceGroupName "testRG" -Name "westushub" -AddressPrefix "10.0.0.1/24"
New-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" -VirtualHubId $virtualHub.Id -MinScaleUnits 2
Get-AzExpressRouteGateway -ResourceGroupName "testRG" -Name "testExpressRoutegw" | Remove-AzExpressRouteGateway -Passthru

この例では、リソース グループ Virtual WAN、Virtual Hub、スケーラブルな ExpressRoute ゲートウェイを米国中西部に作成し、直ちに削除します。 この削除は、PowerShell パイプを使用して行われます。このパイプでは、Get-AzExpressRouteGateway コマンドによって返される ExpressRouteGateway オブジェクトが使用されます。 仮想ゲートウェイを削除するときにプロンプトを表示しない場合は、-Force フラグを使用します。 これにより、ExpressRouteGateway と、それにアタッチされているすべての ExpressRouteConnection が削除されます。

パラメーター

-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:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

確認を求めないでください。

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

-InputObject

削除する ExpressRouteGateway オブジェクト。

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

-Name

ExpressRouteGateway 名。

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

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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

削除する ExpressRouteGateway の Azure リソース ID。

Type:String
Aliases:expressRouteGatewayId
Position:Named
Default value:None
Required:True
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

入力

PSExpressRouteGateway

String

出力

Boolean