azure-native.network.getNatRule
Explore with Pulumi AI
Retrieves the details of a nat ruleGet. API Version: 2020-11-01.
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:
- Gateway
Name string The name of the gateway.
- Nat
Rule stringName The name of the nat rule.
- Resource
Group stringName The resource group name of the VpnGateway.
- Gateway
Name string The name of the gateway.
- Nat
Rule stringName The name of the nat rule.
- Resource
Group stringName The resource group name of the VpnGateway.
- gateway
Name String The name of the gateway.
- nat
Rule StringName The name of the nat rule.
- resource
Group StringName The resource group name of the VpnGateway.
- gateway
Name string The name of the gateway.
- nat
Rule stringName The name of the nat rule.
- resource
Group stringName The resource group name of the VpnGateway.
- gateway_
name str The name of the gateway.
- nat_
rule_ strname The name of the nat rule.
- resource_
group_ strname The resource group name of the VpnGateway.
- gateway
Name String The name of the gateway.
- nat
Rule StringName The name of the nat rule.
- resource
Group StringName The resource group name of the VpnGateway.
getNatRule Result
The following output properties are available:
- Egress
Vpn List<Pulumi.Site Link Connections Azure Native. Network. Outputs. Sub Resource Response> List of egress VpnSiteLinkConnections.
- Etag string
A unique read-only string that changes whenever the resource is updated.
- Ingress
Vpn List<Pulumi.Site Link Connections Azure Native. Network. Outputs. Sub Resource Response> List of ingress VpnSiteLinkConnections.
- Provisioning
State string The provisioning state of the NAT Rule resource.
- Type string
Resource type.
- External
Mappings List<Pulumi.Azure Native. Network. Outputs. Vpn Nat Rule Mapping Response> The private IP address external mapping for NAT.
- Id string
Resource ID.
- Internal
Mappings List<Pulumi.Azure Native. Network. Outputs. Vpn Nat Rule Mapping Response> The private IP address internal mapping for NAT.
- Ip
Configuration stringId 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 []SubSite Link Connections Resource Response List of egress VpnSiteLinkConnections.
- Etag string
A unique read-only string that changes whenever the resource is updated.
- Ingress
Vpn []SubSite Link Connections Resource Response List of ingress VpnSiteLinkConnections.
- Provisioning
State string The provisioning state of the NAT Rule resource.
- Type string
Resource type.
- External
Mappings []VpnNat Rule Mapping Response The private IP address external mapping for NAT.
- Id string
Resource ID.
- Internal
Mappings []VpnNat Rule Mapping Response The private IP address internal mapping for NAT.
- Ip
Configuration stringId 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 List<SubSite Link Connections Resource Response> List of egress VpnSiteLinkConnections.
- etag String
A unique read-only string that changes whenever the resource is updated.
- ingress
Vpn List<SubSite Link Connections Resource Response> List of ingress VpnSiteLinkConnections.
- provisioning
State String The provisioning state of the NAT Rule resource.
- type String
Resource type.
- external
Mappings List<VpnNat Rule Mapping Response> The private IP address external mapping for NAT.
- id String
Resource ID.
- internal
Mappings List<VpnNat Rule Mapping Response> The private IP address internal mapping for NAT.
- ip
Configuration StringId 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 SubSite Link Connections Resource Response[] List of egress VpnSiteLinkConnections.
- etag string
A unique read-only string that changes whenever the resource is updated.
- ingress
Vpn SubSite Link Connections Resource Response[] List of ingress VpnSiteLinkConnections.
- provisioning
State string The provisioning state of the NAT Rule resource.
- type string
Resource type.
- external
Mappings VpnNat Rule Mapping Response[] The private IP address external mapping for NAT.
- id string
Resource ID.
- internal
Mappings VpnNat Rule Mapping Response[] The private IP address internal mapping for NAT.
- ip
Configuration stringId 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_ Sequence[Subsite_ link_ connections Resource Response] List of egress VpnSiteLinkConnections.
- etag str
A unique read-only string that changes whenever the resource is updated.
- ingress_
vpn_ Sequence[Subsite_ link_ connections Resource Response] List of ingress VpnSiteLinkConnections.
- provisioning_
state str The provisioning state of the NAT Rule resource.
- type str
Resource type.
- external_
mappings Sequence[VpnNat Rule Mapping Response] The private IP address external mapping for NAT.
- id str
Resource ID.
- internal_
mappings Sequence[VpnNat Rule Mapping Response] The private IP address internal mapping for NAT.
- ip_
configuration_ strid 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.
- egress
Vpn List<Property Map>Site Link Connections List of egress VpnSiteLinkConnections.
- etag String
A unique read-only string that changes whenever the resource is updated.
- ingress
Vpn List<Property Map>Site Link Connections List of ingress VpnSiteLinkConnections.
- provisioning
State String The provisioning state of the NAT Rule resource.
- type String
Resource type.
- external
Mappings List<Property Map> The private IP address external mapping for NAT.
- id String
Resource ID.
- internal
Mappings List<Property Map> The private IP address internal mapping for NAT.
- ip
Configuration StringId 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
- Address
Space string Address space for Vpn NatRule mapping.
- Address
Space string Address space for Vpn NatRule mapping.
- address
Space String Address space for Vpn NatRule mapping.
- address
Space string Address space for Vpn NatRule mapping.
- address_
space str Address space for Vpn NatRule mapping.
- address
Space String Address space for Vpn NatRule mapping.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0