Reset-AzVpnSiteLinkConnection
Reset a VPN Site Link Connection
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Reset-AzVpnSiteLinkConnection
-ResourceGroupName <String>
-VpnGatewayName <String>
-VpnConnectionName <String>
-Name <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Reset-AzVpnSiteLinkConnection
-InputObject <PSVpnSiteLinkConnection>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Reset-AzVpnSiteLinkConnection
-ResourceId <String>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Reset-AzVpnSiteLinkConnection cmdlet resets your VPN Link Connection based on the VPN Site Link Connection Name, VPN Connection Name, VPN Gateway Name and Resource Group Name.
Examples
Example 1
PS C:\> Reset-AzVpnSiteLinkConnection -ResourceGroupName test-rg -VpnGatewayName test-gateway -VpnConnectionName test-connection -ResourceName test-linkConnection
Resets the VPN Site Link Connection with the name "test-linkConnection" within the resource group "test-rg"
Parameters
Run cmdlet in the background.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
The Vpn site link connection object.
| Type: | PSVpnSiteLinkConnection |
| Aliases: | VpnSiteLinkConnection |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The Vpn site link connection name.
| Type: | String |
| Aliases: | ResourceName, VpnSiteLinkConnectionName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The Azure resource ID of the Vpn site link connection which has to be reset.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The Vpn connection name.
| Type: | String |
| Aliases: | ParentName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The Vpn gateway name.
| Type: | String |
| Aliases: | GrandParentName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |