1. Packages
  2. Scaleway
  3. API Docs
  4. loadbalancers
  5. getLoadBalancer
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

scaleway.loadbalancers.getLoadBalancer

scaleway logo
Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

    Gets information about a Load Balancer.

    For more information, see the main documentation or API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

// Get info by name
const byName = scaleway.loadbalancers.getLoadBalancer({
    name: "foobar",
});
// Get info by ID
const byId = scaleway.loadbalancers.getLoadBalancer({
    lbId: "11111111-1111-1111-1111-111111111111",
});

    import pulumi
import pulumi_scaleway as scaleway

# Get info by name
by_name = scaleway.loadbalancers.get_load_balancer(name="foobar")
# Get info by ID
by_id = scaleway.loadbalancers.get_load_balancer(lb_id="11111111-1111-1111-1111-111111111111")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/loadbalancers"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get info by name
		_, err := loadbalancers.LookupLoadBalancer(ctx, &loadbalancers.LookupLoadBalancerArgs{
			Name: pulumi.StringRef("foobar"),
		}, nil)
		if err != nil {
			return err
		}
		// Get info by ID
		_, err = loadbalancers.LookupLoadBalancer(ctx, &loadbalancers.LookupLoadBalancerArgs{
			LbId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Get info by name
    var byName = Scaleway.Loadbalancers.GetLoadBalancer.Invoke(new()
    {
        Name = "foobar",
    });

    // Get info by ID
    var byId = Scaleway.Loadbalancers.GetLoadBalancer.Invoke(new()
    {
        LbId = "11111111-1111-1111-1111-111111111111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.loadbalancers.LoadbalancersFunctions;
import com.pulumi.scaleway.loadbalancers.inputs.GetLoadBalancerArgs;
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) {
        // Get info by name
        final var byName = LoadbalancersFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
            .name("foobar")
            .build());

        // Get info by ID
        final var byId = LoadbalancersFunctions.getLoadBalancer(GetLoadBalancerArgs.builder()
            .lbId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

    variables:
  # Get info by name
  byName:
    fn::invoke:
      function: scaleway:loadbalancers:getLoadBalancer
      arguments:
        name: foobar
  # Get info by ID
  byId:
    fn::invoke:
      function: scaleway:loadbalancers:getLoadBalancer
      arguments:
        lbId: 11111111-1111-1111-1111-111111111111

    Using getLoadBalancer

    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 getLoadBalancer(args: GetLoadBalancerArgs, opts?: InvokeOptions): Promise<GetLoadBalancerResult>
function getLoadBalancerOutput(args: GetLoadBalancerOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerResult>
    def get_load_balancer(lb_id: Optional[str] = None,
                      name: Optional[str] = None,
                      project_id: Optional[str] = None,
                      release_ip: Optional[bool] = None,
                      zone: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLoadBalancerResult
def get_load_balancer_output(lb_id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      release_ip: Optional[pulumi.Input[bool]] = None,
                      zone: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerResult]
    func LookupLoadBalancer(ctx *Context, args *LookupLoadBalancerArgs, opts ...InvokeOption) (*LookupLoadBalancerResult, error)
func LookupLoadBalancerOutput(ctx *Context, args *LookupLoadBalancerOutputArgs, opts ...InvokeOption) LookupLoadBalancerResultOutput

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

    public static class GetLoadBalancer 
{
    public static Task<GetLoadBalancerResult> InvokeAsync(GetLoadBalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancerResult> Invoke(GetLoadBalancerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)
public static Output<GetLoadBalancerResult> getLoadBalancer(GetLoadBalancerArgs args, InvokeOptions options)

    fn::invoke:
  function: scaleway:loadbalancers/getLoadBalancer:getLoadBalancer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LbId string
    Name string
    The Load Balancer name.
    ProjectId string
    The ID of the Project the Load Balancer is associated with.
    ReleaseIp bool
    Zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    LbId string
    Name string
    The Load Balancer name.
    ProjectId string
    The ID of the Project the Load Balancer is associated with.
    ReleaseIp bool
    Zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    lbId String
    name String
    The Load Balancer name.
    projectId String
    The ID of the Project the Load Balancer is associated with.
    releaseIp Boolean
    zone String
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    lbId string
    name string
    The Load Balancer name.
    projectId string
    The ID of the Project the Load Balancer is associated with.
    releaseIp boolean
    zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    lb_id str
    name str
    The Load Balancer name.
    project_id str
    The ID of the Project the Load Balancer is associated with.
    release_ip bool
    zone str
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    lbId String
    name String
    The Load Balancer name.
    projectId String
    The ID of the Project the Load Balancer is associated with.
    releaseIp Boolean
    zone String
    (Defaults to provider zone) The zone in which the Load Balancer exists.

    getLoadBalancer Result

    The following output properties are available:

    AssignFlexibleIp bool
    AssignFlexibleIpv6 bool
    Description string
    ExternalPrivateNetworks bool
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The Load Balancer public IP address.
    IpId string
    IpIds List<string>
    Ipv6Address string
    OrganizationId string
    PrivateIps List<Pulumiverse.Scaleway.Loadbalancers.Outputs.GetLoadBalancerPrivateIp>
    PrivateNetworks List<Pulumiverse.Scaleway.Loadbalancers.Outputs.GetLoadBalancerPrivateNetwork>
    Region string
    SslCompatibilityLevel string
    Tags List<string>
    The tags associated with the Load Balancer.
    Type string
    The Load Balancer type.
    LbId string
    Name string
    ProjectId string
    ReleaseIp bool
    Zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    AssignFlexibleIp bool
    AssignFlexibleIpv6 bool
    Description string
    ExternalPrivateNetworks bool
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    The Load Balancer public IP address.
    IpId string
    IpIds []string
    Ipv6Address string
    OrganizationId string
    PrivateIps []GetLoadBalancerPrivateIp
    PrivateNetworks []GetLoadBalancerPrivateNetwork
    Region string
    SslCompatibilityLevel string
    Tags []string
    The tags associated with the Load Balancer.
    Type string
    The Load Balancer type.
    LbId string
    Name string
    ProjectId string
    ReleaseIp bool
    Zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    assignFlexibleIp Boolean
    assignFlexibleIpv6 Boolean
    description String
    externalPrivateNetworks Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The Load Balancer public IP address.
    ipId String
    ipIds List<String>
    ipv6Address String
    organizationId String
    privateIps List<GetLoadBalancerPrivateIp>
    privateNetworks List<GetLoadBalancerPrivateNetwork>
    region String
    sslCompatibilityLevel String
    tags List<String>
    The tags associated with the Load Balancer.
    type String
    The Load Balancer type.
    lbId String
    name String
    projectId String
    releaseIp Boolean
    zone String
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    assignFlexibleIp boolean
    assignFlexibleIpv6 boolean
    description string
    externalPrivateNetworks boolean
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    The Load Balancer public IP address.
    ipId string
    ipIds string[]
    ipv6Address string
    organizationId string
    privateIps GetLoadBalancerPrivateIp[]
    privateNetworks GetLoadBalancerPrivateNetwork[]
    region string
    sslCompatibilityLevel string
    tags string[]
    The tags associated with the Load Balancer.
    type string
    The Load Balancer type.
    lbId string
    name string
    projectId string
    releaseIp boolean
    zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    assign_flexible_ip bool
    assign_flexible_ipv6 bool
    description str
    external_private_networks bool
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    The Load Balancer public IP address.
    ip_id str
    ip_ids Sequence[str]
    ipv6_address str
    organization_id str
    private_ips Sequence[GetLoadBalancerPrivateIp]
    private_networks Sequence[GetLoadBalancerPrivateNetwork]
    region str
    ssl_compatibility_level str
    tags Sequence[str]
    The tags associated with the Load Balancer.
    type str
    The Load Balancer type.
    lb_id str
    name str
    project_id str
    release_ip bool
    zone str
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    assignFlexibleIp Boolean
    assignFlexibleIpv6 Boolean
    description String
    externalPrivateNetworks Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    The Load Balancer public IP address.
    ipId String
    ipIds List<String>
    ipv6Address String
    organizationId String
    privateIps List<Property Map>
    privateNetworks List<Property Map>
    region String
    sslCompatibilityLevel String
    tags List<String>
    The tags associated with the Load Balancer.
    type String
    The Load Balancer type.
    lbId String
    name String
    projectId String
    releaseIp Boolean
    zone String
    (Defaults to provider zone) The zone in which the Load Balancer exists.

    Supporting Types

    GetLoadBalancerPrivateIp

    Address string
    The private IP address
    Id string
    The ID of the Load Balancer.
    Address string
    The private IP address
    Id string
    The ID of the Load Balancer.
    address String
    The private IP address
    id String
    The ID of the Load Balancer.
    address string
    The private IP address
    id string
    The ID of the Load Balancer.
    address str
    The private IP address
    id str
    The ID of the Load Balancer.
    address String
    The private IP address
    id String
    The ID of the Load Balancer.

    GetLoadBalancerPrivateNetwork

    DhcpConfig bool
    Set to true if you want to let DHCP assign IP addresses
    IpamIds List<string>
    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
    PrivateNetworkId string
    The Private Network ID
    StaticConfigs List<string>
    Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
    Status string
    The status of private network connection
    Zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    DhcpConfig bool
    Set to true if you want to let DHCP assign IP addresses
    IpamIds []string
    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
    PrivateNetworkId string
    The Private Network ID
    StaticConfigs []string
    Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
    Status string
    The status of private network connection
    Zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    dhcpConfig Boolean
    Set to true if you want to let DHCP assign IP addresses
    ipamIds List<String>
    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
    privateNetworkId String
    The Private Network ID
    staticConfigs List<String>
    Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
    status String
    The status of private network connection
    zone String
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    dhcpConfig boolean
    Set to true if you want to let DHCP assign IP addresses
    ipamIds string[]
    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
    privateNetworkId string
    The Private Network ID
    staticConfigs string[]
    Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
    status string
    The status of private network connection
    zone string
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    dhcp_config bool
    Set to true if you want to let DHCP assign IP addresses
    ipam_ids Sequence[str]
    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
    private_network_id str
    The Private Network ID
    static_configs Sequence[str]
    Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
    status str
    The status of private network connection
    zone str
    (Defaults to provider zone) The zone in which the Load Balancer exists.
    dhcpConfig Boolean
    Set to true if you want to let DHCP assign IP addresses
    ipamIds List<String>
    IPAM ID of a pre-reserved IP address to assign to the Load Balancer on this Private Network
    privateNetworkId String
    The Private Network ID
    staticConfigs List<String>
    Define an IP address in the subnet of your private network that will be assigned to your load balancer instance
    status String
    The status of private network connection
    zone String
    (Defaults to provider zone) The zone in which the Load Balancer exists.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.44.1
    published on Monday, Mar 9, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-scaleway
      Try Pulumi Cloud free. Your team will thank you.