pulumi-azure-native-kotlin/com.pulumi.azurenative.network.kotlin/NatRuleArgs

NatRuleArgs

data class NatRuleArgs(val externalMappings: Output<List<VpnNatRuleMappingArgs>>? = null, val gatewayName: Output<String>? = null, val id: Output<String>? = null, val internalMappings: Output<List<VpnNatRuleMappingArgs>>? = null, val ipConfigurationId: Output<String>? = null, val mode: Output<Either<String, VpnNatRuleMode>>? = null, val name: Output<String>? = null, val natRuleName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val type: Output<Either<String, VpnNatRuleType>>? = null) : ConvertibleToJava<NatRuleArgs>

VpnGatewayNatRule Resource. Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01. Other available API versions: 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

NatRulePut

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var natRule = new AzureNative.Network.NatRule("natRule", new()
    {
        ExternalMappings = new[]
        {
            new AzureNative.Network.Inputs.VpnNatRuleMappingArgs
            {
                AddressSpace = "192.168.21.0/24",
            },
        },
        GatewayName = "gateway1",
        InternalMappings = new[]
        {
            new AzureNative.Network.Inputs.VpnNatRuleMappingArgs
            {
                AddressSpace = "10.4.0.0/24",
            },
        },
        IpConfigurationId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default",
        Mode = AzureNative.Network.VpnNatRuleMode.EgressSnat,
        NatRuleName = "natRule1",
        ResourceGroupName = "rg1",
        Type = AzureNative.Network.VpnNatRuleType.Static,
    });
});

package main
import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewNatRule(ctx, "natRule", &network.NatRuleArgs{
			ExternalMappings: network.VpnNatRuleMappingArray{
				&network.VpnNatRuleMappingArgs{
					AddressSpace: pulumi.String("192.168.21.0/24"),
				},
			},
			GatewayName: pulumi.String("gateway1"),
			InternalMappings: network.VpnNatRuleMappingArray{
				&network.VpnNatRuleMappingArgs{
					AddressSpace: pulumi.String("10.4.0.0/24"),
				},
			},
			IpConfigurationId: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default"),
			Mode:              pulumi.String(network.VpnNatRuleModeEgressSnat),
			NatRuleName:       pulumi.String("natRule1"),
			ResourceGroupName: pulumi.String("rg1"),
			Type:              pulumi.String(network.VpnNatRuleTypeStatic),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.network.NatRule;
import com.pulumi.azurenative.network.NatRuleArgs;
import com.pulumi.azurenative.network.inputs.VpnNatRuleMappingArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var natRule = new NatRule("natRule", NatRuleArgs.builder()
            .externalMappings(VpnNatRuleMappingArgs.builder()
                .addressSpace("192.168.21.0/24")
                .build())
            .gatewayName("gateway1")
            .internalMappings(VpnNatRuleMappingArgs.builder()
                .addressSpace("10.4.0.0/24")
                .build())
            .ipConfigurationId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default")
            .mode("EgressSnat")
            .natRuleName("natRule1")
            .resourceGroupName("rg1")
            .type("Static")
            .build());
    }
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:NatRule natRule1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}

Constructors

NatRuleArgs

constructor(externalMappings: Output<List<VpnNatRuleMappingArgs>>? = null, gatewayName: Output<String>? = null, id: Output<String>? = null, internalMappings: Output<List<VpnNatRuleMappingArgs>>? = null, ipConfigurationId: Output<String>? = null, mode: Output<Either<String, VpnNatRuleMode>>? = null, name: Output<String>? = null, natRuleName: Output<String>? = null, resourceGroupName: Output<String>? = null, type: Output<Either<String, VpnNatRuleType>>? = null)