Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getNatGateway
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getNatGateway

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified nat gateway in a specified resource group.

Uses Azure REST API version 2024-05-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 for details.

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(expand: Optional[str] = None,
                    nat_gateway_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNatGatewayResult
def get_nat_gateway_output(expand: Optional[pulumi.Input[str]] = None,
                    nat_gateway_name: Optional[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-native:network:getNatGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NatGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the nat gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Expands referenced resources.
NatGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the nat gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Expand string
Expands referenced resources.
natGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the nat gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Expands referenced resources.
natGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the nat gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
expand string
Expands referenced resources.
nat_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the nat gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
expand str
Expands referenced resources.
natGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the nat gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
expand String
Expands referenced resources.

getNatGateway Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Name string
Resource name.
ProvisioningState string
The provisioning state of the NAT gateway resource.
ResourceGuid string
The resource GUID property of the NAT gateway resource.
Subnets List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
An array of references to the subnets using this nat gateway resource.
Type string
Resource type.
Id string
Resource ID.
IdleTimeoutInMinutes int
The idle timeout of the nat gateway.
Location string
Resource location.
PublicIpAddresses List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
An array of public ip addresses associated with the nat gateway resource.
PublicIpPrefixes List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>
An array of public ip prefixes associated with the nat gateway resource.
Sku Pulumi.AzureNative.Network.Outputs.NatGatewaySkuResponse
The nat gateway SKU.
Tags Dictionary<string, string>
Resource tags.
Zones List<string>
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Name string
Resource name.
ProvisioningState string
The provisioning state of the NAT gateway resource.
ResourceGuid string
The resource GUID property of the NAT gateway resource.
Subnets []SubResourceResponse
An array of references to the subnets using this nat gateway resource.
Type string
Resource type.
Id string
Resource ID.
IdleTimeoutInMinutes int
The idle timeout of the nat gateway.
Location string
Resource location.
PublicIpAddresses []SubResourceResponse
An array of public ip addresses associated with the nat gateway resource.
PublicIpPrefixes []SubResourceResponse
An array of public ip prefixes associated with the nat gateway resource.
Sku NatGatewaySkuResponse
The nat gateway SKU.
Tags map[string]string
Resource tags.
Zones []string
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
name String
Resource name.
provisioningState String
The provisioning state of the NAT gateway resource.
resourceGuid String
The resource GUID property of the NAT gateway resource.
subnets List<SubResourceResponse>
An array of references to the subnets using this nat gateway resource.
type String
Resource type.
id String
Resource ID.
idleTimeoutInMinutes Integer
The idle timeout of the nat gateway.
location String
Resource location.
publicIpAddresses List<SubResourceResponse>
An array of public ip addresses associated with the nat gateway resource.
publicIpPrefixes List<SubResourceResponse>
An array of public ip prefixes associated with the nat gateway resource.
sku NatGatewaySkuResponse
The nat gateway SKU.
tags Map<String,String>
Resource tags.
zones List<String>
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
name string
Resource name.
provisioningState string
The provisioning state of the NAT gateway resource.
resourceGuid string
The resource GUID property of the NAT gateway resource.
subnets SubResourceResponse[]
An array of references to the subnets using this nat gateway resource.
type string
Resource type.
id string
Resource ID.
idleTimeoutInMinutes number
The idle timeout of the nat gateway.
location string
Resource location.
publicIpAddresses SubResourceResponse[]
An array of public ip addresses associated with the nat gateway resource.
publicIpPrefixes SubResourceResponse[]
An array of public ip prefixes associated with the nat gateway resource.
sku NatGatewaySkuResponse
The nat gateway SKU.
tags {[key: string]: string}
Resource tags.
zones string[]
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
name str
Resource name.
provisioning_state str
The provisioning state of the NAT gateway resource.
resource_guid str
The resource GUID property of the NAT gateway resource.
subnets Sequence[SubResourceResponse]
An array of references to the subnets using this nat gateway resource.
type str
Resource type.
id str
Resource ID.
idle_timeout_in_minutes int
The idle timeout of the nat gateway.
location str
Resource location.
public_ip_addresses Sequence[SubResourceResponse]
An array of public ip addresses associated with the nat gateway resource.
public_ip_prefixes Sequence[SubResourceResponse]
An array of public ip prefixes associated with the nat gateway resource.
sku NatGatewaySkuResponse
The nat gateway SKU.
tags Mapping[str, str]
Resource tags.
zones Sequence[str]
A list of availability zones denoting the zone in which Nat Gateway should be deployed.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
name String
Resource name.
provisioningState String
The provisioning state of the NAT gateway resource.
resourceGuid String
The resource GUID property of the NAT gateway resource.
subnets List<Property Map>
An array of references to the subnets using this nat gateway resource.
type String
Resource type.
id String
Resource ID.
idleTimeoutInMinutes Number
The idle timeout of the nat gateway.
location String
Resource location.
publicIpAddresses List<Property Map>
An array of public ip addresses associated with the nat gateway resource.
publicIpPrefixes List<Property Map>
An array of public ip prefixes associated with the nat gateway resource.
sku Property Map
The nat gateway SKU.
tags Map<String>
Resource tags.
zones List<String>
A list of availability zones denoting the zone in which Nat Gateway should be deployed.

Supporting Types

NatGatewaySkuResponse

Name string
Name of Nat Gateway SKU.
Name string
Name of Nat Gateway SKU.
name String
Name of Nat Gateway SKU.
name string
Name of Nat Gateway SKU.
name str
Name of Nat Gateway SKU.
name String
Name of Nat Gateway SKU.

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native