Reset-AzVirtualNetworkGatewayConnection
Reset a Virtual Network Gateway Connection
Syntax
Reset-AzVirtualNetworkGatewayConnection
-Name <String>
-ResourceGroupName <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Reset-AzVirtualNetworkGatewayConnection
-InputObject <PSVirtualNetworkGatewayConnection>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Reset-AzVirtualNetworkGatewayConnection
-ResourceId <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Reset-AzVirtualNetworkGatewayConnection cmdlet resets your virtual network gateway connection based on the Connection Name and Resource Group Name.
Examples
Example 1
Reset-AzVirtualNetworkGatewayConnection -ResourceGroupName myRG -Name myTunnel
Resets the Virtual Network Gateway Connection with the name "myTunnel" within the resource group "myRG"
Parameters
-AsJob
Run cmdlet in the background.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
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 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
The virtual network gateway connection object which has to be reset.
Type: | PSVirtualNetworkGatewayConnection |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The virtual network gateway connection name which has to be reset.
Type: | String |
Aliases: | ResourceName, ConnectionName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
The Azure resource ID of the Virtual Network Gateway Connection which has to be reset.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Azure PowerShell