1. Packages
  2. Outscale Provider
  3. API Docs
  4. getLoadBalancerVmHealth
outscale 1.3.0-alpha.1 published on Tuesday, Sep 30, 2025 by outscale

outscale.getLoadBalancerVmHealth

Get Started
outscale logo
outscale 1.3.0-alpha.1 published on Tuesday, Sep 30, 2025 by outscale

    Provides information about the health of one or more backend VMs registered with a specific load balancer.

    For more information on this resource, see the User Guide.
    For more information on this resource actions, see the API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as outscale from "@pulumi/outscale";
    
    const loadBalancerVmHealth01 = outscale.getLoadBalancerVmHealth({
        backendVmIds: [
            "i-12345678",
            "i-87654321",
        ],
        loadBalancerName: "load_balancer01",
    });
    
    import pulumi
    import pulumi_outscale as outscale
    
    load_balancer_vm_health01 = outscale.get_load_balancer_vm_health(backend_vm_ids=[
            "i-12345678",
            "i-87654321",
        ],
        load_balancer_name="load_balancer01")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/outscale/outscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := outscale.GetLoadBalancerVmHealth(ctx, &outscale.GetLoadBalancerVmHealthArgs{
    			BackendVmIds: []string{
    				"i-12345678",
    				"i-87654321",
    			},
    			LoadBalancerName: "load_balancer01",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Outscale = Pulumi.Outscale;
    
    return await Deployment.RunAsync(() => 
    {
        var loadBalancerVmHealth01 = Outscale.GetLoadBalancerVmHealth.Invoke(new()
        {
            BackendVmIds = new[]
            {
                "i-12345678",
                "i-87654321",
            },
            LoadBalancerName = "load_balancer01",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.outscale.OutscaleFunctions;
    import com.pulumi.outscale.inputs.GetLoadBalancerVmHealthArgs;
    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 loadBalancerVmHealth01 = OutscaleFunctions.getLoadBalancerVmHealth(GetLoadBalancerVmHealthArgs.builder()
                .backendVmIds(            
                    "i-12345678",
                    "i-87654321")
                .loadBalancerName("load_balancer01")
                .build());
    
        }
    }
    
    variables:
      loadBalancerVmHealth01:
        fn::invoke:
          function: outscale:getLoadBalancerVmHealth
          arguments:
            backendVmIds:
              - i-12345678
              - i-87654321
            loadBalancerName: load_balancer01
    

    Using getLoadBalancerVmHealth

    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 getLoadBalancerVmHealth(args: GetLoadBalancerVmHealthArgs, opts?: InvokeOptions): Promise<GetLoadBalancerVmHealthResult>
    function getLoadBalancerVmHealthOutput(args: GetLoadBalancerVmHealthOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerVmHealthResult>
    def get_load_balancer_vm_health(backend_vm_ids: Optional[Sequence[str]] = None,
                                    filters: Optional[Sequence[GetLoadBalancerVmHealthFilter]] = None,
                                    id: Optional[str] = None,
                                    load_balancer_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetLoadBalancerVmHealthResult
    def get_load_balancer_vm_health_output(backend_vm_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                    filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLoadBalancerVmHealthFilterArgs]]]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    load_balancer_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerVmHealthResult]
    func GetLoadBalancerVmHealth(ctx *Context, args *GetLoadBalancerVmHealthArgs, opts ...InvokeOption) (*GetLoadBalancerVmHealthResult, error)
    func GetLoadBalancerVmHealthOutput(ctx *Context, args *GetLoadBalancerVmHealthOutputArgs, opts ...InvokeOption) GetLoadBalancerVmHealthResultOutput

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

    public static class GetLoadBalancerVmHealth 
    {
        public static Task<GetLoadBalancerVmHealthResult> InvokeAsync(GetLoadBalancerVmHealthArgs args, InvokeOptions? opts = null)
        public static Output<GetLoadBalancerVmHealthResult> Invoke(GetLoadBalancerVmHealthInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLoadBalancerVmHealthResult> getLoadBalancerVmHealth(GetLoadBalancerVmHealthArgs args, InvokeOptions options)
    public static Output<GetLoadBalancerVmHealthResult> getLoadBalancerVmHealth(GetLoadBalancerVmHealthArgs args, InvokeOptions options)
    
    fn::invoke:
      function: outscale:index/getLoadBalancerVmHealth:getLoadBalancerVmHealth
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LoadBalancerName string
    The name of the load balancer.
    BackendVmIds List<string>
    One or more IDs of backend VMs.
    Filters List<GetLoadBalancerVmHealthFilter>
    Id string
    LoadBalancerName string
    The name of the load balancer.
    BackendVmIds []string
    One or more IDs of backend VMs.
    Filters []GetLoadBalancerVmHealthFilter
    Id string
    loadBalancerName String
    The name of the load balancer.
    backendVmIds List<String>
    One or more IDs of backend VMs.
    filters List<GetLoadBalancerVmHealthFilter>
    id String
    loadBalancerName string
    The name of the load balancer.
    backendVmIds string[]
    One or more IDs of backend VMs.
    filters GetLoadBalancerVmHealthFilter[]
    id string
    load_balancer_name str
    The name of the load balancer.
    backend_vm_ids Sequence[str]
    One or more IDs of backend VMs.
    filters Sequence[GetLoadBalancerVmHealthFilter]
    id str
    loadBalancerName String
    The name of the load balancer.
    backendVmIds List<String>
    One or more IDs of backend VMs.
    filters List<Property Map>
    id String

    getLoadBalancerVmHealth Result

    The following output properties are available:

    backendVmHealths List<Property Map>
    Information about the health of one or more backend VMs.
    id String
    loadBalancerName String
    requestId String
    backendVmIds List<String>
    filters List<Property Map>

    Supporting Types

    GetLoadBalancerVmHealthBackendVmHealth

    Description string
    The description of the state of the backend VM.
    State string
    The state of the backend VM (InService | OutOfService | Unknown).
    StateReason string
    Information about the cause of OutOfService VMs. Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
    VmId string
    The ID of the backend VM.
    Description string
    The description of the state of the backend VM.
    State string
    The state of the backend VM (InService | OutOfService | Unknown).
    StateReason string
    Information about the cause of OutOfService VMs. Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
    VmId string
    The ID of the backend VM.
    description String
    The description of the state of the backend VM.
    state String
    The state of the backend VM (InService | OutOfService | Unknown).
    stateReason String
    Information about the cause of OutOfService VMs. Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
    vmId String
    The ID of the backend VM.
    description string
    The description of the state of the backend VM.
    state string
    The state of the backend VM (InService | OutOfService | Unknown).
    stateReason string
    Information about the cause of OutOfService VMs. Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
    vmId string
    The ID of the backend VM.
    description str
    The description of the state of the backend VM.
    state str
    The state of the backend VM (InService | OutOfService | Unknown).
    state_reason str
    Information about the cause of OutOfService VMs. Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
    vm_id str
    The ID of the backend VM.
    description String
    The description of the state of the backend VM.
    state String
    The state of the backend VM (InService | OutOfService | Unknown).
    stateReason String
    Information about the cause of OutOfService VMs. Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
    vmId String
    The ID of the backend VM.

    GetLoadBalancerVmHealthFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.3.0-alpha.1 published on Tuesday, Sep 30, 2025 by outscale
      Meet Neo: Your AI Platform Teammate