1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getIsVolumeJob
Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getIsVolumeJob

Viewing docs for ibm 2.1.0
published on Tuesday, May 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about an is_volume_job. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

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

const example = ibm.getIsVolumeJob({
    volumeJobId: exampleIbmIsVolumeJob.volumeJobId,
    volumeId: exampleIbmIsVolumeJob.volumeId,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_volume_job(volume_job_id=example_ibm_is_volume_job["volumeJobId"],
    volume_id=example_ibm_is_volume_job["volumeId"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupIsVolumeJob(ctx, &ibm.LookupIsVolumeJobArgs{
			VolumeJobId: exampleIbmIsVolumeJob.VolumeJobId,
			VolumeId:    exampleIbmIsVolumeJob.VolumeId,
		}, 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 example = Ibm.GetIsVolumeJob.Invoke(new()
    {
        VolumeJobId = exampleIbmIsVolumeJob.VolumeJobId,
        VolumeId = exampleIbmIsVolumeJob.VolumeId,
    });

});

    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.GetIsVolumeJobArgs;
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 example = IbmFunctions.getIsVolumeJob(GetIsVolumeJobArgs.builder()
            .volumeJobId(exampleIbmIsVolumeJob.volumeJobId())
            .volumeId(exampleIbmIsVolumeJob.volumeId())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsVolumeJob
      arguments:
        volumeJobId: ${exampleIbmIsVolumeJob.volumeJobId}
        volumeId: ${exampleIbmIsVolumeJob.volumeId}

    Example coming soon!

    Using getIsVolumeJob

    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 getIsVolumeJob(args: GetIsVolumeJobArgs, opts?: InvokeOptions): Promise<GetIsVolumeJobResult>
function getIsVolumeJobOutput(args: GetIsVolumeJobOutputArgs, opts?: InvokeOptions): Output<GetIsVolumeJobResult>
    def get_is_volume_job(id: Optional[str] = None,
                      volume_id: Optional[str] = None,
                      volume_job_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIsVolumeJobResult
def get_is_volume_job_output(id: pulumi.Input[Optional[str]] = None,
                      volume_id: pulumi.Input[Optional[str]] = None,
                      volume_job_id: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIsVolumeJobResult]
    func LookupIsVolumeJob(ctx *Context, args *LookupIsVolumeJobArgs, opts ...InvokeOption) (*LookupIsVolumeJobResult, error)
func LookupIsVolumeJobOutput(ctx *Context, args *LookupIsVolumeJobOutputArgs, opts ...InvokeOption) LookupIsVolumeJobResultOutput

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

    public static class GetIsVolumeJob 
{
    public static Task<GetIsVolumeJobResult> InvokeAsync(GetIsVolumeJobArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVolumeJobResult> Invoke(GetIsVolumeJobInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVolumeJobResult> getIsVolumeJob(GetIsVolumeJobArgs args, InvokeOptions options)
public static Output<GetIsVolumeJobResult> getIsVolumeJob(GetIsVolumeJobArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsVolumeJob:getIsVolumeJob
  arguments:
    # arguments dictionary
    data "ibm_getisvolumejob" "name" {
    # arguments
}

    The following arguments are supported:

    VolumeId string
    The volume identifier.
    VolumeJobId string
    The volume job identifier.
    Id string
    The unique identifier of the is_volume_job.
    VolumeId string
    The volume identifier.
    VolumeJobId string
    The volume job identifier.
    Id string
    The unique identifier of the is_volume_job.
    volume_id string
    The volume identifier.
    volume_job_id string
    The volume job identifier.
    id string
    The unique identifier of the is_volume_job.
    volumeId String
    The volume identifier.
    volumeJobId String
    The volume job identifier.
    id String
    The unique identifier of the is_volume_job.
    volumeId string
    The volume identifier.
    volumeJobId string
    The volume job identifier.
    id string
    The unique identifier of the is_volume_job.
    volume_id str
    The volume identifier.
    volume_job_id str
    The volume job identifier.
    id str
    The unique identifier of the is_volume_job.
    volumeId String
    The volume identifier.
    volumeJobId String
    The volume job identifier.
    id String
    The unique identifier of the is_volume_job.

    getIsVolumeJob Result

    The following output properties are available:

    AutoDelete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    CompletedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    CreatedAt string
    (String) The date and time that the volume job was created.
    EstimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    Href string
    (String) The URL for this volume profile.
    Id string
    The unique identifier of the is_volume_job.
    JobType string
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    Name string
    (String) The globally unique name for this volume profile.
    Parameters List<GetIsVolumeJobParameter>
    (List) The parameters to use after the volume is migrated.
    ResourceType string
    (String) The resource type.
    StartedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    Status string
    (String) The status of this volume job:
    StatusReasons List<GetIsVolumeJobStatusReason>
    (List) The reasons for the current status (if any).
    VolumeId string
    VolumeJobId string
    AutoDelete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    CompletedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    CreatedAt string
    (String) The date and time that the volume job was created.
    EstimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    Href string
    (String) The URL for this volume profile.
    Id string
    The unique identifier of the is_volume_job.
    JobType string
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    Name string
    (String) The globally unique name for this volume profile.
    Parameters []GetIsVolumeJobParameter
    (List) The parameters to use after the volume is migrated.
    ResourceType string
    (String) The resource type.
    StartedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    Status string
    (String) The status of this volume job:
    StatusReasons []GetIsVolumeJobStatusReason
    (List) The reasons for the current status (if any).
    VolumeId string
    VolumeJobId string
    auto_delete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completed_at string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    created_at string
    (String) The date and time that the volume job was created.
    estimated_completion_at string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href string
    (String) The URL for this volume profile.
    id string
    The unique identifier of the is_volume_job.
    job_type string
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    name string
    (String) The globally unique name for this volume profile.
    parameters list(object)
    (List) The parameters to use after the volume is migrated.
    resource_type string
    (String) The resource type.
    started_at string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status string
    (String) The status of this volume job:
    status_reasons list(object)
    (List) The reasons for the current status (if any).
    volume_id string
    volume_job_id string
    autoDelete Boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt String
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt String
    (String) The date and time that the volume job was created.
    estimatedCompletionAt String
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href String
    (String) The URL for this volume profile.
    id String
    The unique identifier of the is_volume_job.
    jobType String
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    name String
    (String) The globally unique name for this volume profile.
    parameters List<GetIsVolumeJobParameter>
    (List) The parameters to use after the volume is migrated.
    resourceType String
    (String) The resource type.
    startedAt String
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status String
    (String) The status of this volume job:
    statusReasons List<GetIsVolumeJobStatusReason>
    (List) The reasons for the current status (if any).
    volumeId String
    volumeJobId String
    autoDelete boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt string
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt string
    (String) The date and time that the volume job was created.
    estimatedCompletionAt string
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href string
    (String) The URL for this volume profile.
    id string
    The unique identifier of the is_volume_job.
    jobType string
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    name string
    (String) The globally unique name for this volume profile.
    parameters GetIsVolumeJobParameter[]
    (List) The parameters to use after the volume is migrated.
    resourceType string
    (String) The resource type.
    startedAt string
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status string
    (String) The status of this volume job:
    statusReasons GetIsVolumeJobStatusReason[]
    (List) The reasons for the current status (if any).
    volumeId string
    volumeJobId string
    auto_delete bool
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completed_at str
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    created_at str
    (String) The date and time that the volume job was created.
    estimated_completion_at str
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href str
    (String) The URL for this volume profile.
    id str
    The unique identifier of the is_volume_job.
    job_type str
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    name str
    (String) The globally unique name for this volume profile.
    parameters Sequence[GetIsVolumeJobParameter]
    (List) The parameters to use after the volume is migrated.
    resource_type str
    (String) The resource type.
    started_at str
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status str
    (String) The status of this volume job:
    status_reasons Sequence[GetIsVolumeJobStatusReason]
    (List) The reasons for the current status (if any).
    volume_id str
    volume_job_id str
    autoDelete Boolean
    (Boolean) Indicates whether this volume job will be automatically deleted after it completes. At present, this is always false, but may be modifiable in the future.
    completedAt String
    (String) The date and time that the volume job was completed.If absent, the volume job has not yet completed.
    createdAt String
    (String) The date and time that the volume job was created.
    estimatedCompletionAt String
    (String) The date and time that the volume job is estimated to complete.If absent, the volume job is still queued and has not yet started.
    href String
    (String) The URL for this volume profile.
    id String
    The unique identifier of the is_volume_job.
    jobType String
    (String) The type of volume job.The enumerated values for this property may expand in the future.
    name String
    (String) The globally unique name for this volume profile.
    parameters List<Property Map>
    (List) The parameters to use after the volume is migrated.
    resourceType String
    (String) The resource type.
    startedAt String
    (String) The date and time that the volume job was started.If absent, the volume job has not yet started.
    status String
    (String) The status of this volume job:
    statusReasons List<Property Map>
    (List) The reasons for the current status (if any).
    volumeId String
    volumeJobId String

    Supporting Types

    GetIsVolumeJobParameter

    Bandwidth double
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    Iops double
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    Profiles List<GetIsVolumeJobParameterProfile>
    (List) Identifies a volume profile by a unique property.
    Bandwidth float64
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    Iops float64
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    Profiles []GetIsVolumeJobParameterProfile
    (List) Identifies a volume profile by a unique property.
    bandwidth number
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    iops number
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profiles list(object)
    (List) Identifies a volume profile by a unique property.
    bandwidth Double
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    iops Double
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profiles List<GetIsVolumeJobParameterProfile>
    (List) Identifies a volume profile by a unique property.
    bandwidth number
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    iops number
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profiles GetIsVolumeJobParameterProfile[]
    (List) Identifies a volume profile by a unique property.
    bandwidth float
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    iops float
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profiles Sequence[GetIsVolumeJobParameterProfile]
    (List) Identifies a volume profile by a unique property.
    bandwidth Number
    (Integer) The maximum bandwidth (in megabits per second) for the volume.If specified, the volume profile must not have a bandwidth.type of dependent.
    iops Number
    (Integer) The maximum I/O operations per second (IOPS) for this volume.If specified, the volume profile must not have a iops.type of dependent.
    profiles List<Property Map>
    (List) Identifies a volume profile by a unique property.

    GetIsVolumeJobParameterProfile

    Href string
    (String) The URL for this volume profile.
    Name string
    (String) The globally unique name for this volume profile.
    Href string
    (String) The URL for this volume profile.
    Name string
    (String) The globally unique name for this volume profile.
    href string
    (String) The URL for this volume profile.
    name string
    (String) The globally unique name for this volume profile.
    href String
    (String) The URL for this volume profile.
    name String
    (String) The globally unique name for this volume profile.
    href string
    (String) The URL for this volume profile.
    name string
    (String) The globally unique name for this volume profile.
    href str
    (String) The URL for this volume profile.
    name str
    (String) The globally unique name for this volume profile.
    href String
    (String) The URL for this volume profile.
    name String
    (String) The globally unique name for this volume profile.

    GetIsVolumeJobStatusReason

    Code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) A link to documentation about this status reason.
    Code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) A link to documentation about this status reason.
    code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    message string
    (String) An explanation of the status reason.
    more_info string
    (String) A link to documentation about this status reason.
    code String
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) A link to documentation about this status reason.
    code string
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) A link to documentation about this status reason.
    code str
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) A link to documentation about this status reason.
    code String
    (String) A snake case string succinctly identifying the status reason.The enumerated values for this property may expand in the future. Constraints: Allowable values are: internal_error, virtual_instance_powered_off, volume_detached_from_virtual_instance.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) A link to documentation about this status reason.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.1.0
    published on Tuesday, May 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm
      Try Pulumi Cloud free. Your team will thank you.