Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getVirtualNetworkGatewayNatRule
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.getVirtualNetworkGatewayNatRule

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

Retrieves the details of a nat rule.

Uses Azure REST API version 2024-05-01.

Other available API versions: 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 getVirtualNetworkGatewayNatRule

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 getVirtualNetworkGatewayNatRule(args: GetVirtualNetworkGatewayNatRuleArgs, opts?: InvokeOptions): Promise<GetVirtualNetworkGatewayNatRuleResult>
function getVirtualNetworkGatewayNatRuleOutput(args: GetVirtualNetworkGatewayNatRuleOutputArgs, opts?: InvokeOptions): Output<GetVirtualNetworkGatewayNatRuleResult>
Copy
def get_virtual_network_gateway_nat_rule(nat_rule_name: Optional[str] = None,
                                         resource_group_name: Optional[str] = None,
                                         virtual_network_gateway_name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetVirtualNetworkGatewayNatRuleResult
def get_virtual_network_gateway_nat_rule_output(nat_rule_name: Optional[pulumi.Input[str]] = None,
                                         resource_group_name: Optional[pulumi.Input[str]] = None,
                                         virtual_network_gateway_name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetVirtualNetworkGatewayNatRuleResult]
Copy
func LookupVirtualNetworkGatewayNatRule(ctx *Context, args *LookupVirtualNetworkGatewayNatRuleArgs, opts ...InvokeOption) (*LookupVirtualNetworkGatewayNatRuleResult, error)
func LookupVirtualNetworkGatewayNatRuleOutput(ctx *Context, args *LookupVirtualNetworkGatewayNatRuleOutputArgs, opts ...InvokeOption) LookupVirtualNetworkGatewayNatRuleResultOutput
Copy

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

public static class GetVirtualNetworkGatewayNatRule 
{
    public static Task<GetVirtualNetworkGatewayNatRuleResult> InvokeAsync(GetVirtualNetworkGatewayNatRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualNetworkGatewayNatRuleResult> Invoke(GetVirtualNetworkGatewayNatRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualNetworkGatewayNatRuleResult> getVirtualNetworkGatewayNatRule(GetVirtualNetworkGatewayNatRuleArgs args, InvokeOptions options)
public static Output<GetVirtualNetworkGatewayNatRuleResult> getVirtualNetworkGatewayNatRule(GetVirtualNetworkGatewayNatRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getVirtualNetworkGatewayNatRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NatRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the nat rule.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the Virtual Network Gateway.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gateway.
NatRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the nat rule.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the Virtual Network Gateway.
VirtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gateway.
natRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the nat rule.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the Virtual Network Gateway.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gateway.
natRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the nat rule.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name of the Virtual Network Gateway.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of the gateway.
nat_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the nat rule.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name of the Virtual Network Gateway.
virtual_network_gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the gateway.
natRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the nat rule.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name of the Virtual Network Gateway.
virtualNetworkGatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of the gateway.

getVirtualNetworkGatewayNatRule 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.
ProvisioningState string
The provisioning state of the NAT Rule resource.
Type string
Resource type.
ExternalMappings List<Pulumi.AzureNative.Network.Outputs.VpnNatRuleMappingResponse>
The private IP address external mapping for NAT.
Id string
Resource ID.
InternalMappings List<Pulumi.AzureNative.Network.Outputs.VpnNatRuleMappingResponse>
The private IP address internal mapping for NAT.
IpConfigurationId string
The IP Configuration ID this NAT rule applies to.
Mode string
The Source NAT direction of a VPN NAT.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState string
The provisioning state of the NAT Rule resource.
Type string
Resource type.
ExternalMappings []VpnNatRuleMappingResponse
The private IP address external mapping for NAT.
Id string
Resource ID.
InternalMappings []VpnNatRuleMappingResponse
The private IP address internal mapping for NAT.
IpConfigurationId string
The IP Configuration ID this NAT rule applies to.
Mode string
The Source NAT direction of a VPN NAT.
Name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the NAT Rule resource.
type String
Resource type.
externalMappings List<VpnNatRuleMappingResponse>
The private IP address external mapping for NAT.
id String
Resource ID.
internalMappings List<VpnNatRuleMappingResponse>
The private IP address internal mapping for NAT.
ipConfigurationId String
The IP Configuration ID this NAT rule applies to.
mode String
The Source NAT direction of a VPN NAT.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
provisioningState string
The provisioning state of the NAT Rule resource.
type string
Resource type.
externalMappings VpnNatRuleMappingResponse[]
The private IP address external mapping for NAT.
id string
Resource ID.
internalMappings VpnNatRuleMappingResponse[]
The private IP address internal mapping for NAT.
ipConfigurationId string
The IP Configuration ID this NAT rule applies to.
mode string
The Source NAT direction of a VPN NAT.
name string
The name of the resource that is unique within a resource group. This name can be used to access the resource.
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.
provisioning_state str
The provisioning state of the NAT Rule resource.
type str
Resource type.
external_mappings Sequence[VpnNatRuleMappingResponse]
The private IP address external mapping for NAT.
id str
Resource ID.
internal_mappings Sequence[VpnNatRuleMappingResponse]
The private IP address internal mapping for NAT.
ip_configuration_id str
The IP Configuration ID this NAT rule applies to.
mode str
The Source NAT direction of a VPN NAT.
name str
The name of the resource that is unique within a resource group. This name can be used to access the resource.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
provisioningState String
The provisioning state of the NAT Rule resource.
type String
Resource type.
externalMappings List<Property Map>
The private IP address external mapping for NAT.
id String
Resource ID.
internalMappings List<Property Map>
The private IP address internal mapping for NAT.
ipConfigurationId String
The IP Configuration ID this NAT rule applies to.
mode String
The Source NAT direction of a VPN NAT.
name String
The name of the resource that is unique within a resource group. This name can be used to access the resource.

Supporting Types

VpnNatRuleMappingResponse

AddressSpace string
Address space for Vpn NatRule mapping.
PortRange string
Port range for Vpn NatRule mapping.
AddressSpace string
Address space for Vpn NatRule mapping.
PortRange string
Port range for Vpn NatRule mapping.
addressSpace String
Address space for Vpn NatRule mapping.
portRange String
Port range for Vpn NatRule mapping.
addressSpace string
Address space for Vpn NatRule mapping.
portRange string
Port range for Vpn NatRule mapping.
address_space str
Address space for Vpn NatRule mapping.
port_range str
Port range for Vpn NatRule mapping.
addressSpace String
Address space for Vpn NatRule mapping.
portRange String
Port range for Vpn NatRule mapping.

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