Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Hetzner Cloud
  5. GetVolume

GetVolume

Using GetVolume

function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
def get_volume(id: Optional[int] = None, location: Optional[str] = None, name: Optional[str] = None, selector: Optional[str] = None, server: Optional[str] = None, with_selector: Optional[str] = None, with_statuses: Optional[Sequence[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:

Id int

ID of the volume.

Location string
Name string

Name of the volume.

Selector string

Deprecated: Please use the with_selector property instead.

Server string
WithSelector string

Label Selector. For more information about possible values, visit the Hetzner Cloud Documentation.

WithStatuses List<string>

List only volumes with the specified status, could contain creating or available.

Id int

ID of the volume.

Location string
Name string

Name of the volume.

Selector string

Deprecated: Please use the with_selector property instead.

Server string
WithSelector string

Label Selector. For more information about possible values, visit the Hetzner Cloud Documentation.

WithStatuses []string

List only volumes with the specified status, could contain creating or available.

id number

ID of the volume.

location string
name string

Name of the volume.

selector string

Deprecated: Please use the with_selector property instead.

server string
withSelector string

Label Selector. For more information about possible values, visit the Hetzner Cloud Documentation.

withStatuses string[]

List only volumes with the specified status, could contain creating or available.

id int

ID of the volume.

location str
name str

Name of the volume.

selector str

Deprecated: Please use the with_selector property instead.

server str
with_selector str

Label Selector. For more information about possible values, visit the Hetzner Cloud Documentation.

with_statuses Sequence[str]

List only volumes with the specified status, could contain creating or available.

GetVolume Result

The following output properties are available:

Id int

Unique ID of the volume.

Labels Dictionary<string, object>
LinuxDevice string
Name string

Name of the volume.

Size int

Size of the volume.

Location string
Selector string

Deprecated: Please use the with_selector property instead.

Server string
WithSelector string
WithStatuses List<string>
Id int

Unique ID of the volume.

Labels map[string]interface{}
LinuxDevice string
Name string

Name of the volume.

Size int

Size of the volume.

Location string
Selector string

Deprecated: Please use the with_selector property instead.

Server string
WithSelector string
WithStatuses []string
id number

Unique ID of the volume.

labels {[key: string]: any}
linuxDevice string
name string

Name of the volume.

size number

Size of the volume.

location string
selector string

Deprecated: Please use the with_selector property instead.

server string
withSelector string
withStatuses string[]
id int

Unique ID of the volume.

labels Mapping[str, Any]
linux_device str
name str

Name of the volume.

size int

Size of the volume.

location str
selector str

Deprecated: Please use the with_selector property instead.

server str
with_selector str
with_statuses Sequence[str]

Package Details

Repository
https://github.com/pulumi/pulumi-hcloud
License
Apache-2.0
Notes
This Pulumi package is based on the hcloud Terraform Provider.