Remove-AzVpnGateway

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

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

構文

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

説明

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

例

例 1

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

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

例 2

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

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

パラメーター

-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

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

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

-Name

vpnGateway 名。

Type:String
Aliases:ResourceName, VpnGatewayName
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

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

Type:String
Aliases:vpnGatewayId
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

入力

PSVpnGateway

String

出力

Boolean