1. Packages
  2. Scaleway
  3. API Docs
  4. loadbalancers
  5. getLoadBalancers
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.loadbalancers.getLoadBalancers

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

Gets information about multiple Load Balancers.

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

Using getLoadBalancers

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 getLoadBalancers(args: GetLoadBalancersArgs, opts?: InvokeOptions): Promise<GetLoadBalancersResult>
function getLoadBalancersOutput(args: GetLoadBalancersOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancersResult>
Copy
def get_load_balancers(name: Optional[str] = None,
                       project_id: Optional[str] = None,
                       tags: Optional[Sequence[str]] = None,
                       zone: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLoadBalancersResult
def get_load_balancers_output(name: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       zone: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancersResult]
Copy
func GetLoadBalancers(ctx *Context, args *GetLoadBalancersArgs, opts ...InvokeOption) (*GetLoadBalancersResult, error)
func GetLoadBalancersOutput(ctx *Context, args *GetLoadBalancersOutputArgs, opts ...InvokeOption) GetLoadBalancersResultOutput
Copy

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

public static class GetLoadBalancers 
{
    public static Task<GetLoadBalancersResult> InvokeAsync(GetLoadBalancersArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancersResult> Invoke(GetLoadBalancersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLoadBalancersResult> getLoadBalancers(GetLoadBalancersArgs args, InvokeOptions options)
public static Output<GetLoadBalancersResult> getLoadBalancers(GetLoadBalancersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scaleway:loadbalancers/getLoadBalancers:getLoadBalancers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
ProjectId Changes to this property will trigger replacement. string
The ID of the Project the Load Balancer is associated with.
Tags List<string>
List of tags to filter for. Load Balancers with these exact tags are listed.
Zone Changes to this property will trigger replacement. string
zone) The zone in which the Load Balancers exist.
Name string
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
ProjectId Changes to this property will trigger replacement. string
The ID of the Project the Load Balancer is associated with.
Tags []string
List of tags to filter for. Load Balancers with these exact tags are listed.
Zone Changes to this property will trigger replacement. string
zone) The zone in which the Load Balancers exist.
name String
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
projectId Changes to this property will trigger replacement. String
The ID of the Project the Load Balancer is associated with.
tags List<String>
List of tags to filter for. Load Balancers with these exact tags are listed.
zone Changes to this property will trigger replacement. String
zone) The zone in which the Load Balancers exist.
name string
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
projectId Changes to this property will trigger replacement. string
The ID of the Project the Load Balancer is associated with.
tags string[]
List of tags to filter for. Load Balancers with these exact tags are listed.
zone Changes to this property will trigger replacement. string
zone) The zone in which the Load Balancers exist.
name str
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
project_id Changes to this property will trigger replacement. str
The ID of the Project the Load Balancer is associated with.
tags Sequence[str]
List of tags to filter for. Load Balancers with these exact tags are listed.
zone Changes to this property will trigger replacement. str
zone) The zone in which the Load Balancers exist.
name String
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
projectId Changes to this property will trigger replacement. String
The ID of the Project the Load Balancer is associated with.
tags List<String>
List of tags to filter for. Load Balancers with these exact tags are listed.
zone Changes to this property will trigger replacement. String
zone) The zone in which the Load Balancers exist.

getLoadBalancers Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Lbs List<Pulumiverse.Scaleway.Loadbalancers.Outputs.GetLoadBalancersLb>
List of retrieved Load Balancers
OrganizationId string
The ID of the Organization the Load Balancer is associated with.
ProjectId string
The ID of the Project the Load Balancer is associated with.
Zone string
The zone of the Load Balancer.
Name string
The name of the Load Balancer.
Tags List<string>
The tags associated with the Load Balancer.
Id string
The provider-assigned unique ID for this managed resource.
Lbs []GetLoadBalancersLb
List of retrieved Load Balancers
OrganizationId string
The ID of the Organization the Load Balancer is associated with.
ProjectId string
The ID of the Project the Load Balancer is associated with.
Zone string
The zone of the Load Balancer.
Name string
The name of the Load Balancer.
Tags []string
The tags associated with the Load Balancer.
id String
The provider-assigned unique ID for this managed resource.
lbs List<GetLoadBalancersLb>
List of retrieved Load Balancers
organizationId String
The ID of the Organization the Load Balancer is associated with.
projectId String
The ID of the Project the Load Balancer is associated with.
zone String
The zone of the Load Balancer.
name String
The name of the Load Balancer.
tags List<String>
The tags associated with the Load Balancer.
id string
The provider-assigned unique ID for this managed resource.
lbs GetLoadBalancersLb[]
List of retrieved Load Balancers
organizationId string
The ID of the Organization the Load Balancer is associated with.
projectId string
The ID of the Project the Load Balancer is associated with.
zone string
The zone of the Load Balancer.
name string
The name of the Load Balancer.
tags string[]
The tags associated with the Load Balancer.
id str
The provider-assigned unique ID for this managed resource.
lbs Sequence[GetLoadBalancersLb]
List of retrieved Load Balancers
organization_id str
The ID of the Organization the Load Balancer is associated with.
project_id str
The ID of the Project the Load Balancer is associated with.
zone str
The zone of the Load Balancer.
name str
The name of the Load Balancer.
tags Sequence[str]
The tags associated with the Load Balancer.
id String
The provider-assigned unique ID for this managed resource.
lbs List<Property Map>
List of retrieved Load Balancers
organizationId String
The ID of the Organization the Load Balancer is associated with.
projectId String
The ID of the Project the Load Balancer is associated with.
zone String
The zone of the Load Balancer.
name String
The name of the Load Balancer.
tags List<String>
The tags associated with the Load Balancer.

Supporting Types

GetLoadBalancersLb

BackendCount This property is required. int
Number of backends the Load Balancer has.
CreatedAt This property is required. string
Date on which the Load Balancer was created.
Description This property is required. string
The description of the Load Balancer.
FrontendCount This property is required. int
Number of frontends the Load Balancer has.
Id This property is required. string
The ID of the Load Balancer.
Instances This property is required. List<Pulumiverse.Scaleway.Loadbalancers.Inputs.GetLoadBalancersLbInstance>
List of underlying Instances.
Ips This property is required. List<Pulumiverse.Scaleway.Loadbalancers.Inputs.GetLoadBalancersLbIp>
List of IPs attached to the Load Balancer.
Name This property is required. string
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
OrganizationId This property is required. string
The ID of the Organization the Load Balancer is associated with.
PrivateNetworkCount This property is required. int
Number of Private Networks attached to the Load balancer.
ProjectId This property is required. string
The ID of the Project the Load Balancer is associated with.
RouteCount This property is required. int
Number of routes the Load balancer has.
SslCompatibilityLevel This property is required. string
Determines the minimal SSL version which needs to be supported on the client side.
Status This property is required. string
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
Subscriber This property is required. string
The subscriber information.
Tags This property is required. List<string>
List of tags to filter for. Load Balancers with these exact tags are listed.
Type This property is required. string
The offer type of the Load Balancer.
UpdatedAt This property is required. string
Date on which the Load Balancer was updated.
Zone This property is required. string
zone) The zone in which the Load Balancers exist.
BackendCount This property is required. int
Number of backends the Load Balancer has.
CreatedAt This property is required. string
Date on which the Load Balancer was created.
Description This property is required. string
The description of the Load Balancer.
FrontendCount This property is required. int
Number of frontends the Load Balancer has.
Id This property is required. string
The ID of the Load Balancer.
Instances This property is required. []GetLoadBalancersLbInstance
List of underlying Instances.
Ips This property is required. []GetLoadBalancersLbIp
List of IPs attached to the Load Balancer.
Name This property is required. string
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
OrganizationId This property is required. string
The ID of the Organization the Load Balancer is associated with.
PrivateNetworkCount This property is required. int
Number of Private Networks attached to the Load balancer.
ProjectId This property is required. string
The ID of the Project the Load Balancer is associated with.
RouteCount This property is required. int
Number of routes the Load balancer has.
SslCompatibilityLevel This property is required. string
Determines the minimal SSL version which needs to be supported on the client side.
Status This property is required. string
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
Subscriber This property is required. string
The subscriber information.
Tags This property is required. []string
List of tags to filter for. Load Balancers with these exact tags are listed.
Type This property is required. string
The offer type of the Load Balancer.
UpdatedAt This property is required. string
Date on which the Load Balancer was updated.
Zone This property is required. string
zone) The zone in which the Load Balancers exist.
backendCount This property is required. Integer
Number of backends the Load Balancer has.
createdAt This property is required. String
Date on which the Load Balancer was created.
description This property is required. String
The description of the Load Balancer.
frontendCount This property is required. Integer
Number of frontends the Load Balancer has.
id This property is required. String
The ID of the Load Balancer.
instances This property is required. List<GetLoadBalancersLbInstance>
List of underlying Instances.
ips This property is required. List<GetLoadBalancersLbIp>
List of IPs attached to the Load Balancer.
name This property is required. String
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
organizationId This property is required. String
The ID of the Organization the Load Balancer is associated with.
privateNetworkCount This property is required. Integer
Number of Private Networks attached to the Load balancer.
projectId This property is required. String
The ID of the Project the Load Balancer is associated with.
routeCount This property is required. Integer
Number of routes the Load balancer has.
sslCompatibilityLevel This property is required. String
Determines the minimal SSL version which needs to be supported on the client side.
status This property is required. String
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
subscriber This property is required. String
The subscriber information.
tags This property is required. List<String>
List of tags to filter for. Load Balancers with these exact tags are listed.
type This property is required. String
The offer type of the Load Balancer.
updatedAt This property is required. String
Date on which the Load Balancer was updated.
zone This property is required. String
zone) The zone in which the Load Balancers exist.
backendCount This property is required. number
Number of backends the Load Balancer has.
createdAt This property is required. string
Date on which the Load Balancer was created.
description This property is required. string
The description of the Load Balancer.
frontendCount This property is required. number
Number of frontends the Load Balancer has.
id This property is required. string
The ID of the Load Balancer.
instances This property is required. GetLoadBalancersLbInstance[]
List of underlying Instances.
ips This property is required. GetLoadBalancersLbIp[]
List of IPs attached to the Load Balancer.
name This property is required. string
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
organizationId This property is required. string
The ID of the Organization the Load Balancer is associated with.
privateNetworkCount This property is required. number
Number of Private Networks attached to the Load balancer.
projectId This property is required. string
The ID of the Project the Load Balancer is associated with.
routeCount This property is required. number
Number of routes the Load balancer has.
sslCompatibilityLevel This property is required. string
Determines the minimal SSL version which needs to be supported on the client side.
status This property is required. string
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
subscriber This property is required. string
The subscriber information.
tags This property is required. string[]
List of tags to filter for. Load Balancers with these exact tags are listed.
type This property is required. string
The offer type of the Load Balancer.
updatedAt This property is required. string
Date on which the Load Balancer was updated.
zone This property is required. string
zone) The zone in which the Load Balancers exist.
backend_count This property is required. int
Number of backends the Load Balancer has.
created_at This property is required. str
Date on which the Load Balancer was created.
description This property is required. str
The description of the Load Balancer.
frontend_count This property is required. int
Number of frontends the Load Balancer has.
id This property is required. str
The ID of the Load Balancer.
instances This property is required. Sequence[GetLoadBalancersLbInstance]
List of underlying Instances.
ips This property is required. Sequence[GetLoadBalancersLbIp]
List of IPs attached to the Load Balancer.
name This property is required. str
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
organization_id This property is required. str
The ID of the Organization the Load Balancer is associated with.
private_network_count This property is required. int
Number of Private Networks attached to the Load balancer.
project_id This property is required. str
The ID of the Project the Load Balancer is associated with.
route_count This property is required. int
Number of routes the Load balancer has.
ssl_compatibility_level This property is required. str
Determines the minimal SSL version which needs to be supported on the client side.
status This property is required. str
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
subscriber This property is required. str
The subscriber information.
tags This property is required. Sequence[str]
List of tags to filter for. Load Balancers with these exact tags are listed.
type This property is required. str
The offer type of the Load Balancer.
updated_at This property is required. str
Date on which the Load Balancer was updated.
zone This property is required. str
zone) The zone in which the Load Balancers exist.
backendCount This property is required. Number
Number of backends the Load Balancer has.
createdAt This property is required. String
Date on which the Load Balancer was created.
description This property is required. String
The description of the Load Balancer.
frontendCount This property is required. Number
Number of frontends the Load Balancer has.
id This property is required. String
The ID of the Load Balancer.
instances This property is required. List<Property Map>
List of underlying Instances.
ips This property is required. List<Property Map>
List of IPs attached to the Load Balancer.
name This property is required. String
The Load Balancer name to filter for. Load Balancers with a matching name are listed.
organizationId This property is required. String
The ID of the Organization the Load Balancer is associated with.
privateNetworkCount This property is required. Number
Number of Private Networks attached to the Load balancer.
projectId This property is required. String
The ID of the Project the Load Balancer is associated with.
routeCount This property is required. Number
Number of routes the Load balancer has.
sslCompatibilityLevel This property is required. String
Determines the minimal SSL version which needs to be supported on the client side.
status This property is required. String
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
subscriber This property is required. String
The subscriber information.
tags This property is required. List<String>
List of tags to filter for. Load Balancers with these exact tags are listed.
type This property is required. String
The offer type of the Load Balancer.
updatedAt This property is required. String
Date on which the Load Balancer was updated.
zone This property is required. String
zone) The zone in which the Load Balancers exist.

GetLoadBalancersLbInstance

CreatedAt This property is required. string
Date on which the Load Balancer was created.
Id This property is required. string
The ID of the Load Balancer.
IpAddress This property is required. string
Status This property is required. string
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
UpdatedAt This property is required. string
Date on which the Load Balancer was updated.
Zone This property is required. string
zone) The zone in which the Load Balancers exist.
CreatedAt This property is required. string
Date on which the Load Balancer was created.
Id This property is required. string
The ID of the Load Balancer.
IpAddress This property is required. string
Status This property is required. string
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
UpdatedAt This property is required. string
Date on which the Load Balancer was updated.
Zone This property is required. string
zone) The zone in which the Load Balancers exist.
createdAt This property is required. String
Date on which the Load Balancer was created.
id This property is required. String
The ID of the Load Balancer.
ipAddress This property is required. String
status This property is required. String
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
updatedAt This property is required. String
Date on which the Load Balancer was updated.
zone This property is required. String
zone) The zone in which the Load Balancers exist.
createdAt This property is required. string
Date on which the Load Balancer was created.
id This property is required. string
The ID of the Load Balancer.
ipAddress This property is required. string
status This property is required. string
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
updatedAt This property is required. string
Date on which the Load Balancer was updated.
zone This property is required. string
zone) The zone in which the Load Balancers exist.
created_at This property is required. str
Date on which the Load Balancer was created.
id This property is required. str
The ID of the Load Balancer.
ip_address This property is required. str
status This property is required. str
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
updated_at This property is required. str
Date on which the Load Balancer was updated.
zone This property is required. str
zone) The zone in which the Load Balancers exist.
createdAt This property is required. String
Date on which the Load Balancer was created.
id This property is required. String
The ID of the Load Balancer.
ipAddress This property is required. String
status This property is required. String
The state of the Load Balancer Instance. Possible values are: unknown, ready, pending, stopped, error, locked and migrating.
updatedAt This property is required. String
Date on which the Load Balancer was updated.
zone This property is required. String
zone) The zone in which the Load Balancers exist.

GetLoadBalancersLbIp

Id This property is required. string
The ID of the Load Balancer.
IpAddress This property is required. string
LbId This property is required. string
OrganizationId This property is required. string
The ID of the Organization the Load Balancer is associated with.
ProjectId This property is required. string
The ID of the Project the Load Balancer is associated with.
Reverse This property is required. string
Zone This property is required. string
zone) The zone in which the Load Balancers exist.
Id This property is required. string
The ID of the Load Balancer.
IpAddress This property is required. string
LbId This property is required. string
OrganizationId This property is required. string
The ID of the Organization the Load Balancer is associated with.
ProjectId This property is required. string
The ID of the Project the Load Balancer is associated with.
Reverse This property is required. string
Zone This property is required. string
zone) The zone in which the Load Balancers exist.
id This property is required. String
The ID of the Load Balancer.
ipAddress This property is required. String
lbId This property is required. String
organizationId This property is required. String
The ID of the Organization the Load Balancer is associated with.
projectId This property is required. String
The ID of the Project the Load Balancer is associated with.
reverse This property is required. String
zone This property is required. String
zone) The zone in which the Load Balancers exist.
id This property is required. string
The ID of the Load Balancer.
ipAddress This property is required. string
lbId This property is required. string
organizationId This property is required. string
The ID of the Organization the Load Balancer is associated with.
projectId This property is required. string
The ID of the Project the Load Balancer is associated with.
reverse This property is required. string
zone This property is required. string
zone) The zone in which the Load Balancers exist.
id This property is required. str
The ID of the Load Balancer.
ip_address This property is required. str
lb_id This property is required. str
organization_id This property is required. str
The ID of the Organization the Load Balancer is associated with.
project_id This property is required. str
The ID of the Project the Load Balancer is associated with.
reverse This property is required. str
zone This property is required. str
zone) The zone in which the Load Balancers exist.
id This property is required. String
The ID of the Load Balancer.
ipAddress This property is required. String
lbId This property is required. String
organizationId This property is required. String
The ID of the Organization the Load Balancer is associated with.
projectId This property is required. String
The ID of the Project the Load Balancer is associated with.
reverse This property is required. String
zone This property is required. String
zone) The zone in which the Load Balancers exist.

Package Details

Repository
scaleway pulumiverse/pulumi-scaleway
License
Apache-2.0
Notes
This Pulumi package is based on the scaleway Terraform Provider.
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse