1. Packages
  2. Gcore Provider
  3. API Docs
  4. getLoadbalancer
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

gcore.getLoadbalancer

Explore with Pulumi AI

gcore logo
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const project = gcore.getProject({
        name: "Default",
    });
    const region = gcore.getRegion({
        name: "Luxembourg-2",
    });
    const lb = Promise.all([region, project]).then(([region, project]) => gcore.getLoadbalancer({
        regionId: region.id,
        projectId: project.id,
        name: "test-lb",
    }));
    export const view = lb;
    
    import pulumi
    import pulumi_gcore as gcore
    
    project = gcore.get_project(name="Default")
    region = gcore.get_region(name="Luxembourg-2")
    lb = gcore.get_loadbalancer(region_id=region.id,
        project_id=project.id,
        name="test-lb")
    pulumi.export("view", lb)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
    			Name: "Default",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		region, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
    			Name: "Luxembourg-2",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		lb, err := gcore.LookupLoadbalancer(ctx, &gcore.LookupLoadbalancerArgs{
    			RegionId:  pulumi.Float64Ref(region.Id),
    			ProjectId: pulumi.Float64Ref(project.Id),
    			Name:      "test-lb",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("view", lb)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var project = Gcore.GetProject.Invoke(new()
        {
            Name = "Default",
        });
    
        var region = Gcore.GetRegion.Invoke(new()
        {
            Name = "Luxembourg-2",
        });
    
        var lb = Gcore.GetLoadbalancer.Invoke(new()
        {
            RegionId = region.Apply(getRegionResult => getRegionResult.Id),
            ProjectId = project.Apply(getProjectResult => getProjectResult.Id),
            Name = "test-lb",
        });
    
        return new Dictionary<string, object?>
        {
            ["view"] = lb,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetProjectArgs;
    import com.pulumi.gcore.inputs.GetRegionArgs;
    import com.pulumi.gcore.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) {
            final var project = GcoreFunctions.getProject(GetProjectArgs.builder()
                .name("Default")
                .build());
    
            final var region = GcoreFunctions.getRegion(GetRegionArgs.builder()
                .name("Luxembourg-2")
                .build());
    
            final var lb = GcoreFunctions.getLoadbalancer(GetLoadbalancerArgs.builder()
                .regionId(region.applyValue(getRegionResult -> getRegionResult.id()))
                .projectId(project.applyValue(getProjectResult -> getProjectResult.id()))
                .name("test-lb")
                .build());
    
            ctx.export("view", lb.applyValue(getLoadbalancerResult -> getLoadbalancerResult));
        }
    }
    
    variables:
      project:
        fn::invoke:
          function: gcore:getProject
          arguments:
            name: Default
      region:
        fn::invoke:
          function: gcore:getRegion
          arguments:
            name: Luxembourg-2
      lb:
        fn::invoke:
          function: gcore:getLoadbalancer
          arguments:
            regionId: ${region.id}
            projectId: ${project.id}
            name: test-lb
    outputs:
      view: ${lb}
    

    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_loadbalancer(id: Optional[str] = None,
                         metadata_k: Optional[str] = None,
                         metadata_kv: Optional[Mapping[str, str]] = None,
                         name: Optional[str] = None,
                         project_id: Optional[float] = None,
                         project_name: Optional[str] = None,
                         region_id: Optional[float] = None,
                         region_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetLoadbalancerResult
    def get_loadbalancer_output(id: Optional[pulumi.Input[str]] = None,
                         metadata_k: Optional[pulumi.Input[str]] = None,
                         metadata_kv: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         project_id: Optional[pulumi.Input[float]] = None,
                         project_name: Optional[pulumi.Input[str]] = None,
                         region_id: Optional[pulumi.Input[float]] = None,
                         region_name: 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: gcore:index/getLoadbalancer:getLoadbalancer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    The ID of this resource.
    MetadataK string
    MetadataKv Dictionary<string, string>
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Name string
    Id string
    The ID of this resource.
    MetadataK string
    MetadataKv map[string]string
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    name String
    id String
    The ID of this resource.
    metadataK String
    metadataKv Map<String,String>
    projectId Double
    projectName String
    regionId Double
    regionName String
    name string
    id string
    The ID of this resource.
    metadataK string
    metadataKv {[key: string]: string}
    projectId number
    projectName string
    regionId number
    regionName string
    name str
    id str
    The ID of this resource.
    metadata_k str
    metadata_kv Mapping[str, str]
    project_id float
    project_name str
    region_id float
    region_name str
    name String
    id String
    The ID of this resource.
    metadataK String
    metadataKv Map<String>
    projectId Number
    projectName String
    regionId Number
    regionName String

    getLoadbalancer Result

    The following output properties are available:

    id string
    The ID of this resource.
    listeners GetLoadbalancerListener[]
    metadataReadOnlies GetLoadbalancerMetadataReadOnly[]
    name string
    vipAddress string
    vipPortId string
    metadataK string
    metadataKv {[key: string]: string}
    projectId number
    projectName string
    regionId number
    regionName string
    id String
    The ID of this resource.
    listeners List<Property Map>
    metadataReadOnlies List<Property Map>
    name String
    vipAddress String
    vipPortId String
    metadataK String
    metadataKv Map<String>
    projectId Number
    projectName String
    regionId Number
    regionName String

    Supporting Types

    GetLoadbalancerListener

    Id string
    Name string
    Protocol string
    ProtocolPort double
    Id string
    Name string
    Protocol string
    ProtocolPort float64
    id String
    name String
    protocol String
    protocolPort Double
    id string
    name string
    protocol string
    protocolPort number
    id str
    name str
    protocol str
    protocol_port float
    id String
    name String
    protocol String
    protocolPort Number

    GetLoadbalancerMetadataReadOnly

    Key string
    ReadOnly bool
    Value string
    Key string
    ReadOnly bool
    Value string
    key String
    readOnly Boolean
    value String
    key string
    readOnly boolean
    value string
    key str
    read_only bool
    value str
    key String
    readOnly Boolean
    value String

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core