Remove-AzVirtualNetworkGatewayNatRule

Module:

Az.Network Module

Removes or Delete a Virtual Network Gateway NatRule.

Syntax

ByVirtualNetworkGatewayNatRuleName (Default)

Remove-AzVirtualNetworkGatewayNatRule
    -ResourceGroupName <String>
    -ParentResourceName <String>
    -Name <String>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVirtualNetworkGatewayNatRuleResourceId

Remove-AzVirtualNetworkGatewayNatRule
    -ResourceId <String>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByVirtualNetworkGatewayNatRuleObject

Remove-AzVirtualNetworkGatewayNatRule
    -InputObject <PSVirtualNetworkGatewayNatRule>
    [-Force]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Remove-AzVirtualNetworkGatewayNatRule cmdlet removes a virtual network gateway nat rule from your virtual network gateway.

Examples

Example 1

Remove-AzVirtualNetworkGatewayNatRule -ResourceGroupName rg1 -ParentResourceName gw1 -Name natRule3

Confirm
Are you sure you want to remove resource 'natRule3'
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): Y

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Force

Do not ask for confirmation if you want to delete a resource

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The VirtualNetworkGatewayNatRule object to update.

Parameter properties

Type:	PSVirtualNetworkGatewayNatRule
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	VirtualNetworkGatewayNatRule

Parameter sets

ByVirtualNetworkGatewayNatRuleObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The resource name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ResourceName, VirtualNetworkGatewayNatRuleName

Parameter sets

ByVirtualNetworkGatewayNatRuleName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ParentResourceName

The parent resource name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	ParentVirtualNetworkGatewayName, VirtualNetworkGatewayName

Parameter sets

ByVirtualNetworkGatewayNatRuleName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PassThru

Returns an object representing the item on which this operation is being performed.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The resource group name.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByVirtualNetworkGatewayNatRuleName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

The resource id of the VirtualNetworkGatewayNatRule object to delete.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	VirtualNetworkGatewayNatRuleId

Parameter sets

ByVirtualNetworkGatewayNatRuleResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSVirtualNetworkGatewayNatRule

Outputs

Boolean