getBlockStorage

Vultr v2.27.1, Sep 30 25

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Example Usage

Get the information for a block storage subscription by label:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myBlockStorage = vultr.getBlockStorage({
    filters: [{
        name: "label",
        values: ["my-block-storage-label"],
    }],
});

import pulumi
import pulumi_vultr as vultr

my_block_storage = vultr.get_block_storage(filters=[{
    "name": "label",
    "values": ["my-block-storage-label"],
}])

package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.LookupBlockStorage(ctx, &vultr.LookupBlockStorageArgs{
			Filters: []vultr.GetBlockStorageFilter{
				{
					Name: "label",
					Values: []string{
						"my-block-storage-label",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myBlockStorage = Vultr.GetBlockStorage.Invoke(new()
    {
        Filters = new[]
        {
            new Vultr.Inputs.GetBlockStorageFilterInputArgs
            {
                Name = "label",
                Values = new[]
                {
                    "my-block-storage-label",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.VultrFunctions;
import com.pulumi.vultr.inputs.GetBlockStorageArgs;
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 myBlockStorage = VultrFunctions.getBlockStorage(GetBlockStorageArgs.builder()
            .filters(GetBlockStorageFilterArgs.builder()
                .name("label")
                .values("my-block-storage-label")
                .build())
            .build());

    }
}

variables:
  myBlockStorage:
    fn::invoke:
      function: vultr:getBlockStorage
      arguments:
        filters:
          - name: label
            values:
              - my-block-storage-label

Using getBlockStorage

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 getBlockStorage(args: GetBlockStorageArgs, opts?: InvokeOptions): Promise<GetBlockStorageResult>
function getBlockStorageOutput(args: GetBlockStorageOutputArgs, opts?: InvokeOptions): Output<GetBlockStorageResult>

def get_block_storage(filters: Optional[Sequence[GetBlockStorageFilter]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetBlockStorageResult
def get_block_storage_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetBlockStorageFilterArgs]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetBlockStorageResult]

func LookupBlockStorage(ctx *Context, args *LookupBlockStorageArgs, opts ...InvokeOption) (*LookupBlockStorageResult, error)
func LookupBlockStorageOutput(ctx *Context, args *LookupBlockStorageOutputArgs, opts ...InvokeOption) LookupBlockStorageResultOutput

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

public static class GetBlockStorage 
{
    public static Task<GetBlockStorageResult> InvokeAsync(GetBlockStorageArgs args, InvokeOptions? opts = null)
    public static Output<GetBlockStorageResult> Invoke(GetBlockStorageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBlockStorageResult> getBlockStorage(GetBlockStorageArgs args, InvokeOptions options)
public static Output<GetBlockStorageResult> getBlockStorage(GetBlockStorageArgs args, InvokeOptions options)

fn::invoke:
  function: vultr:index/getBlockStorage:getBlockStorage
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<ediri.Vultr.Inputs.GetBlockStorageFilter>: Query parameters for finding block storage subscriptions.

Filters []GetBlockStorageFilter: Query parameters for finding block storage subscriptions.

filters List<GetBlockStorageFilter>: Query parameters for finding block storage subscriptions.

filters GetBlockStorageFilter[]: Query parameters for finding block storage subscriptions.

filters Sequence[GetBlockStorageFilter]: Query parameters for finding block storage subscriptions.

filters List<Property Map>: Query parameters for finding block storage subscriptions.