Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.5.0 published on Wednesday, May 4, 2022 by Pulumi

getNatGateway

Use this data source to access information about an existing NAT Gateway.

Using getNatGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getNatGateway(args: GetNatGatewayArgs, opts?: InvokeOptions): Promise<GetNatGatewayResult>
function getNatGatewayOutput(args: GetNatGatewayOutputArgs, opts?: InvokeOptions): Output<GetNatGatewayResult>
def get_nat_gateway(name: Optional[str] = None,
                    public_ip_address_ids: Optional[Sequence[str]] = None,
                    public_ip_prefix_ids: Optional[Sequence[str]] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNatGatewayResult
def get_nat_gateway_output(name: Optional[pulumi.Input[str]] = None,
                    public_ip_address_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    public_ip_prefix_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNatGatewayResult]
func LookupNatGateway(ctx *Context, args *LookupNatGatewayArgs, opts ...InvokeOption) (*LookupNatGatewayResult, error)
func LookupNatGatewayOutput(ctx *Context, args *LookupNatGatewayOutputArgs, opts ...InvokeOption) LookupNatGatewayResultOutput

> Note: This function is named LookupNatGateway in the Go SDK.

public static class GetNatGateway 
{
    public static Task<GetNatGatewayResult> InvokeAsync(GetNatGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetNatGatewayResult> Invoke(GetNatGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNatGatewayResult> getNatGateway(GetNatGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure:network/getNatGateway:getNatGateway
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

Specifies the Name of the NAT Gateway.

ResourceGroupName string

Specifies the name of the Resource Group where the NAT Gateway exists.

PublicIpAddressIds List<string>

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

PublicIpPrefixIds List<string>

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

Name string

Specifies the Name of the NAT Gateway.

ResourceGroupName string

Specifies the name of the Resource Group where the NAT Gateway exists.

PublicIpAddressIds []string

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

PublicIpPrefixIds []string

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

name String

Specifies the Name of the NAT Gateway.

resourceGroupName String

Specifies the name of the Resource Group where the NAT Gateway exists.

publicIpAddressIds List

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

publicIpPrefixIds List

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

name string

Specifies the Name of the NAT Gateway.

resourceGroupName string

Specifies the name of the Resource Group where the NAT Gateway exists.

publicIpAddressIds string[]

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

publicIpPrefixIds string[]

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

name str

Specifies the Name of the NAT Gateway.

resource_group_name str

Specifies the name of the Resource Group where the NAT Gateway exists.

public_ip_address_ids Sequence[str]

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

public_ip_prefix_ids Sequence[str]

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

name String

Specifies the Name of the NAT Gateway.

resourceGroupName String

Specifies the name of the Resource Group where the NAT Gateway exists.

publicIpAddressIds List

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

publicIpPrefixIds List

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

getNatGateway Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

IdleTimeoutInMinutes int

The idle timeout in minutes which is used for the NAT Gateway.

Location string

The location where the NAT Gateway exists.

Name string
PublicIpAddressIds List<string>

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

PublicIpPrefixIds List<string>

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

ResourceGroupName string
ResourceGuid string

The Resource GUID of the NAT Gateway.

SkuName string

The SKU used by the NAT Gateway.

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

Zones List<string>

A list of Availability Zones which the NAT Gateway exists in.

Id string

The provider-assigned unique ID for this managed resource.

IdleTimeoutInMinutes int

The idle timeout in minutes which is used for the NAT Gateway.

Location string

The location where the NAT Gateway exists.

Name string
PublicIpAddressIds []string

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

PublicIpPrefixIds []string

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

ResourceGroupName string
ResourceGuid string

The Resource GUID of the NAT Gateway.

SkuName string

The SKU used by the NAT Gateway.

Tags map[string]string

A mapping of tags assigned to the resource.

Zones []string

A list of Availability Zones which the NAT Gateway exists in.

id String

The provider-assigned unique ID for this managed resource.

idleTimeoutInMinutes Integer

The idle timeout in minutes which is used for the NAT Gateway.

location String

The location where the NAT Gateway exists.

name String
publicIpAddressIds List

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

publicIpPrefixIds List

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

resourceGroupName String
resourceGuid String

The Resource GUID of the NAT Gateway.

skuName String

The SKU used by the NAT Gateway.

tags Map

A mapping of tags assigned to the resource.

zones List

A list of Availability Zones which the NAT Gateway exists in.

id string

The provider-assigned unique ID for this managed resource.

idleTimeoutInMinutes number

The idle timeout in minutes which is used for the NAT Gateway.

location string

The location where the NAT Gateway exists.

name string
publicIpAddressIds string[]

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

publicIpPrefixIds string[]

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

resourceGroupName string
resourceGuid string

The Resource GUID of the NAT Gateway.

skuName string

The SKU used by the NAT Gateway.

tags {[key: string]: string}

A mapping of tags assigned to the resource.

zones string[]

A list of Availability Zones which the NAT Gateway exists in.

id str

The provider-assigned unique ID for this managed resource.

idle_timeout_in_minutes int

The idle timeout in minutes which is used for the NAT Gateway.

location str

The location where the NAT Gateway exists.

name str
public_ip_address_ids Sequence[str]

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

public_ip_prefix_ids Sequence[str]

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

resource_group_name str
resource_guid str

The Resource GUID of the NAT Gateway.

sku_name str

The SKU used by the NAT Gateway.

tags Mapping[str, str]

A mapping of tags assigned to the resource.

zones Sequence[str]

A list of Availability Zones which the NAT Gateway exists in.

id String

The provider-assigned unique ID for this managed resource.

idleTimeoutInMinutes Number

The idle timeout in minutes which is used for the NAT Gateway.

location String

The location where the NAT Gateway exists.

name String
publicIpAddressIds List

A list of existing Public IP Address resource IDs which the NAT Gateway is using.

publicIpPrefixIds List

A list of existing Public IP Prefix resource IDs which the NAT Gateway is using.

resourceGroupName String
resourceGuid String

The Resource GUID of the NAT Gateway.

skuName String

The SKU used by the NAT Gateway.

tags Map

A mapping of tags assigned to the resource.

zones List

A list of Availability Zones which the NAT Gateway exists in.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.