getPiAvailableHosts

ibm 1.85.0, Nov 9 25

ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Example Usage

The following example shows how to retrieve information using ibm.getPiAvailableHosts.

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const piAvailableHosts = ibm.getPiAvailableHosts({
    piCloudInstanceId: "<value of the cloud_instance_id>",
});

import pulumi
import pulumi_ibm as ibm

pi_available_hosts = ibm.get_pi_available_hosts(pi_cloud_instance_id="<value of the cloud_instance_id>")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetPiAvailableHosts(ctx, &ibm.GetPiAvailableHostsArgs{
			PiCloudInstanceId: "<value of the cloud_instance_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var piAvailableHosts = Ibm.GetPiAvailableHosts.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetPiAvailableHostsArgs;
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 piAvailableHosts = IbmFunctions.getPiAvailableHosts(GetPiAvailableHostsArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

variables:
  piAvailableHosts:
    fn::invoke:
      function: ibm:getPiAvailableHosts
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>

Notes

Please find supported Regions for endpoints.
If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
- region - lon
- zone - lon04

Example usage:

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

import pulumi

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

{}

Using getPiAvailableHosts

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 getPiAvailableHosts(args: GetPiAvailableHostsArgs, opts?: InvokeOptions): Promise<GetPiAvailableHostsResult>
function getPiAvailableHostsOutput(args: GetPiAvailableHostsOutputArgs, opts?: InvokeOptions): Output<GetPiAvailableHostsResult>

def get_pi_available_hosts(id: Optional[str] = None,
                           pi_cloud_instance_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPiAvailableHostsResult
def get_pi_available_hosts_output(id: Optional[pulumi.Input[str]] = None,
                           pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPiAvailableHostsResult]

func GetPiAvailableHosts(ctx *Context, args *GetPiAvailableHostsArgs, opts ...InvokeOption) (*GetPiAvailableHostsResult, error)
func GetPiAvailableHostsOutput(ctx *Context, args *GetPiAvailableHostsOutputArgs, opts ...InvokeOption) GetPiAvailableHostsResultOutput

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

public static class GetPiAvailableHosts 
{
    public static Task<GetPiAvailableHostsResult> InvokeAsync(GetPiAvailableHostsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiAvailableHostsResult> Invoke(GetPiAvailableHostsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPiAvailableHostsResult> getPiAvailableHosts(GetPiAvailableHostsArgs args, InvokeOptions options)
public static Output<GetPiAvailableHostsResult> getPiAvailableHosts(GetPiAvailableHostsArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getPiAvailableHosts:getPiAvailableHosts
  arguments:
    # arguments dictionary

The following arguments are supported:

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string

PiCloudInstanceId string: The GUID of the service instance associated with an account.
Id string

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String

piCloudInstanceId string: The GUID of the service instance associated with an account.
id string

pi_cloud_instance_id str: The GUID of the service instance associated with an account.
id str

piCloudInstanceId String: The GUID of the service instance associated with an account.
id String