1. Packages
  2. Azure Classic
  3. API Docs
  4. network
  5. getNatGateway

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.network.getNatGateway

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

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>
Copy
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]
Copy
func LookupNatGateway(ctx *Context, args *LookupNatGatewayArgs, opts ...InvokeOption) (*LookupNatGatewayResult, error)
func LookupNatGatewayOutput(ctx *Context, args *LookupNatGatewayOutputArgs, opts ...InvokeOption) LookupNatGatewayResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetNatGatewayResult> getNatGateway(GetNatGatewayArgs args, InvokeOptions options)
public static Output<GetNatGatewayResult> getNatGateway(GetNatGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:network/getNatGateway:getNatGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Specifies the Name of the NAT Gateway.
ResourceGroupName This property is required. 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 This property is required. string
Specifies the Name of the NAT Gateway.
ResourceGroupName This property is required. 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 This property is required. String
Specifies the Name of the NAT Gateway.
resourceGroupName This property is required. 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 This property is required. string
Specifies the Name of the NAT Gateway.
resourceGroupName This property is required. 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 This property is required. str
Specifies the Name of the NAT Gateway.
resource_group_name This property is required. 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 This property is required. String
Specifies the Name of the NAT Gateway.
resourceGroupName This property is required. 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.

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<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 Map<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 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<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 Map<String>
A mapping of tags assigned to the resource.
zones List<String>
A list of Availability Zones which the NAT Gateway exists in.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi