Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiVolumeOnboardings
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiVolumeOnboardings

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieves information about volume onboardings. For more information, about managing a volume group, see moving data to the cloud.

    Example Usage

    The following example retrieves information about about volume onboardings in Power Systems Virtual Server.

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

const dsVolumeOnboardings = ibm.getPiVolumeOnboardings({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});

    import pulumi
import pulumi_ibm as ibm

ds_volume_onboardings = ibm.get_pi_volume_onboardings(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")

    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.GetPiVolumeOnboardings(ctx, &ibm.GetPiVolumeOnboardingsArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, 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 dsVolumeOnboardings = Ibm.GetPiVolumeOnboardings.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});

    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.GetPiVolumeOnboardingsArgs;
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 dsVolumeOnboardings = IbmFunctions.getPiVolumeOnboardings(GetPiVolumeOnboardingsArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

    variables:
  dsVolumeOnboardings:
    fn::invoke:
      function: ibm:getPiVolumeOnboardings
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b

    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 getPiVolumeOnboardings

    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 getPiVolumeOnboardings(args: GetPiVolumeOnboardingsArgs, opts?: InvokeOptions): Promise<GetPiVolumeOnboardingsResult>
function getPiVolumeOnboardingsOutput(args: GetPiVolumeOnboardingsOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeOnboardingsResult>
    def get_pi_volume_onboardings(id: Optional[str] = None,
                              pi_cloud_instance_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPiVolumeOnboardingsResult
def get_pi_volume_onboardings_output(id: Optional[pulumi.Input[str]] = None,
                              pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeOnboardingsResult]
    func GetPiVolumeOnboardings(ctx *Context, args *GetPiVolumeOnboardingsArgs, opts ...InvokeOption) (*GetPiVolumeOnboardingsResult, error)
func GetPiVolumeOnboardingsOutput(ctx *Context, args *GetPiVolumeOnboardingsOutputArgs, opts ...InvokeOption) GetPiVolumeOnboardingsResultOutput

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

    public static class GetPiVolumeOnboardings 
{
    public static Task<GetPiVolumeOnboardingsResult> InvokeAsync(GetPiVolumeOnboardingsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeOnboardingsResult> Invoke(GetPiVolumeOnboardingsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiVolumeOnboardingsResult> getPiVolumeOnboardings(GetPiVolumeOnboardingsArgs args, InvokeOptions options)
public static Output<GetPiVolumeOnboardingsResult> getPiVolumeOnboardings(GetPiVolumeOnboardingsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The type of cycling mode used.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The type of cycling mode used.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The type of cycling mode used.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) The type of cycling mode used.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) The type of cycling mode used.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The type of cycling mode used.

    getPiVolumeOnboardings Result

    The following output properties are available:

    Id string
    (String) The type of cycling mode used.
    Onboardings List<GetPiVolumeOnboardingsOnboarding>
    (List) List of volume onboardings.
    PiCloudInstanceId string
    Id string
    (String) The type of cycling mode used.
    Onboardings []GetPiVolumeOnboardingsOnboarding
    (List) List of volume onboardings.
    PiCloudInstanceId string
    id String
    (String) The type of cycling mode used.
    onboardings List<GetPiVolumeOnboardingsOnboarding>
    (List) List of volume onboardings.
    piCloudInstanceId String
    id string
    (String) The type of cycling mode used.
    onboardings GetPiVolumeOnboardingsOnboarding[]
    (List) List of volume onboardings.
    piCloudInstanceId string
    id str
    (String) The type of cycling mode used.
    onboardings Sequence[GetPiVolumeOnboardingsOnboarding]
    (List) List of volume onboardings.
    pi_cloud_instance_id str
    id String
    (String) The type of cycling mode used.
    onboardings List<Property Map>
    (List) List of volume onboardings.
    piCloudInstanceId String

    Supporting Types

    GetPiVolumeOnboardingsOnboarding

    Description string
    (String) The description of the volume onboarding operation.
    Id string
    (String) The type of cycling mode used.
    InputVolumes List<string>
    (List) List of volumes requested to be onboarded.
    Status string
    (String) The status of volume onboarding operation.
    Description string
    (String) The description of the volume onboarding operation.
    Id string
    (String) The type of cycling mode used.
    InputVolumes []string
    (List) List of volumes requested to be onboarded.
    Status string
    (String) The status of volume onboarding operation.
    description String
    (String) The description of the volume onboarding operation.
    id String
    (String) The type of cycling mode used.
    inputVolumes List<String>
    (List) List of volumes requested to be onboarded.
    status String
    (String) The status of volume onboarding operation.
    description string
    (String) The description of the volume onboarding operation.
    id string
    (String) The type of cycling mode used.
    inputVolumes string[]
    (List) List of volumes requested to be onboarded.
    status string
    (String) The status of volume onboarding operation.
    description str
    (String) The description of the volume onboarding operation.
    id str
    (String) The type of cycling mode used.
    input_volumes Sequence[str]
    (List) List of volumes requested to be onboarded.
    status str
    (String) The status of volume onboarding operation.
    description String
    (String) The description of the volume onboarding operation.
    id String
    (String) The type of cycling mode used.
    inputVolumes List<String>
    (List) List of volumes requested to be onboarded.
    status String
    (String) The status of volume onboarding operation.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm