getVolume

Provides an Equinix Metal Block Storage Volume datasource to allow you to read existing volumes.

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        var volume1 = Output.Create(EquinixMetal.GetVolume.InvokeAsync(new EquinixMetal.GetVolumeArgs
        {
            Name = "terraform-volume-1",
            ProjectId = local.Project_id,
        }));
        this.VolumeSize = volume1.Apply(volume1 => volume1.Size);
    }

    [Output("volumeSize")]
    public Output<string> VolumeSize { get; set; }
}

package main

import (
	"github.com/pulumi/pulumi-equinix-metal/sdk/v2/go/equinix-metal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "terraform-volume-1"
		opt1 := local.Project_id
		volume1, err := equinix - metal.LookupVolume(ctx, &equinix-metal.LookupVolumeArgs{
			Name:      &opt0,
			ProjectId: &opt1,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("volumeSize", volume1.Size)
		return nil
	})
}

import pulumi
import pulumi_equinix_metal as equinix_metal

volume1 = equinix_metal.get_volume(name="terraform-volume-1",
    project_id=local["project_id"])
pulumi.export("volumeSize", volume1.size)

import * as pulumi from "@pulumi/pulumi";
import * as equinix_metal from "@pulumi/equinix-metal";

const volume1 = equinix_metal.getVolume({
    name: "terraform-volume-1",
    projectId: local.project_id,
});
export const volumeSize = volume1.then(volume1 => volume1.size);

Using getVolume

function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>

def get_volume(name: Optional[str] = None,
               project_id: Optional[str] = None,
               volume_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult

func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)

Note: This function is named LookupVolume in the Go SDK.

public static class GetVolume {
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: Name of volume for lookup
ProjectId string: The ID the parent Equinix Metal project (for lookup by name)
VolumeId string: ID of volume for lookup

Name string: Name of volume for lookup
ProjectId string: The ID the parent Equinix Metal project (for lookup by name)
VolumeId string: ID of volume for lookup

name string: Name of volume for lookup
projectId string: The ID the parent Equinix Metal project (for lookup by name)
volumeId string: ID of volume for lookup

name str: Name of volume for lookup
project_id str: The ID the parent Equinix Metal project (for lookup by name)
volume_id str: ID of volume for lookup