We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.lb.getLBOutboundRule
Start a Neo task
Explain and create an azure.lb.getLBOutboundRule resource
Use this data source to access information about an existing Load Balancer Outbound Rule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.lb.getLBOutboundRule({
name: "existing_lb_outbound_rule",
loadbalancerId: "existing_load_balancer_id",
});
export const id = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.lb.get_lb_outbound_rule(name="existing_lb_outbound_rule",
loadbalancer_id="existing_load_balancer_id")
pulumi.export("id", example.id)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/lb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := lb.GetLBOutboundRule(ctx, &lb.GetLBOutboundRuleArgs{
Name: "existing_lb_outbound_rule",
LoadbalancerId: "existing_load_balancer_id",
}, nil)
if err != nil {
return err
}
ctx.Export("id", example.Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.Lb.GetLBOutboundRule.Invoke(new()
{
Name = "existing_lb_outbound_rule",
LoadbalancerId = "existing_load_balancer_id",
});
return new Dictionary<string, object?>
{
["id"] = example.Apply(getLBOutboundRuleResult => getLBOutboundRuleResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.lb.LbFunctions;
import com.pulumi.azure.lb.inputs.GetLBOutboundRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = LbFunctions.getLBOutboundRule(GetLBOutboundRuleArgs.builder()
.name("existing_lb_outbound_rule")
.loadbalancerId("existing_load_balancer_id")
.build());
ctx.export("id", example.id());
}
}
variables:
example:
fn::invoke:
function: azure:lb:getLBOutboundRule
arguments:
name: existing_lb_outbound_rule
loadbalancerId: existing_load_balancer_id
outputs:
id: ${example.id}
API Providers
This data source uses the following Azure API Providers:
Microsoft.Network- 2023-09-01
Using getLBOutboundRule
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 getLBOutboundRule(args: GetLBOutboundRuleArgs, opts?: InvokeOptions): Promise<GetLBOutboundRuleResult>
function getLBOutboundRuleOutput(args: GetLBOutboundRuleOutputArgs, opts?: InvokeOptions): Output<GetLBOutboundRuleResult>def get_lb_outbound_rule(loadbalancer_id: Optional[str] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetLBOutboundRuleResult
def get_lb_outbound_rule_output(loadbalancer_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetLBOutboundRuleResult]func GetLBOutboundRule(ctx *Context, args *GetLBOutboundRuleArgs, opts ...InvokeOption) (*GetLBOutboundRuleResult, error)
func GetLBOutboundRuleOutput(ctx *Context, args *GetLBOutboundRuleOutputArgs, opts ...InvokeOption) GetLBOutboundRuleResultOutput> Note: This function is named GetLBOutboundRule in the Go SDK.
public static class GetLBOutboundRule
{
public static Task<GetLBOutboundRuleResult> InvokeAsync(GetLBOutboundRuleArgs args, InvokeOptions? opts = null)
public static Output<GetLBOutboundRuleResult> Invoke(GetLBOutboundRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetLBOutboundRuleResult> getLBOutboundRule(GetLBOutboundRuleArgs args, InvokeOptions options)
public static Output<GetLBOutboundRuleResult> getLBOutboundRule(GetLBOutboundRuleArgs args, InvokeOptions options)
fn::invoke:
function: azure:lb/getLBOutboundRule:getLBOutboundRule
arguments:
# arguments dictionaryThe following arguments are supported:
- Loadbalancer
Id string - The ID of the Load Balancer in which the Outbound Rule exists.
- Name string
- The name of this Load Balancer Outbound Rule.
- Loadbalancer
Id string - The ID of the Load Balancer in which the Outbound Rule exists.
- Name string
- The name of this Load Balancer Outbound Rule.
- loadbalancer
Id String - The ID of the Load Balancer in which the Outbound Rule exists.
- name String
- The name of this Load Balancer Outbound Rule.
- loadbalancer
Id string - The ID of the Load Balancer in which the Outbound Rule exists.
- name string
- The name of this Load Balancer Outbound Rule.
- loadbalancer_
id str - The ID of the Load Balancer in which the Outbound Rule exists.
- name str
- The name of this Load Balancer Outbound Rule.
- loadbalancer
Id String - The ID of the Load Balancer in which the Outbound Rule exists.
- name String
- The name of this Load Balancer Outbound Rule.
getLBOutboundRule Result
The following output properties are available:
- Allocated
Outbound intPorts - The number of outbound ports used for NAT.
- Backend
Address stringPool Id - The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
- Enable
Tcp boolReset - Frontend
Ip List<GetConfigurations LBOutbound Rule Frontend Ip Configuration> - A
frontend_ip_configurationblock as defined below. - Id string
- The provider-assigned unique ID for this managed resource.
- Idle
Timeout intIn Minutes - The timeout for the TCP idle connection.
- Loadbalancer
Id string - Name string
- The name of the Frontend IP Configuration.
- Protocol string
- The transport protocol for the external endpoint.
- Tcp
Reset boolEnabled - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.
- Allocated
Outbound intPorts - The number of outbound ports used for NAT.
- Backend
Address stringPool Id - The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
- Enable
Tcp boolReset - Frontend
Ip []GetConfigurations LBOutbound Rule Frontend Ip Configuration - A
frontend_ip_configurationblock as defined below. - Id string
- The provider-assigned unique ID for this managed resource.
- Idle
Timeout intIn Minutes - The timeout for the TCP idle connection.
- Loadbalancer
Id string - Name string
- The name of the Frontend IP Configuration.
- Protocol string
- The transport protocol for the external endpoint.
- Tcp
Reset boolEnabled - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.
- allocated
Outbound IntegerPorts - The number of outbound ports used for NAT.
- backend
Address StringPool Id - The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
- enable
Tcp BooleanReset - frontend
Ip List<GetConfigurations LBOutbound Rule Frontend Ip Configuration> - A
frontend_ip_configurationblock as defined below. - id String
- The provider-assigned unique ID for this managed resource.
- idle
Timeout IntegerIn Minutes - The timeout for the TCP idle connection.
- loadbalancer
Id String - name String
- The name of the Frontend IP Configuration.
- protocol String
- The transport protocol for the external endpoint.
- tcp
Reset BooleanEnabled - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.
- allocated
Outbound numberPorts - The number of outbound ports used for NAT.
- backend
Address stringPool Id - The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
- enable
Tcp booleanReset - frontend
Ip GetConfigurations LBOutbound Rule Frontend Ip Configuration[] - A
frontend_ip_configurationblock as defined below. - id string
- The provider-assigned unique ID for this managed resource.
- idle
Timeout numberIn Minutes - The timeout for the TCP idle connection.
- loadbalancer
Id string - name string
- The name of the Frontend IP Configuration.
- protocol string
- The transport protocol for the external endpoint.
- tcp
Reset booleanEnabled - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.
- allocated_
outbound_ intports - The number of outbound ports used for NAT.
- backend_
address_ strpool_ id - The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
- enable_
tcp_ boolreset - frontend_
ip_ Sequence[Getconfigurations LBOutbound Rule Frontend Ip Configuration] - A
frontend_ip_configurationblock as defined below. - id str
- The provider-assigned unique ID for this managed resource.
- idle_
timeout_ intin_ minutes - The timeout for the TCP idle connection.
- loadbalancer_
id str - name str
- The name of the Frontend IP Configuration.
- protocol str
- The transport protocol for the external endpoint.
- tcp_
reset_ boolenabled - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.
- allocated
Outbound NumberPorts - The number of outbound ports used for NAT.
- backend
Address StringPool Id - The ID of the Backend Address Pool. Outbound traffic is randomly load balanced across IPs in the backend IPs.
- enable
Tcp BooleanReset - frontend
Ip List<Property Map>Configurations - A
frontend_ip_configurationblock as defined below. - id String
- The provider-assigned unique ID for this managed resource.
- idle
Timeout NumberIn Minutes - The timeout for the TCP idle connection.
- loadbalancer
Id String - name String
- The name of the Frontend IP Configuration.
- protocol String
- The transport protocol for the external endpoint.
- tcp
Reset BooleanEnabled - Is the bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination enabled? This value is useful when the protocol is set to TCP.
Supporting Types
GetLBOutboundRuleFrontendIpConfiguration
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
