vkcs.getBlockstorageVolume

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

Example Usage

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

const data = vkcs.getBlockstorageVolume({
    name: "data-tf-example",
});

import pulumi
import pulumi_vkcs as vkcs

data = vkcs.get_blockstorage_volume(name="data-tf-example")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.LookupBlockstorageVolume(ctx, &vkcs.LookupBlockstorageVolumeArgs{
			Name: pulumi.StringRef("data-tf-example"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var data = Vkcs.GetBlockstorageVolume.Invoke(new()
    {
        Name = "data-tf-example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetBlockstorageVolumeArgs;
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 data = VkcsFunctions.getBlockstorageVolume(GetBlockstorageVolumeArgs.builder()
            .name("data-tf-example")
            .build());

    }
}

variables:
  data:
    fn::invoke:
      function: vkcs:getBlockstorageVolume
      arguments:
        name: data-tf-example

Using getBlockstorageVolume

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 getBlockstorageVolume(args: GetBlockstorageVolumeArgs, opts?: InvokeOptions): Promise<GetBlockstorageVolumeResult>
function getBlockstorageVolumeOutput(args: GetBlockstorageVolumeOutputArgs, opts?: InvokeOptions): Output<GetBlockstorageVolumeResult>

def get_blockstorage_volume(bootable: Optional[str] = None,
                            id: Optional[str] = None,
                            metadata: Optional[Mapping[str, str]] = None,
                            name: Optional[str] = None,
                            region: Optional[str] = None,
                            status: Optional[str] = None,
                            volume_type: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetBlockstorageVolumeResult
def get_blockstorage_volume_output(bootable: Optional[pulumi.Input[str]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            metadata: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            region: Optional[pulumi.Input[str]] = None,
                            status: Optional[pulumi.Input[str]] = None,
                            volume_type: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetBlockstorageVolumeResult]

func LookupBlockstorageVolume(ctx *Context, args *LookupBlockstorageVolumeArgs, opts ...InvokeOption) (*LookupBlockstorageVolumeResult, error)
func LookupBlockstorageVolumeOutput(ctx *Context, args *LookupBlockstorageVolumeOutputArgs, opts ...InvokeOption) LookupBlockstorageVolumeResultOutput

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

public static class GetBlockstorageVolume 
{
    public static Task<GetBlockstorageVolumeResult> InvokeAsync(GetBlockstorageVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetBlockstorageVolumeResult> Invoke(GetBlockstorageVolumeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBlockstorageVolumeResult> getBlockstorageVolume(GetBlockstorageVolumeArgs args, InvokeOptions options)
public static Output<GetBlockstorageVolumeResult> getBlockstorageVolume(GetBlockstorageVolumeArgs args, InvokeOptions options)

fn::invoke:
  function: vkcs:index/getBlockstorageVolume:getBlockstorageVolume
  arguments:
    # arguments dictionary

The following arguments are supported:

Bootable string: optional string → Indicates if the volume is bootable.
Id string: string → ID of the resource.
Metadata Dictionary<string, string>: optional map of string → Metadata key/value pairs associated with the volume.
Name string: optional string → The name of the volume.
Region string: optional string → The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.
Status string: optional string → The status of the volume.
VolumeType string: optional string → The type of the volume.

Bootable string: optional string → Indicates if the volume is bootable.
Id string: string → ID of the resource.
Metadata map[string]string: optional map of string → Metadata key/value pairs associated with the volume.
Name string: optional string → The name of the volume.
Region string: optional string → The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.
Status string: optional string → The status of the volume.
VolumeType string: optional string → The type of the volume.

bootable String: optional string → Indicates if the volume is bootable.
id String: string → ID of the resource.
metadata Map<String,String>: optional map of string → Metadata key/value pairs associated with the volume.
name String: optional string → The name of the volume.
region String: optional string → The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.
status String: optional string → The status of the volume.
volumeType String: optional string → The type of the volume.

bootable string: optional string → Indicates if the volume is bootable.
id string: string → ID of the resource.
metadata {[key: string]: string}: optional map of string → Metadata key/value pairs associated with the volume.
name string: optional string → The name of the volume.
region string: optional string → The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.
status string: optional string → The status of the volume.
volumeType string: optional string → The type of the volume.

bootable str: optional string → Indicates if the volume is bootable.
id str: string → ID of the resource.
metadata Mapping[str, str]: optional map of string → Metadata key/value pairs associated with the volume.
name str: optional string → The name of the volume.
region str: optional string → The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.
status str: optional string → The status of the volume.
volume_type str: optional string → The type of the volume.

bootable String: optional string → Indicates if the volume is bootable.
id String: string → ID of the resource.
metadata Map<String>: optional map of string → Metadata key/value pairs associated with the volume.
name String: optional string → The name of the volume.
region String: optional string → The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.
status String: optional string → The status of the volume.
volumeType String: optional string → The type of the volume.

getBlockstorageVolume Result

The following output properties are available:

AvailabilityZone string: string → The name of the availability zone of the volume.
Bootable string
Id string: string → ID of the resource.
Metadata Dictionary<string, string>
Name string
Region string
Size double: number → The size of the volume in GBs.
SourceVolumeId string: string → The ID of the volume from which the current volume was created.
Status string
VolumeType string

AvailabilityZone string: string → The name of the availability zone of the volume.
Bootable string
Id string: string → ID of the resource.
Metadata map[string]string
Name string
Region string
Size float64: number → The size of the volume in GBs.
SourceVolumeId string: string → The ID of the volume from which the current volume was created.
Status string
VolumeType string

availabilityZone String: string → The name of the availability zone of the volume.
bootable String
id String: string → ID of the resource.
metadata Map<String,String>
name String
region String
size Double: number → The size of the volume in GBs.
sourceVolumeId String: string → The ID of the volume from which the current volume was created.
status String
volumeType String

availabilityZone string: string → The name of the availability zone of the volume.
bootable string
id string: string → ID of the resource.
metadata {[key: string]: string}
name string
region string
size number: number → The size of the volume in GBs.
sourceVolumeId string: string → The ID of the volume from which the current volume was created.
status string
volumeType string

availability_zone str: string → The name of the availability zone of the volume.
bootable str
id str: string → ID of the resource.
metadata Mapping[str, str]
name str
region str
size float: number → The size of the volume in GBs.
source_volume_id str: string → The ID of the volume from which the current volume was created.
status str
volume_type str

availabilityZone String: string → The name of the availability zone of the volume.
bootable String
id String: string → ID of the resource.
metadata Map<String>
name String
region String
size Number: number → The size of the volume in GBs.
sourceVolumeId String: string → The ID of the volume from which the current volume was created.
status String
volumeType String

Package Details

Repository: vkcs vk-cs/terraform-provider-vkcs
License
Notes: This Pulumi package is based on the vkcs Terraform Provider.

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

vkcs.getBlockstorageVolume

On this page

On this page

Example Usage

Using getBlockstorageVolume

getBlockstorageVolume Result

Package Details

On this page

On this page