Class NatGateway

Manages a Azure NAT Gateway.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
    {
        Location = "eastus2",
    });
    var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new Azure.Network.PublicIpArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        AllocationMethod = "Static",
        Sku = "Standard",
        Zones = 
        {
            "1",
        },
    });
    var examplePublicIpPrefix = new Azure.Network.PublicIpPrefix("examplePublicIpPrefix", new Azure.Network.PublicIpPrefixArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PrefixLength = 30,
        Zones = 
        {
            "1",
        },
    });
    var exampleNatGateway = new Azure.Network.NatGateway("exampleNatGateway", new Azure.Network.NatGatewayArgs
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        PublicIpAddressIds = 
        {
            examplePublicIp.Id,
        },
        PublicIpPrefixIds = 
        {
            examplePublicIpPrefix.Id,
        },
        SkuName = "Standard",
        IdleTimeoutInMinutes = 10,
        Zones = 
        {
            "1",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

NatGateway

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.Network

Assembly: Pulumi.Azure.dll

Syntax

public class NatGateway : CustomResource

Constructors

NatGateway(String, NatGatewayArgs, CustomResourceOptions)

Create a NatGateway resource with the given unique name, arguments, and options.

Declaration

public NatGateway(string name, NatGatewayArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NatGatewayArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

IdleTimeoutInMinutes

The idle timeout which should be used in minutes. Defaults to 4.

Declaration

public Output<int?> IdleTimeoutInMinutes { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Location

Specifies the supported Azure location where the NAT Gateway should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

Specifies the name of the NAT Gateway. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

PublicIpAddressIds

A list of Public IP Address ID's which should be associated with the NAT Gateway resource.

Declaration

public Output<ImmutableArray<string>> PublicIpAddressIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

PublicIpPrefixIds

A list of Public IP Prefix ID's which should be associated with the NAT Gateway resource.

Declaration

public Output<ImmutableArray<string>> PublicIpPrefixIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ResourceGroupName

Specifies the name of the Resource Group in which the NAT Gateway should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

ResourceGuid

The resource GUID property of the NAT Gateway.

Declaration

public Output<string> ResourceGuid { get; }

Property Value

Type	Description
Output<System.String>

SkuName

The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard.

Declaration

public Output<string> SkuName { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Zones

A list of availability zones where the NAT Gateway should be provisioned. Changing this forces a new resource to be created.

Declaration

public Output<ImmutableArray<string>> Zones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

Get(String, Input<String>, NatGatewayState, CustomResourceOptions)

Get an existing NatGateway resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static NatGateway Get(string name, Input<string> id, NatGatewayState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
NatGatewayState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NatGateway