1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getIsVolumeProfiles
Viewing docs for ibm 2.2.1
published on Thursday, May 21, 2026 by ibm-cloud
Viewing docs for ibm 2.2.1
published on Thursday, May 21, 2026 by ibm-cloud

    Retrieve information of an existing IBM Cloud VSI. For more information, about the volumes and profiles, see block storage profiles.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    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) {
        }
    }
    
    {}
    
    Example coming soon!
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsVolumeProfiles({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_volume_profiles()
    
    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.GetIsVolumeProfiles(ctx, &ibm.GetIsVolumeProfilesArgs{}, 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.GetIsVolumeProfiles.Invoke();
    
    });
    
    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.GetIsVolumeProfilesArgs;
    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.getIsVolumeProfiles(GetIsVolumeProfilesArgs.builder()
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsVolumeProfiles
          arguments: {}
    
    Example coming soon!
    

    Using getIsVolumeProfiles

    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 getIsVolumeProfiles(args: GetIsVolumeProfilesArgs, opts?: InvokeOptions): Promise<GetIsVolumeProfilesResult>
    function getIsVolumeProfilesOutput(args: GetIsVolumeProfilesOutputArgs, opts?: InvokeOptions): Output<GetIsVolumeProfilesResult>
    def get_is_volume_profiles(id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetIsVolumeProfilesResult
    def get_is_volume_profiles_output(id: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetIsVolumeProfilesResult]
    func GetIsVolumeProfiles(ctx *Context, args *GetIsVolumeProfilesArgs, opts ...InvokeOption) (*GetIsVolumeProfilesResult, error)
    func GetIsVolumeProfilesOutput(ctx *Context, args *GetIsVolumeProfilesOutputArgs, opts ...InvokeOption) GetIsVolumeProfilesResultOutput

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

    public static class GetIsVolumeProfiles 
    {
        public static Task<GetIsVolumeProfilesResult> InvokeAsync(GetIsVolumeProfilesArgs args, InvokeOptions? opts = null)
        public static Output<GetIsVolumeProfilesResult> Invoke(GetIsVolumeProfilesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsVolumeProfilesResult> getIsVolumeProfiles(GetIsVolumeProfilesArgs args, InvokeOptions options)
    public static Output<GetIsVolumeProfilesResult> getIsVolumeProfiles(GetIsVolumeProfilesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsVolumeProfiles:getIsVolumeProfiles
      arguments:
        # arguments dictionary
    data "ibm_getisvolumeprofiles" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Id string
    id string
    id String
    id string
    id str
    id String

    getIsVolumeProfiles Result

    The following output properties are available:

    Id string
    Profiles List<GetIsVolumeProfilesProfile>
    (List) Lists all server volume profiles in the region.
    Id string
    Profiles []GetIsVolumeProfilesProfile
    (List) Lists all server volume profiles in the region.
    id string
    profiles list(object)
    (List) Lists all server volume profiles in the region.
    id String
    profiles List<GetIsVolumeProfilesProfile>
    (List) Lists all server volume profiles in the region.
    id string
    profiles GetIsVolumeProfilesProfile[]
    (List) Lists all server volume profiles in the region.
    id str
    profiles Sequence[GetIsVolumeProfilesProfile]
    (List) Lists all server volume profiles in the region.
    id String
    profiles List<Property Map>
    (List) Lists all server volume profiles in the region.

    Supporting Types

    GetIsVolumeProfilesProfile

    AdjustableCapacityStates List<GetIsVolumeProfilesProfileAdjustableCapacityState>
    (List) Nested schema for adjustable_capacity_states:
    AdjustableIopsStates List<GetIsVolumeProfilesProfileAdjustableIopsState>
    (List) Nested schema for adjustable_iops_states:
    BootCapacities List<GetIsVolumeProfilesProfileBootCapacity>
    Capacities List<GetIsVolumeProfilesProfileCapacity>
    Family string
    (String) The family of the virtual server volume profile.
    Href string
    Iops List<GetIsVolumeProfilesProfileIop>
    Name string
    (String) The name of the virtual server volume profile.
    AdjustableCapacityStates []GetIsVolumeProfilesProfileAdjustableCapacityState
    (List) Nested schema for adjustable_capacity_states:
    AdjustableIopsStates []GetIsVolumeProfilesProfileAdjustableIopsState
    (List) Nested schema for adjustable_iops_states:
    BootCapacities []GetIsVolumeProfilesProfileBootCapacity
    Capacities []GetIsVolumeProfilesProfileCapacity
    Family string
    (String) The family of the virtual server volume profile.
    Href string
    Iops []GetIsVolumeProfilesProfileIop
    Name string
    (String) The name of the virtual server volume profile.
    adjustable_capacity_states list(object)
    (List) Nested schema for adjustable_capacity_states:
    adjustable_iops_states list(object)
    (List) Nested schema for adjustable_iops_states:
    boot_capacities list(object)
    capacities list(object)
    family string
    (String) The family of the virtual server volume profile.
    href string
    iops list(object)
    name string
    (String) The name of the virtual server volume profile.
    adjustableCapacityStates List<GetIsVolumeProfilesProfileAdjustableCapacityState>
    (List) Nested schema for adjustable_capacity_states:
    adjustableIopsStates List<GetIsVolumeProfilesProfileAdjustableIopsState>
    (List) Nested schema for adjustable_iops_states:
    bootCapacities List<GetIsVolumeProfilesProfileBootCapacity>
    capacities List<GetIsVolumeProfilesProfileCapacity>
    family String
    (String) The family of the virtual server volume profile.
    href String
    iops List<GetIsVolumeProfilesProfileIop>
    name String
    (String) The name of the virtual server volume profile.
    adjustableCapacityStates GetIsVolumeProfilesProfileAdjustableCapacityState[]
    (List) Nested schema for adjustable_capacity_states:
    adjustableIopsStates GetIsVolumeProfilesProfileAdjustableIopsState[]
    (List) Nested schema for adjustable_iops_states:
    bootCapacities GetIsVolumeProfilesProfileBootCapacity[]
    capacities GetIsVolumeProfilesProfileCapacity[]
    family string
    (String) The family of the virtual server volume profile.
    href string
    iops GetIsVolumeProfilesProfileIop[]
    name string
    (String) The name of the virtual server volume profile.
    adjustable_capacity_states Sequence[GetIsVolumeProfilesProfileAdjustableCapacityState]
    (List) Nested schema for adjustable_capacity_states:
    adjustable_iops_states Sequence[GetIsVolumeProfilesProfileAdjustableIopsState]
    (List) Nested schema for adjustable_iops_states:
    boot_capacities Sequence[GetIsVolumeProfilesProfileBootCapacity]
    capacities Sequence[GetIsVolumeProfilesProfileCapacity]
    family str
    (String) The family of the virtual server volume profile.
    href str
    iops Sequence[GetIsVolumeProfilesProfileIop]
    name str
    (String) The name of the virtual server volume profile.
    adjustableCapacityStates List<Property Map>
    (List) Nested schema for adjustable_capacity_states:
    adjustableIopsStates List<Property Map>
    (List) Nested schema for adjustable_iops_states:
    bootCapacities List<Property Map>
    capacities List<Property Map>
    family String
    (String) The family of the virtual server volume profile.
    href String
    iops List<Property Map>
    name String
    (String) The name of the virtual server volume profile.

    GetIsVolumeProfilesProfileAdjustableCapacityState

    Type string
    (String) The type for this profile field.
    Values List<string>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    Type string
    (String) The type for this profile field.
    Values []string
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type string
    (String) The type for this profile field.
    values list(string)
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type String
    (String) The type for this profile field.
    values List<String>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type string
    (String) The type for this profile field.
    values string[]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type str
    (String) The type for this profile field.
    values Sequence[str]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type String
    (String) The type for this profile field.
    values List<String>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.

    GetIsVolumeProfilesProfileAdjustableIopsState

    Type string
    (String) The type for this profile field.
    Values List<string>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    Type string
    (String) The type for this profile field.
    Values []string
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type string
    (String) The type for this profile field.
    values list(string)
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type String
    (String) The type for this profile field.
    values List<String>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type string
    (String) The type for this profile field.
    values string[]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type str
    (String) The type for this profile field.
    values Sequence[str]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    type String
    (String) The type for this profile field.
    values List<String>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.

    GetIsVolumeProfilesProfileBootCapacity

    Default double
    Max double
    Min double
    Step double
    Type string
    (String) The type for this profile field.
    Value double
    Values List<double>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    Default float64
    Max float64
    Min float64
    Step float64
    Type string
    (String) The type for this profile field.
    Value float64
    Values []float64
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default number
    max number
    min number
    step number
    type string
    (String) The type for this profile field.
    value number
    values list(number)
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default_ Double
    max Double
    min Double
    step Double
    type String
    (String) The type for this profile field.
    value Double
    values List<Double>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default number
    max number
    min number
    step number
    type string
    (String) The type for this profile field.
    value number
    values number[]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default float
    max float
    min float
    step float
    type str
    (String) The type for this profile field.
    value float
    values Sequence[float]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default Number
    max Number
    min Number
    step Number
    type String
    (String) The type for this profile field.
    value Number
    values List<Number>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.

    GetIsVolumeProfilesProfileCapacity

    Default double
    Max double
    Min double
    Step double
    Type string
    (String) The type for this profile field.
    Value double
    Values List<double>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    Default float64
    Max float64
    Min float64
    Step float64
    Type string
    (String) The type for this profile field.
    Value float64
    Values []float64
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default number
    max number
    min number
    step number
    type string
    (String) The type for this profile field.
    value number
    values list(number)
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default_ Double
    max Double
    min Double
    step Double
    type String
    (String) The type for this profile field.
    value Double
    values List<Double>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default number
    max number
    min number
    step number
    type string
    (String) The type for this profile field.
    value number
    values number[]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default float
    max float
    min float
    step float
    type str
    (String) The type for this profile field.
    value float
    values Sequence[float]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default Number
    max Number
    min Number
    step Number
    type String
    (String) The type for this profile field.
    value Number
    values List<Number>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.

    GetIsVolumeProfilesProfileIop

    Default double
    Max double
    Min double
    Step double
    Type string
    (String) The type for this profile field.
    Value double
    Values List<double>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    Default float64
    Max float64
    Min float64
    Step float64
    Type string
    (String) The type for this profile field.
    Value float64
    Values []float64
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default number
    max number
    min number
    step number
    type string
    (String) The type for this profile field.
    value number
    values list(number)
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default_ Double
    max Double
    min Double
    step Double
    type String
    (String) The type for this profile field.
    value Double
    values List<Double>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default number
    max number
    min number
    step number
    type string
    (String) The type for this profile field.
    value number
    values number[]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default float
    max float
    min float
    step float
    type str
    (String) The type for this profile field.
    value float
    values Sequence[float]
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.
    default Number
    max Number
    min Number
    step Number
    type String
    (String) The type for this profile field.
    value Number
    values List<Number>
    (List) The attachment states that support adjustable IOPS for a volume with this profile. Allowable list items are: attached, unattached, unusable.

    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.2.1
    published on Thursday, May 21, 2026 by ibm-cloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial