Disconnect-AzVirtualNetworkGatewayVpnConnection

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.Network

Disconnect given connected vpn client connections with a given virtual network gateway.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Disconnect-AzVirtualNetworkGatewayVpnConnection
          -ResourceName <String>
          -ResourceGroupName <String>
          -InputObject <PSVirtualNetworkGateway>
          -ResourceId <ResourceId>
          -VpnConnectionId <VpnConnectionIds>
          [-AsJob]
          [<CommonParameters>]

Disconnect-AzVirtualNetworkGatewayVpnConnection
          -InputObject <PSP2SVpnGateway>
          -VpnConnectionId <VpnConnectionId>
          [<CommonParameters>]

Disconnect-AzVirtualNetworkGatewayVpnConnection
          -ResourceId <String>
          -VpnConnectionId <VpnConnectionId>
          [<CommonParameters>]

Description

The Disconnect-AzVirtualNetworkGatewayVpnConnection cmdlet enables you to disconnect given connected vpn client connection.

Examples

Example 1

PS C:\> Disconnect-AzVirtualNetworkGatewayVpnConnection -ResourceName vnet-gw -ResourceGroupName vnetgwrg -VpnConnectionId @("IKEv2_7e1cfe59-5c7c-4315-a876-b11fbfdfeed4")

Parameters

-AsJob

Run cmdlet in the background

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

-InputObject

Virtual network gateway object

Type:	PSVirtualNetworkGateway
Aliases:	VirtualNetworkGateway
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Virtual network gateway resource group's name

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

-ResourceId

Virtual network gateway resource Id

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

-ResourceName

Virtual network gateway name

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

-VpnConnectionId

Vpn Connection Ids

Type:	String[]
Aliases:	VpnConnectionId
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSVirtualNetworkGateway