Remove-AzureRmLocalNetworkGateway

NAME Remove-AzureRmLocalNetworkGateway



SYNOPSIS

Deletes a Local Network Gateway





SYNTAX

Remove-AzureRmLocalNetworkGateway [-AsJob] [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> [-PassThru] -ResourceGroupName

<String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Local Network Gateway is the object representing your VPN device On-Premises.



The Remove-AzureRmLocalNetworkGateway cmdlet deletes the object representing your on-prem gateway based on Name and Resource Group Name.





PARAMETERS

-AsJob [<SwitchParameter>]

Run cmdlet in the background



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the local network gateway that this cmdlet removes.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group that contains the local network gateway.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS



NOTES









1: Delete a Local Network Gateway



Remove-AzureRmLocalNetworkGateway -Name myLocalGW -ResourceGroupName myRG



Deletes the object of the Local Network Gateway with the name "myLocalGW" within the resource group "myRG"



Note: You must first delete all connections to the Local Network Gateway using the Remove-AzureRmVirtualNetworkGatewayConnection cmdlet.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... orkgateway

Get-AzureRmLocalNetworkGateway

New-AzureRmLocalNetworkGateway

Set-AzureRmLocalNetworkGateway