Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVolumeProfile
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsVolumeProfile

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    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";

    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 Usage

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

const example = ibm.getIsVolumeProfile({
    name: "general-purpose",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_volume_profile(name="general-purpose")

    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
	})
}

    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",
    });

});

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

    }
}

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

    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>
    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]
    func GetIsVolumeProfile(ctx *Context, args *GetIsVolumeProfileArgs, opts ...InvokeOption) (*GetIsVolumeProfileResult, error)
func GetIsVolumeProfileOutput(ctx *Context, args *GetIsVolumeProfileOutputArgs, opts ...InvokeOption) GetIsVolumeProfileResultOutput

    > 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)
}
    public static CompletableFuture<GetIsVolumeProfileResult> getIsVolumeProfile(GetIsVolumeProfileArgs args, InvokeOptions options)
public static Output<GetIsVolumeProfileResult> getIsVolumeProfile(GetIsVolumeProfileArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsVolumeProfile:getIsVolumeProfile
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name for the virtual server volume profile.
    Id string
    Name string
    The name for the virtual server volume profile.
    Id string
    name String
    The name for the virtual server volume profile.
    id String
    name string
    The name for the virtual server volume profile.
    id string
    name str
    The name for the virtual server volume profile.
    id str
    name 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 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 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.

    GetIsVolumeProfileAdjustableIopsState

    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 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.

    GetIsVolumeProfileBootCapacity

    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_ 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.

    GetIsVolumeProfileCapacity

    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_ 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.

    GetIsVolumeProfileIop

    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_ 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.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm