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

ibm.getIsVolumeProfile

Explore with Pulumi AI

Retrieve information of an existing IBM Cloud virtual server volume profile as a read-only data source. For more information, about virtual server volume profile, see restoring a volume from a snapshot.

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.getIsVolumeProfile({
    name: "general-purpose",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_volume_profile(name="general-purpose")
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.GetIsVolumeProfile(ctx, &ibm.GetIsVolumeProfileArgs{
			Name: "general-purpose",
		}, 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.GetIsVolumeProfile.Invoke(new()
    {
        Name = "general-purpose",
    });

});
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.GetIsVolumeProfileArgs;
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.getIsVolumeProfile(GetIsVolumeProfileArgs.builder()
            .name("general-purpose")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsVolumeProfile
      arguments:
        name: general-purpose
Copy

Using getIsVolumeProfile

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 getIsVolumeProfile(args: GetIsVolumeProfileArgs, opts?: InvokeOptions): Promise<GetIsVolumeProfileResult>
function getIsVolumeProfileOutput(args: GetIsVolumeProfileOutputArgs, opts?: InvokeOptions): Output<GetIsVolumeProfileResult>
Copy
def get_is_volume_profile(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetIsVolumeProfileResult
def get_is_volume_profile_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetIsVolumeProfileResult]
Copy
func GetIsVolumeProfile(ctx *Context, args *GetIsVolumeProfileArgs, opts ...InvokeOption) (*GetIsVolumeProfileResult, error)
func GetIsVolumeProfileOutput(ctx *Context, args *GetIsVolumeProfileOutputArgs, opts ...InvokeOption) GetIsVolumeProfileResultOutput
Copy

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

public static class GetIsVolumeProfile 
{
    public static Task<GetIsVolumeProfileResult> InvokeAsync(GetIsVolumeProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVolumeProfileResult> Invoke(GetIsVolumeProfileInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsVolumeProfileResult> getIsVolumeProfile(GetIsVolumeProfileArgs args, InvokeOptions options)
public static Output<GetIsVolumeProfileResult> getIsVolumeProfile(GetIsVolumeProfileArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsVolumeProfile:getIsVolumeProfile
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name for the virtual server volume profile.
Id string
Name This property is required. string
The name for the virtual server volume profile.
Id string
name This property is required. String
The name for the virtual server volume profile.
id String
name This property is required. string
The name for the virtual server volume profile.
id string
name This property is required. str
The name for the virtual server volume profile.
id str
name This property is required. String
The name for the virtual server volume profile.
id String

getIsVolumeProfile Result

The following output properties are available:

AdjustableCapacityStates List<GetIsVolumeProfileAdjustableCapacityState>
(List) Nested schema for adjustable_capacity_states:
AdjustableIopsStates List<GetIsVolumeProfileAdjustableIopsState>
(List) Nested schema for adjustable_iops_states:
BootCapacities List<GetIsVolumeProfileBootCapacity>
Capacities List<GetIsVolumeProfileCapacity>
Family string
(String) The family of the virtual server volume profile.
Href string
Id string
Iops List<GetIsVolumeProfileIop>
Name string
AdjustableCapacityStates []GetIsVolumeProfileAdjustableCapacityState
(List) Nested schema for adjustable_capacity_states:
AdjustableIopsStates []GetIsVolumeProfileAdjustableIopsState
(List) Nested schema for adjustable_iops_states:
BootCapacities []GetIsVolumeProfileBootCapacity
Capacities []GetIsVolumeProfileCapacity
Family string
(String) The family of the virtual server volume profile.
Href string
Id string
Iops []GetIsVolumeProfileIop
Name string
adjustableCapacityStates List<GetIsVolumeProfileAdjustableCapacityState>
(List) Nested schema for adjustable_capacity_states:
adjustableIopsStates List<GetIsVolumeProfileAdjustableIopsState>
(List) Nested schema for adjustable_iops_states:
bootCapacities List<GetIsVolumeProfileBootCapacity>
capacities List<GetIsVolumeProfileCapacity>
family String
(String) The family of the virtual server volume profile.
href String
id String
iops List<GetIsVolumeProfileIop>
name String
adjustableCapacityStates GetIsVolumeProfileAdjustableCapacityState[]
(List) Nested schema for adjustable_capacity_states:
adjustableIopsStates GetIsVolumeProfileAdjustableIopsState[]
(List) Nested schema for adjustable_iops_states:
bootCapacities GetIsVolumeProfileBootCapacity[]
capacities GetIsVolumeProfileCapacity[]
family string
(String) The family of the virtual server volume profile.
href string
id string
iops GetIsVolumeProfileIop[]
name string
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
id String
iops List<Property Map>
name String

Supporting Types

GetIsVolumeProfileAdjustableCapacityState

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.

GetIsVolumeProfileAdjustableIopsState

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.

GetIsVolumeProfileBootCapacity

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.

GetIsVolumeProfileCapacity

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.

GetIsVolumeProfileIop

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.