Update-AzVirtualNetworkGatewayNatRule

Updates a Virtual Network Gateway NatRule.

Note

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

Syntax

Update-AzVirtualNetworkGatewayNatRule
      -ResourceGroupName <String>
      -ParentResourceName <String>
      -Name <String>
      [-InternalMapping <String[]>]
      [-ExternalMapping <String[]>]
      [-IpConfigurationId <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Update-AzVirtualNetworkGatewayNatRule
      -ResourceId <String>
      [-InternalMapping <String[]>]
      [-ExternalMapping <String[]>]
      [-IpConfigurationId <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Update-AzVirtualNetworkGatewayNatRule
      -InputObject <PSVirtualNetworkGatewayNatRule>
      [-InternalMapping <String[]>]
      [-ExternalMapping <String[]>]
      [-IpConfigurationId <String>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

Update-AzVirtualNetworkGatewayNatRule cmdlet sets or updates a virtual network gateway nat rule.

Examples

Example 1:

$natRule1 = get-azVirtualNetworkGatewayNatRule -ResourceGroupName "rg1" -Name "natRule1" -ParentResourceName "gw1"
 Update-AzVirtualNetworkGatewayNatRule -InputObject $natRule1 -ExternalMapping @("30.0.0.0/16") -InternalMapping @("25.0.0.0/16") -IpConfigurationId "/subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/ipConfigurations/default"
Name              : natRule1
ProvisioningState : Succeeded
Type              : Static
Mode              : IngressSnat
InternalMappings  : [
                      {
                        "AddressSpace": "25.0.0.0/16"
                      }
                    ]
ExternalMappings  : [
                      {
                        "AddressSpace": "30.0.0.0/16"
                      }
                    ]
IpConfigurationId : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/ipConfigurations/default
Id                : /subscriptions/7afd8f92-c220-4f53-886e-1df53a69afd4/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gw1/natRules/natRule1
Etag              : W/"5150d788-e165-42ba-99c4-8138a545fce9"

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
-ExternalMapping

The list of private IP address subnet external mappings for NAT

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

The VirtualNetworkGatewayNatRule object to update.

Type:PSVirtualNetworkGatewayNatRule
Aliases:VirtualNetworkGatewayNatRule
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-InternalMapping

The list of private IP address subnet internal mappings for NAT

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IpConfigurationId

The IP Configuration ID this NAT rule applies to

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

The resource name.

Type:String
Aliases:ResourceName, VirtualNetworkGatewayNatRuleName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ParentResourceName

The parent resource name.

Type:String
Aliases:ParentVirtualNetworkGatewayName, VirtualNetworkGatewayName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

The resource group name.

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

The resource id of the VirtualNetworkGatewayNatRule object to update.

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

Inputs

String

PSVirtualNetworkGatewayNatRule

Outputs

PSVirtualNetworkGatewayNatRule