Reset-AzVirtualNetworkGateway

Reference

Module:: Az.Network

Resets the Virtual Network Gateway

Note

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

Syntax

Reset-AzVirtualNetworkGateway
     -VirtualNetworkGateway <PSVirtualNetworkGateway>
     [-GatewayVip <String>]
     [-AsJob]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Description

Resets the Virtual Network Gateway

Examples

Example 1:

$Gateway = Get-AzVirtualNetworkGateway -Name "ContosoVirtualGateway"
Reset-AzVirtualNetworkGateway -VirtualNetworkGateway $Gateway

Parameters

-AsJob

Run cmdlet in the background

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-GatewayVip

The gateway vip in order to reset particular gateway instance (e.g. in case of Active-Active feature enabled gateways.) By default, gateway primary instance will be reset if no value is passed.

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

-VirtualNetworkGateway

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

Inputs

PSVirtualNetworkGateway

String

Outputs