NatGatewayArgs

data class NatGatewayArgs(val id: Output<String>? = null, val idleTimeoutInMinutes: Output<Int>? = null, val location: Output<String>? = null, val natGatewayName: Output<String>? = null, val publicIpAddresses: Output<List<SubResourceArgs>>? = null, val publicIpPrefixes: Output<List<SubResourceArgs>>? = null, val resourceGroupName: Output<String>? = null, val sku: Output<NatGatewaySkuArgs>? = null, val tags: Output<Map<String, String>>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<NatGatewayArgs>

Nat Gateway 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: 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 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. 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

Create nat gateway

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var natGateway = new AzureNative.Network.NatGateway("natGateway", new()
{
Location = "westus",
NatGatewayName = "test-natgateway",
PublicIpAddresses = new[]
{
new AzureNative.Network.Inputs.SubResourceArgs
{
Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1",
},
},
PublicIpPrefixes = new[]
{
new AzureNative.Network.Inputs.SubResourceArgs
{
Id = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1",
},
},
ResourceGroupName = "rg1",
Sku = new AzureNative.Network.Inputs.NatGatewaySkuArgs
{
Name = AzureNative.Network.NatGatewaySkuName.Standard,
},
});
});
package main
import (
network "github.com/pulumi/pulumi-azure-native-sdk/network/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := network.NewNatGateway(ctx, "natGateway", &network.NatGatewayArgs{
Location: pulumi.String("westus"),
NatGatewayName: pulumi.String("test-natgateway"),
PublicIpAddresses: network.SubResourceArray{
&network.SubResourceArgs{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1"),
},
},
PublicIpPrefixes: network.SubResourceArray{
&network.SubResourceArgs{
Id: pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1"),
},
},
ResourceGroupName: pulumi.String("rg1"),
Sku: &network.NatGatewaySkuArgs{
Name: pulumi.String(network.NatGatewaySkuNameStandard),
},
})
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.NatGateway;
import com.pulumi.azurenative.network.NatGatewayArgs;
import com.pulumi.azurenative.network.inputs.SubResourceArgs;
import com.pulumi.azurenative.network.inputs.NatGatewaySkuArgs;
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 natGateway = new NatGateway("natGateway", NatGatewayArgs.builder()
.location("westus")
.natGatewayName("test-natgateway")
.publicIpAddresses(SubResourceArgs.builder()
.id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1")
.build())
.publicIpPrefixes(SubResourceArgs.builder()
.id("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1")
.build())
.resourceGroupName("rg1")
.sku(NatGatewaySkuArgs.builder()
.name("Standard")
.build())
.build());
}
}

Import

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

$ pulumi import azure-native:network:NatGateway test-natGateway /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}

Constructors

Link copied to clipboard
constructor(id: Output<String>? = null, idleTimeoutInMinutes: Output<Int>? = null, location: Output<String>? = null, natGatewayName: Output<String>? = null, publicIpAddresses: Output<List<SubResourceArgs>>? = null, publicIpPrefixes: Output<List<SubResourceArgs>>? = null, resourceGroupName: Output<String>? = null, sku: Output<NatGatewaySkuArgs>? = null, tags: Output<Map<String, String>>? = null, zones: Output<List<String>>? = null)

Properties

Link copied to clipboard
val id: Output<String>? = null

Resource ID.

Link copied to clipboard
val idleTimeoutInMinutes: Output<Int>? = null

The idle timeout of the nat gateway.

Link copied to clipboard
val location: Output<String>? = null

Resource location.

Link copied to clipboard
val natGatewayName: Output<String>? = null

The name of the nat gateway.

Link copied to clipboard
val publicIpAddresses: Output<List<SubResourceArgs>>? = null

An array of public ip addresses associated with the nat gateway resource.

Link copied to clipboard
val publicIpPrefixes: Output<List<SubResourceArgs>>? = null

An array of public ip prefixes associated with the nat gateway resource.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group.

Link copied to clipboard
val sku: Output<NatGatewaySkuArgs>? = null

The nat gateway SKU.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Link copied to clipboard
val zones: Output<List<String>>? = null

A list of availability zones denoting the zone in which Nat Gateway should be deployed.

Functions

Link copied to clipboard
open override fun toJava(): NatGatewayArgs