Azure Classic v5.38.0, Mar 21 23

azure.lb.getLBRule

Use this data source to access information about an existing Load Balancer Rule.

Example Usage

Coming soon!

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.GetLBArgs;
import com.pulumi.azure.lb.inputs.GetLBRuleArgs;
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 exampleLB = LbFunctions.getLB(GetLBArgs.builder()
            .name("example-lb")
            .resourceGroupName("example-resources")
            .build());

        final var exampleLBRule = LbFunctions.getLBRule(GetLBRuleArgs.builder()
            .name("first")
            .resourceGroupName("example-resources")
            .loadbalancerId(exampleLB.applyValue(getLBResult -> getLBResult.id()))
            .build());

        ctx.export("lbRuleId", exampleLBRule.applyValue(getLBRuleResult -> getLBRuleResult.id()));
    }
}

Coming soon!

variables:
  exampleLB:
    fn::invoke:
      Function: azure:lb:getLB
      Arguments:
        name: example-lb
        resourceGroupName: example-resources
  exampleLBRule:
    fn::invoke:
      Function: azure:lb:getLBRule
      Arguments:
        name: first
        resourceGroupName: example-resources
        loadbalancerId: ${exampleLB.id}
outputs:
  lbRuleId: ${exampleLBRule.id}

Using getLBRule

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 getLBRule(args: GetLBRuleArgs, opts?: InvokeOptions): Promise<GetLBRuleResult>
function getLBRuleOutput(args: GetLBRuleOutputArgs, opts?: InvokeOptions): Output<GetLBRuleResult>

def get_lb_rule(loadbalancer_id: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetLBRuleResult
def get_lb_rule_output(loadbalancer_id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetLBRuleResult]

func GetLBRule(ctx *Context, args *GetLBRuleArgs, opts ...InvokeOption) (*GetLBRuleResult, error)
func GetLBRuleOutput(ctx *Context, args *GetLBRuleOutputArgs, opts ...InvokeOption) GetLBRuleResultOutput

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

public static class GetLBRule 
{
    public static Task<GetLBRuleResult> InvokeAsync(GetLBRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetLBRuleResult> Invoke(GetLBRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLBRuleResult> getLBRule(GetLBRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:lb/getLBRule:getLBRule
  arguments:
    # arguments dictionary

The following arguments are supported:

LoadbalancerId string: The ID of the Load Balancer Rule.
Name string: The name of this Load Balancer Rule.

LoadbalancerId string: The ID of the Load Balancer Rule.
Name string: The name of this Load Balancer Rule.

loadbalancerId String: The ID of the Load Balancer Rule.
name String: The name of this Load Balancer Rule.

loadbalancerId string: The ID of the Load Balancer Rule.
name string: The name of this Load Balancer Rule.

loadbalancer_id str: The ID of the Load Balancer Rule.
name str: The name of this Load Balancer Rule.

loadbalancerId String: The ID of the Load Balancer Rule.
name String: The name of this Load Balancer Rule.

getLBRule Result

The following output properties are available:

BackendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
BackendPort int: The port used for internal connections on the endpoint.
DisableOutboundSnat bool: If outbound SNAT is enabled for this Load Balancer Rule.
EnableFloatingIp bool: If Floating IPs are enabled for this Load Balancer Rule
EnableTcpReset bool: If TCP Reset is enabled for this Load Balancer Rule.
FrontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
FrontendPort int: The port for the external endpoint.
Id string: The provider-assigned unique ID for this managed resource.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections.
LoadDistribution string: Specifies the load balancing distribution type used by the Load Balancer.
LoadbalancerId string
Name string
ProbeId string: A reference to a Probe used by this Load Balancing Rule.
Protocol string: The transport protocol for the external endpoint.

BackendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
BackendPort int: The port used for internal connections on the endpoint.
DisableOutboundSnat bool: If outbound SNAT is enabled for this Load Balancer Rule.
EnableFloatingIp bool: If Floating IPs are enabled for this Load Balancer Rule
EnableTcpReset bool: If TCP Reset is enabled for this Load Balancer Rule.
FrontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
FrontendPort int: The port for the external endpoint.
Id string: The provider-assigned unique ID for this managed resource.
IdleTimeoutInMinutes int: Specifies the idle timeout in minutes for TCP connections.
LoadDistribution string: Specifies the load balancing distribution type used by the Load Balancer.
LoadbalancerId string
Name string
ProbeId string: A reference to a Probe used by this Load Balancing Rule.
Protocol string: The transport protocol for the external endpoint.

backendAddressPoolId String: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backendPort Integer: The port used for internal connections on the endpoint.
disableOutboundSnat Boolean: If outbound SNAT is enabled for this Load Balancer Rule.
enableFloatingIp Boolean: If Floating IPs are enabled for this Load Balancer Rule
enableTcpReset Boolean: If TCP Reset is enabled for this Load Balancer Rule.
frontendIpConfigurationName String: The name of the frontend IP configuration to which the rule is associated.
frontendPort Integer: The port for the external endpoint.
id String: The provider-assigned unique ID for this managed resource.
idleTimeoutInMinutes Integer: Specifies the idle timeout in minutes for TCP connections.
loadDistribution String: Specifies the load balancing distribution type used by the Load Balancer.
loadbalancerId String
name String
probeId String: A reference to a Probe used by this Load Balancing Rule.
protocol String: The transport protocol for the external endpoint.

backendAddressPoolId string: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backendPort number: The port used for internal connections on the endpoint.
disableOutboundSnat boolean: If outbound SNAT is enabled for this Load Balancer Rule.
enableFloatingIp boolean: If Floating IPs are enabled for this Load Balancer Rule
enableTcpReset boolean: If TCP Reset is enabled for this Load Balancer Rule.
frontendIpConfigurationName string: The name of the frontend IP configuration to which the rule is associated.
frontendPort number: The port for the external endpoint.
id string: The provider-assigned unique ID for this managed resource.
idleTimeoutInMinutes number: Specifies the idle timeout in minutes for TCP connections.
loadDistribution string: Specifies the load balancing distribution type used by the Load Balancer.
loadbalancerId string
name string
probeId string: A reference to a Probe used by this Load Balancing Rule.
protocol string: The transport protocol for the external endpoint.

backend_address_pool_id str: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backend_port int: The port used for internal connections on the endpoint.
disable_outbound_snat bool: If outbound SNAT is enabled for this Load Balancer Rule.
enable_floating_ip bool: If Floating IPs are enabled for this Load Balancer Rule
enable_tcp_reset bool: If TCP Reset is enabled for this Load Balancer Rule.
frontend_ip_configuration_name str: The name of the frontend IP configuration to which the rule is associated.
frontend_port int: The port for the external endpoint.
id str: The provider-assigned unique ID for this managed resource.
idle_timeout_in_minutes int: Specifies the idle timeout in minutes for TCP connections.
load_distribution str: Specifies the load balancing distribution type used by the Load Balancer.
loadbalancer_id str
name str
probe_id str: A reference to a Probe used by this Load Balancing Rule.
protocol str: The transport protocol for the external endpoint.

backendAddressPoolId String: A reference to a Backend Address Pool over which this Load Balancing Rule operates.
backendPort Number: The port used for internal connections on the endpoint.
disableOutboundSnat Boolean: If outbound SNAT is enabled for this Load Balancer Rule.
enableFloatingIp Boolean: If Floating IPs are enabled for this Load Balancer Rule
enableTcpReset Boolean: If TCP Reset is enabled for this Load Balancer Rule.
frontendIpConfigurationName String: The name of the frontend IP configuration to which the rule is associated.
frontendPort Number: The port for the external endpoint.
id String: The provider-assigned unique ID for this managed resource.
idleTimeoutInMinutes Number: Specifies the idle timeout in minutes for TCP connections.
loadDistribution String: Specifies the load balancing distribution type used by the Load Balancer.
loadbalancerId String
name String
probeId String: A reference to a Probe used by this Load Balancing Rule.
protocol String: The transport protocol for the external endpoint.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

azure.lb.getLBRule

Example Usage

Using getLBRule

getLBRule Result

Package Details

Contents