Remove-AzVirtualHubBgpConnection

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

Remove-AzVirtualHubBgpConnection コマンドレットは、Virtual WAN ハブに接続されている仮想ネットワーク内の BGP 対応ピアと Azure Virtual WAN ハブ ルーターをピアリングする HubBgpConnection リソースを削除します。

構文

Remove-AzVirtualHubBgpConnection
      -ResourceGroupName <String>
      -VirtualHubName <String>
      -Name <String>
      [-AsJob]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzVirtualHubBgpConnection
      -Name <String>
      -VirtualHub <PSVirtualHub>
      [-AsJob]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzVirtualHubBgpConnection
      -InputObject <PSBgpConnection>
      [-AsJob]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzVirtualHubBgpConnection
      -ResourceId <String>
      [-AsJob]
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzVirtualHubBgpConnection コマンドレットは、仮想 WAN ハブに接続された仮想ネットワーク内の BGP 対応ピアと Azure Virtual WAN ハブ ルーターをピアリングする HubBgpConnection リソースを削除します。

例

例 1

Remove-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testBgpConnection"

上記では、リソース グループ名、Virtual WAN ハブ名、接続名を使用して、Virtual WAN ハブ BGP 接続が削除されます。

例 2

Get-AzVirtualHubBgpConnection -ResourceGroupName "testRG" -VirtualHubName "testHub" -Name "testBgpConnection" | Remove-AzVirtualHubBgpConnection

上記では、Get-AzVirtualHubBgpConnection からの出力で PowerShell パイプを使用して Virtual WAN Hub BGP 接続を削除します。

例 3

$bgpConnectionId = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{bgpConnectionName}"
Remove-AzVirtualHubBgpConnection -ResourceId $bgpConnectionId

上記では、BGP 接続リソース ID を使用して Virtual WAN ハブ BGP 接続が削除されます。

パラメーター

-AsJob

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

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

仮想ハブ BGP 接続リソース。

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

-Name

リソースの名前。

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

リソース ID。

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

-VirtualHub

仮想ハブ リソース。

Type:PSVirtualHub
Aliases:ParentObject, ParentVirtualHub
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VirtualHubName

仮想ハブ名。

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

-WhatIf

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

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

入力

PSVirtualHub

PSBgpConnection

String

出力

Boolean