1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVolumeProfiles
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getIsVolumeProfiles

Explore with Pulumi AI

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";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

Example Usage

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

const example = ibm.getIsVolumeProfiles({});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_volume_profiles()
Copy
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.GetIsVolumeProfiles(ctx, &ibm.GetIsVolumeProfilesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsVolumeProfiles.Invoke();

});
Copy
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();

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsVolumeProfiles
      arguments: {}
Copy

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

> 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)
}
Copy
public static CompletableFuture<GetIsVolumeProfilesResult> getIsVolumeProfiles(GetIsVolumeProfilesArgs args, InvokeOptions options)
public static Output<GetIsVolumeProfilesResult> getIsVolumeProfiles(GetIsVolumeProfilesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsVolumeProfiles:getIsVolumeProfiles
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

GetIsVolumeProfilesProfileAdjustableCapacityState

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