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

ibm.getIsVolumeJobs

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 a VolumeJobPaginatedCollection. 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.getIsVolumeJobs({
    volumeId: exampleIbmIsVolumeJob.volumeId,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_volume_jobs(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.GetIsVolumeJobs(ctx, &ibm.GetIsVolumeJobsArgs{
			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.GetIsVolumeJobs.Invoke(new()
    {
        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.GetIsVolumeJobsArgs;
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.getIsVolumeJobs(GetIsVolumeJobsArgs.builder()
            .volumeId(exampleIbmIsVolumeJob.volumeId())
            .build());

    }
}

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

    Example coming soon!

    Using getIsVolumeJobs

    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 getIsVolumeJobs(args: GetIsVolumeJobsArgs, opts?: InvokeOptions): Promise<GetIsVolumeJobsResult>
function getIsVolumeJobsOutput(args: GetIsVolumeJobsOutputArgs, opts?: InvokeOptions): Output<GetIsVolumeJobsResult>
    def get_is_volume_jobs(id: Optional[str] = None,
                       volume_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetIsVolumeJobsResult
def get_is_volume_jobs_output(id: pulumi.Input[Optional[str]] = None,
                       volume_id: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetIsVolumeJobsResult]
    func GetIsVolumeJobs(ctx *Context, args *GetIsVolumeJobsArgs, opts ...InvokeOption) (*GetIsVolumeJobsResult, error)
func GetIsVolumeJobsOutput(ctx *Context, args *GetIsVolumeJobsOutputArgs, opts ...InvokeOption) GetIsVolumeJobsResultOutput

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

    public static class GetIsVolumeJobs 
{
    public static Task<GetIsVolumeJobsResult> InvokeAsync(GetIsVolumeJobsArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVolumeJobsResult> Invoke(GetIsVolumeJobsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVolumeJobsResult> getIsVolumeJobs(GetIsVolumeJobsArgs args, InvokeOptions options)
public static Output<GetIsVolumeJobsResult> getIsVolumeJobs(GetIsVolumeJobsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsVolumeJobs:getIsVolumeJobs
  arguments:
    # arguments dictionary
    data "ibm_getisvolumejobs" "name" {
    # arguments
}

    The following arguments are supported:

    VolumeId string
    The volume identifier.
    Id string
    (String) The unique identifier for this volume job.
    VolumeId string
    The volume identifier.
    Id string
    (String) The unique identifier for this volume job.
    volume_id string
    The volume identifier.
    id string
    (String) The unique identifier for this volume job.
    volumeId String
    The volume identifier.
    id String
    (String) The unique identifier for this volume job.
    volumeId string
    The volume identifier.
    id string
    (String) The unique identifier for this volume job.
    volume_id str
    The volume identifier.
    id str
    (String) The unique identifier for this volume job.
    volumeId String
    The volume identifier.
    id String
    (String) The unique identifier for this volume job.

    getIsVolumeJobs Result

    The following output properties are available:

    Id string
    (String) The unique identifier for this volume job.
    Jobs List<GetIsVolumeJobsJob>
    (List) The jobs for this volume.
    VolumeId string
    Id string
    (String) The unique identifier for this volume job.
    Jobs []GetIsVolumeJobsJob
    (List) The jobs for this volume.
    VolumeId string
    id string
    (String) The unique identifier for this volume job.
    jobs list(object)
    (List) The jobs for this volume.
    volume_id string
    id String
    (String) The unique identifier for this volume job.
    jobs List<GetIsVolumeJobsJob>
    (List) The jobs for this volume.
    volumeId String
    id string
    (String) The unique identifier for this volume job.
    jobs GetIsVolumeJobsJob[]
    (List) The jobs for this volume.
    volumeId string
    id str
    (String) The unique identifier for this volume job.
    jobs Sequence[GetIsVolumeJobsJob]
    (List) The jobs for this volume.
    volume_id str
    id String
    (String) The unique identifier for this volume job.
    jobs List<Property Map>
    (List) The jobs for this volume.
    volumeId String

    Supporting Types

    GetIsVolumeJobsJob

    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
    (String) The unique identifier for this 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<GetIsVolumeJobsJobParameter>
    (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<GetIsVolumeJobsJobStatusReason>
    (List) The reasons for the current status (if any).
    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
    (String) The unique identifier for this 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 []GetIsVolumeJobsJobParameter
    (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 []GetIsVolumeJobsJobStatusReason
    (List) The reasons for the current status (if any).
    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
    (String) The unique identifier for this 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).
    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
    (String) The unique identifier for this 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<GetIsVolumeJobsJobParameter>
    (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<GetIsVolumeJobsJobStatusReason>
    (List) The reasons for the current status (if any).
    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
    (String) The unique identifier for this 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 GetIsVolumeJobsJobParameter[]
    (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 GetIsVolumeJobsJobStatusReason[]
    (List) The reasons for the current status (if any).
    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
    (String) The unique identifier for this 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[GetIsVolumeJobsJobParameter]
    (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[GetIsVolumeJobsJobStatusReason]
    (List) The reasons for the current status (if any).
    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
    (String) The unique identifier for this 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).

    GetIsVolumeJobsJobParameter

    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<GetIsVolumeJobsJobParameterProfile>
    (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 []GetIsVolumeJobsJobParameterProfile
    (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<GetIsVolumeJobsJobParameterProfile>
    (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 GetIsVolumeJobsJobParameterProfile[]
    (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[GetIsVolumeJobsJobParameterProfile]
    (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.

    GetIsVolumeJobsJobParameterProfile

    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.

    GetIsVolumeJobsJobStatusReason

    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. The maximum length is 128 characters.
    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. The maximum length is 128 characters.
    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. The maximum length is 128 characters.
    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. The maximum length is 128 characters.
    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. The maximum length is 128 characters.
    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. The maximum length is 128 characters.
    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. The maximum length is 128 characters.
    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.