1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. getVolume

This package is deprecated. We recommend using the new Equinix package.

Viewing docs for Equinix Metal v3.2.1
published on Thursday, Dec 30, 2021 by DEPRECATED
Schema (JSON)
pulumi/pulumi-equinix-metal

equinix-metal.getVolume

equinix-metal logo

This package is deprecated. We recommend using the new Equinix package.

Viewing docs for Equinix Metal v3.2.1
published on Thursday, Dec 30, 2021 by DEPRECATED
Schema (JSON)
pulumi/pulumi-equinix-metal

    Datasource equinix-metal.Volume was removed in version 3.0.0, and the API support was deprecated on June 1st 2021. See https://metal.equinix.com/developers/docs/storage/elastic-block-storage/#elastic-block-storage for more details.

    Using getVolume

    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 getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>
    def get_volume(name: Optional[str] = None,
               project_id: Optional[str] = None,
               volume_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               volume_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
    func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

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

    public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

    fn::invoke:
  function: equinix-metal:index/getVolume:getVolume
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    ProjectId string
    VolumeId string
    Name string
    ProjectId string
    VolumeId string
    name String
    projectId String
    volumeId String
    name string
    projectId string
    volumeId string
    name String
    projectId String
    volumeId String

    getVolume Result

    The following output properties are available:

    BillingCycle string
    Created string
    Description string
    DeviceIds List<string>
    Facility string
    Id string
    The provider-assigned unique ID for this managed resource.
    Locked bool
    Name string
    Plan string
    ProjectId string
    Size int
    SnapshotPolicies List<Pulumi.EquinixMetal.Outputs.GetVolumeSnapshotPolicy>
    State string
    Updated string
    VolumeId string
    BillingCycle string
    Created string
    Description string
    DeviceIds []string
    Facility string
    Id string
    The provider-assigned unique ID for this managed resource.
    Locked bool
    Name string
    Plan string
    ProjectId string
    Size int
    SnapshotPolicies []GetVolumeSnapshotPolicy
    State string
    Updated string
    VolumeId string
    billingCycle String
    created String
    description String
    deviceIds List<String>
    facility String
    id String
    The provider-assigned unique ID for this managed resource.
    locked Boolean
    name String
    plan String
    projectId String
    size Integer
    snapshotPolicies List<GetVolumeSnapshotPolicy>
    state String
    updated String
    volumeId String
    billingCycle string
    created string
    description string
    deviceIds string[]
    facility string
    id string
    The provider-assigned unique ID for this managed resource.
    locked boolean
    name string
    plan string
    projectId string
    size number
    snapshotPolicies GetVolumeSnapshotPolicy[]
    state string
    updated string
    volumeId string
    billing_cycle str
    created str
    description str
    device_ids Sequence[str]
    facility str
    id str
    The provider-assigned unique ID for this managed resource.
    locked bool
    name str
    plan str
    project_id str
    size int
    snapshot_policies Sequence[GetVolumeSnapshotPolicy]
    state str
    updated str
    volume_id str
    billingCycle String
    created String
    description String
    deviceIds List<String>
    facility String
    id String
    The provider-assigned unique ID for this managed resource.
    locked Boolean
    name String
    plan String
    projectId String
    size Number
    snapshotPolicies List<Property Map>
    state String
    updated String
    volumeId String

    Supporting Types

    GetVolumeSnapshotPolicy

    Package Details

    Repository
    Equinix Metal pulumi/pulumi-equinix-metal
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the metal Terraform Provider.
    equinix-metal logo

    This package is deprecated. We recommend using the new Equinix package.

    Viewing docs for Equinix Metal v3.2.1
    published on Thursday, Dec 30, 2021 by DEPRECATED
    Schema (JSON)
    pulumi/pulumi-equinix-metal
      Try Pulumi Cloud free. Your team will thank you.