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

ibm.getPiVolumeSnapshot

Explore with Pulumi AI

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

    Retrieve information about a volume snapshot.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    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.GetPiVolumeSnapshotArgs;
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 snapshot = IbmFunctions.getPiVolumeSnapshot(GetPiVolumeSnapshotArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .piSnapshotId("snapshot_id")
            .build());

    }
}

    variables:
  snapshot:
    fn::invoke:
      function: ibm:getPiVolumeSnapshot
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>
        piSnapshotId: snapshot_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 getPiVolumeSnapshot

    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 getPiVolumeSnapshot(args: GetPiVolumeSnapshotArgs, opts?: InvokeOptions): Promise<GetPiVolumeSnapshotResult>
function getPiVolumeSnapshotOutput(args: GetPiVolumeSnapshotOutputArgs, opts?: InvokeOptions): Output<GetPiVolumeSnapshotResult>
    def get_pi_volume_snapshot(id: Optional[str] = None,
                           pi_cloud_instance_id: Optional[str] = None,
                           pi_volume_snapshot_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPiVolumeSnapshotResult
def get_pi_volume_snapshot_output(id: Optional[pulumi.Input[str]] = None,
                           pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                           pi_volume_snapshot_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPiVolumeSnapshotResult]
    func GetPiVolumeSnapshot(ctx *Context, args *GetPiVolumeSnapshotArgs, opts ...InvokeOption) (*GetPiVolumeSnapshotResult, error)
func GetPiVolumeSnapshotOutput(ctx *Context, args *GetPiVolumeSnapshotOutputArgs, opts ...InvokeOption) GetPiVolumeSnapshotResultOutput

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

    public static class GetPiVolumeSnapshot 
{
    public static Task<GetPiVolumeSnapshotResult> InvokeAsync(GetPiVolumeSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetPiVolumeSnapshotResult> Invoke(GetPiVolumeSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiVolumeSnapshotResult> getPiVolumeSnapshot(GetPiVolumeSnapshotArgs args, InvokeOptions options)
public static Output<GetPiVolumeSnapshotResult> getPiVolumeSnapshot(GetPiVolumeSnapshotArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeSnapshotId string
    Id string
    (String) The unique identifier of the volume snapshot.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiVolumeSnapshotId string
    Id string
    (String) The unique identifier of the volume snapshot.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeSnapshotId String
    id String
    (String) The unique identifier of the volume snapshot.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piVolumeSnapshotId string
    id string
    (String) The unique identifier of the volume snapshot.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_volume_snapshot_id str
    id str
    (String) The unique identifier of the volume snapshot.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piVolumeSnapshotId String
    id String
    (String) The unique identifier of the volume snapshot.

    getPiVolumeSnapshot Result

    The following output properties are available:

    CreationDate string
    (String) The date and time when the volume snapshot was created.
    Crn string
    (Deprecated, String) The CRN for this resource.

    Deprecated: Deprecated

    Id string
    (String) The unique identifier of the volume snapshot.
    Name string
    (String) The volume snapshot name.
    PiCloudInstanceId string
    PiVolumeSnapshotId string
    Size double
    (Float) The size of the volume snapshot, in gibibytes (GiB).
    Status string
    (String) The status for the volume snapshot.
    UpdatedDate string
    (String) The date and time when the volume snapshot was last updated.
    VolumeId string
    (String) The volume UUID associated with the snapshot.
    CreationDate string
    (String) The date and time when the volume snapshot was created.
    Crn string
    (Deprecated, String) The CRN for this resource.

    Deprecated: Deprecated

    Id string
    (String) The unique identifier of the volume snapshot.
    Name string
    (String) The volume snapshot name.
    PiCloudInstanceId string
    PiVolumeSnapshotId string
    Size float64
    (Float) The size of the volume snapshot, in gibibytes (GiB).
    Status string
    (String) The status for the volume snapshot.
    UpdatedDate string
    (String) The date and time when the volume snapshot was last updated.
    VolumeId string
    (String) The volume UUID associated with the snapshot.
    creationDate String
    (String) The date and time when the volume snapshot was created.
    crn String
    (Deprecated, String) The CRN for this resource.

    Deprecated: Deprecated

    id String
    (String) The unique identifier of the volume snapshot.
    name String
    (String) The volume snapshot name.
    piCloudInstanceId String
    piVolumeSnapshotId String
    size Double
    (Float) The size of the volume snapshot, in gibibytes (GiB).
    status String
    (String) The status for the volume snapshot.
    updatedDate String
    (String) The date and time when the volume snapshot was last updated.
    volumeId String
    (String) The volume UUID associated with the snapshot.
    creationDate string
    (String) The date and time when the volume snapshot was created.
    crn string
    (Deprecated, String) The CRN for this resource.

    Deprecated: Deprecated

    id string
    (String) The unique identifier of the volume snapshot.
    name string
    (String) The volume snapshot name.
    piCloudInstanceId string
    piVolumeSnapshotId string
    size number
    (Float) The size of the volume snapshot, in gibibytes (GiB).
    status string
    (String) The status for the volume snapshot.
    updatedDate string
    (String) The date and time when the volume snapshot was last updated.
    volumeId string
    (String) The volume UUID associated with the snapshot.
    creation_date str
    (String) The date and time when the volume snapshot was created.
    crn str
    (Deprecated, String) The CRN for this resource.

    Deprecated: Deprecated

    id str
    (String) The unique identifier of the volume snapshot.
    name str
    (String) The volume snapshot name.
    pi_cloud_instance_id str
    pi_volume_snapshot_id str
    size float
    (Float) The size of the volume snapshot, in gibibytes (GiB).
    status str
    (String) The status for the volume snapshot.
    updated_date str
    (String) The date and time when the volume snapshot was last updated.
    volume_id str
    (String) The volume UUID associated with the snapshot.
    creationDate String
    (String) The date and time when the volume snapshot was created.
    crn String
    (Deprecated, String) The CRN for this resource.

    Deprecated: Deprecated

    id String
    (String) The unique identifier of the volume snapshot.
    name String
    (String) The volume snapshot name.
    piCloudInstanceId String
    piVolumeSnapshotId String
    size Number
    (Float) The size of the volume snapshot, in gibibytes (GiB).
    status String
    (String) The status for the volume snapshot.
    updatedDate String
    (String) The date and time when the volume snapshot was last updated.
    volumeId String
    (String) The volume UUID associated with the snapshot.

    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