getCloudLoadbalancer

OVHCloud v2.21.0, Sep 25 26

Viewing docs for OVHCloud v2.21.0
published on Friday, Sep 25, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Viewing docs for OVHCloud v2.21.0
published on Friday, Sep 25, 2026 by OVHcloud

Schema (JSON)

ovh/pulumi-ovh

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const lb = ovh.getCloudLoadbalancer({
    serviceName: "<public cloud project ID>",
    id: "<load balancer ID>",
});
export const loadbalancerVip = lb.then(lb => lb.currentState?.network?.addresses);

import pulumi
import pulumi_ovh as ovh

lb = ovh.get_cloud_loadbalancer(service_name="<public cloud project ID>",
    id="<load balancer ID>")
pulumi.export("loadbalancerVip", lb.current_state.network.addresses)

package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		lb, err := ovh.LookupCloudLoadbalancer(ctx, &ovh.LookupCloudLoadbalancerArgs{
			ServiceName: "<public cloud project ID>",
			Id:          "<load balancer ID>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("loadbalancerVip", lb.CurrentState.Network.Addresses)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var lb = Ovh.GetCloudLoadbalancer.Invoke(new()
    {
        ServiceName = "<public cloud project ID>",
        Id = "<load balancer ID>",
    });

    return new Dictionary<string, object?>
    {
        ["loadbalancerVip"] = lb.Apply(getCloudLoadbalancerResult => getCloudLoadbalancerResult.CurrentState?.Network?.Addresses),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.OvhFunctions;
import com.pulumi.ovh.inputs.GetCloudLoadbalancerArgs;
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 lb = OvhFunctions.getCloudLoadbalancer(GetCloudLoadbalancerArgs.builder()
            .serviceName("<public cloud project ID>")
            .id("<load balancer ID>")
            .build());

        ctx.export("loadbalancerVip", lb.currentState().network().addresses());
    }
}

variables:
  lb:
    fn::invoke:
      function: ovh:getCloudLoadbalancer
      arguments:
        serviceName: <public cloud project ID>
        id: <load balancer ID>
outputs:
  loadbalancerVip: ${lb.currentState.network.addresses}

Example coming soon!

Using getCloudLoadbalancer

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 getCloudLoadbalancer(args: GetCloudLoadbalancerArgs, opts?: InvokeOptions): Promise<GetCloudLoadbalancerResult>
function getCloudLoadbalancerOutput(args: GetCloudLoadbalancerOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudLoadbalancerResult>

def get_cloud_loadbalancer(id: Optional[str] = None,
                           service_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetCloudLoadbalancerResult
def get_cloud_loadbalancer_output(id: pulumi.Input[Optional[str]] = None,
                           service_name: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudLoadbalancerResult]

func LookupCloudLoadbalancer(ctx *Context, args *LookupCloudLoadbalancerArgs, opts ...InvokeOption) (*LookupCloudLoadbalancerResult, error)
func LookupCloudLoadbalancerOutput(ctx *Context, args *LookupCloudLoadbalancerOutputArgs, opts ...InvokeOption) LookupCloudLoadbalancerResultOutput

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

public static class GetCloudLoadbalancer 
{
    public static Task<GetCloudLoadbalancerResult> InvokeAsync(GetCloudLoadbalancerArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudLoadbalancerResult> Invoke(GetCloudLoadbalancerInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudLoadbalancerResult> Invoke(GetCloudLoadbalancerInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetCloudLoadbalancerResult> getCloudLoadbalancer(GetCloudLoadbalancerArgs args, InvokeOptions options)
public static Output<GetCloudLoadbalancerResult> getCloudLoadbalancer(GetCloudLoadbalancerArgs args, InvokeOptions options)
public static Output<GetCloudLoadbalancerResult> getCloudLoadbalancer(GetCloudLoadbalancerArgs args, InvokeOutputOptions options)

fn::invoke:
  function: ovh:index/getCloudLoadbalancer:getCloudLoadbalancer
  arguments:
    # arguments dictionary

data "ovh_get_cloud_loadbalancer" "name" {
    # arguments
}

The following arguments are supported:

Id string: ID of the load balancer.
ServiceName string: Service name of the resource representing the id of the cloud project.

Id string: ID of the load balancer.
ServiceName string: Service name of the resource representing the id of the cloud project.

id string: ID of the load balancer.
service_name string: Service name of the resource representing the id of the cloud project.

id String: ID of the load balancer.
serviceName String: Service name of the resource representing the id of the cloud project.

id string: ID of the load balancer.
serviceName string: Service name of the resource representing the id of the cloud project.

id str: ID of the load balancer.
service_name str: Service name of the resource representing the id of the cloud project.

id String: ID of the load balancer.
serviceName String: Service name of the resource representing the id of the cloud project.