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/go/equinix-metal"
"github.com/pulumi/pulumi/sdk/v2/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 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
getVolume Result
The following output properties are available:
- Billing
Cycle string The billing cycle, defaults to hourly
- Created string
- Description string
- Device
Ids List<string> UUIDs of devices to which this volume is attached
- Facility string
The facility slug the volume resides in
- Id string
The provider-assigned unique ID for this managed resource.
- Locked bool
Whether the volume is locked or not
- Name string
The name of the volume
- Plan string
Performance plan the volume is on
- Project
Id string The project id the volume is in
- Size int
The size in GB of the volume
- Snapshot
Policies List<Pulumi.Equinix Metal. Outputs. Get Volume Snapshot Policy> - State string
The state of the volume
- Updated string
- Volume
Id string
- Billing
Cycle string The billing cycle, defaults to hourly
- Created string
- Description string
- Device
Ids []string UUIDs of devices to which this volume is attached
- Facility string
The facility slug the volume resides in
- Id string
The provider-assigned unique ID for this managed resource.
- Locked bool
Whether the volume is locked or not
- Name string
The name of the volume
- Plan string
Performance plan the volume is on
- Project
Id string The project id the volume is in
- Size int
The size in GB of the volume
- Snapshot
Policies []GetVolume Snapshot Policy - State string
The state of the volume
- Updated string
- Volume
Id string
- billing
Cycle string The billing cycle, defaults to hourly
- created string
- description string
- device
Ids string[] UUIDs of devices to which this volume is attached
- facility string
The facility slug the volume resides in
- id string
The provider-assigned unique ID for this managed resource.
- locked boolean
Whether the volume is locked or not
- name string
The name of the volume
- plan string
Performance plan the volume is on
- project
Id string The project id the volume is in
- size number
The size in GB of the volume
- snapshot
Policies GetVolume Snapshot Policy[] - state string
The state of the volume
- updated string
- volume
Id string
- billing_
cycle str The billing cycle, defaults to hourly
- created str
- description str
- device_
ids Sequence[str] UUIDs of devices to which this volume is attached
- facility str
The facility slug the volume resides in
- id str
The provider-assigned unique ID for this managed resource.
- locked bool
Whether the volume is locked or not
- name str
The name of the volume
- plan str
Performance plan the volume is on
- project_
id str The project id the volume is in
- size int
The size in GB of the volume
- snapshot_
policies Sequence[GetVolume Snapshot Policy] - state str
The state of the volume
- updated str
- volume_
id str
Supporting Types
GetVolumeSnapshotPolicy
- Snapshot
Count int - Snapshot
Frequency string
- Snapshot
Count int - Snapshot
Frequency string
- snapshot
Count number - snapshot
Frequency string
- snapshot_
count int - snapshot_
frequency str
Package Details
- Repository
- https://github.com/pulumi/pulumi-equinix-metal
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
metal
Terraform Provider.