Azure Native v1.103.0, Jun 2 23

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.network.getNatRule

Explore with Pulumi AI

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

Using getNatRule

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 getNatRule(args: GetNatRuleArgs, opts?: InvokeOptions): Promise<GetNatRuleResult>
function getNatRuleOutput(args: GetNatRuleOutputArgs, opts?: InvokeOptions): Output<GetNatRuleResult>

def get_nat_rule(gateway_name: Optional[str] = None,
                 nat_rule_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNatRuleResult
def get_nat_rule_output(gateway_name: Optional[pulumi.Input[str]] = None,
                 nat_rule_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNatRuleResult]

func LookupNatRule(ctx *Context, args *LookupNatRuleArgs, opts ...InvokeOption) (*LookupNatRuleResult, error)
func LookupNatRuleOutput(ctx *Context, args *LookupNatRuleOutputArgs, opts ...InvokeOption) LookupNatRuleResultOutput

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

public static class GetNatRule 
{
    public static Task<GetNatRuleResult> InvokeAsync(GetNatRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetNatRuleResult> Invoke(GetNatRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNatRuleResult> getNatRule(GetNatRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getNatRule
  arguments:
    # arguments dictionary

The following arguments are supported:

GatewayName string: The name of the gateway.
NatRuleName string: The name of the nat rule.
ResourceGroupName string: The resource group name of the VpnGateway.

GatewayName string: The name of the gateway.
NatRuleName string: The name of the nat rule.
ResourceGroupName string: The resource group name of the VpnGateway.

gatewayName String: The name of the gateway.
natRuleName String: The name of the nat rule.
resourceGroupName String: The resource group name of the VpnGateway.

gatewayName string: The name of the gateway.
natRuleName string: The name of the nat rule.
resourceGroupName string: The resource group name of the VpnGateway.

gateway_name str: The name of the gateway.
nat_rule_name str: The name of the nat rule.
resource_group_name str: The resource group name of the VpnGateway.

gatewayName String: The name of the gateway.
natRuleName String: The name of the nat rule.
resourceGroupName String: The resource group name of the VpnGateway.

getNatRule Result

The following output properties are available:

EgressVpnSiteLinkConnections List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>: List of egress VpnSiteLinkConnections.
Etag string: A unique read-only string that changes whenever the resource is updated.
IngressVpnSiteLinkConnections List<Pulumi.AzureNative.Network.Outputs.SubResourceResponse>: List of ingress VpnSiteLinkConnections.
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.

EgressVpnSiteLinkConnections []SubResourceResponse: List of egress VpnSiteLinkConnections.
Etag string: A unique read-only string that changes whenever the resource is updated.
IngressVpnSiteLinkConnections []SubResourceResponse: List of ingress VpnSiteLinkConnections.
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.

egressVpnSiteLinkConnections List<SubResourceResponse>: List of egress VpnSiteLinkConnections.
etag String: A unique read-only string that changes whenever the resource is updated.
ingressVpnSiteLinkConnections List<SubResourceResponse>: List of ingress VpnSiteLinkConnections.
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.

egressVpnSiteLinkConnections SubResourceResponse[]: List of egress VpnSiteLinkConnections.
etag string: A unique read-only string that changes whenever the resource is updated.
ingressVpnSiteLinkConnections SubResourceResponse[]: List of ingress VpnSiteLinkConnections.
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.

egress_vpn_site_link_connections Sequence[SubResourceResponse]: List of egress VpnSiteLinkConnections.
etag str: A unique read-only string that changes whenever the resource is updated.
ingress_vpn_site_link_connections Sequence[SubResourceResponse]: List of ingress VpnSiteLinkConnections.
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.

egressVpnSiteLinkConnections List<Property Map>: List of egress VpnSiteLinkConnections.
etag String: A unique read-only string that changes whenever the resource is updated.
ingressVpnSiteLinkConnections List<Property Map>: List of ingress VpnSiteLinkConnections.
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

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.

VpnNatRuleMappingResponse

AddressSpace string: Address space for Vpn NatRule mapping.

AddressSpace string: Address space for Vpn NatRule mapping.

addressSpace String: Address space for Vpn NatRule mapping.

addressSpace string: Address space for Vpn NatRule mapping.

address_space str: Address space for Vpn NatRule mapping.

addressSpace String: Address space for Vpn NatRule mapping.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.network.getNatRule

On this page

On this page

Using getNatRule

getNatRule Result

Supporting Types

SubResourceResponse

VpnNatRuleMappingResponse

Package Details

On this page

On this page