Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Gcorelabs Provider
  3. API Docs
  4. getVolume
gcorelabs 0.3.63 published on Monday, Apr 14, 2025 by g-core
g-core/terraform-provider-gcorelabs

gcorelabs.getVolume

Explore with Pulumi AI

gcorelabs 0.3.63 published on Monday, Apr 14, 2025 by g-core
g-core/terraform-provider-gcorelabs

Represent volume. A volume is a file storage which is similar to SSD and HDD hard disks

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>
Copy
def get_volume(id: Optional[str] = None,
               metadata_k: Optional[str] = None,
               metadata_kv: Optional[Mapping[str, str]] = None,
               name: Optional[str] = None,
               project_id: Optional[float] = None,
               project_name: Optional[str] = None,
               region_id: Optional[float] = None,
               region_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(id: Optional[pulumi.Input[str]] = None,
               metadata_k: Optional[pulumi.Input[str]] = None,
               metadata_kv: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[float]] = None,
               project_name: Optional[pulumi.Input[str]] = None,
               region_id: Optional[pulumi.Input[float]] = None,
               region_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
Copy
func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcorelabs:index/getVolume:getVolume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Id string
The ID of this resource.
MetadataK string
MetadataKv Dictionary<string, string>
ProjectId double
ProjectName string
RegionId double
RegionName string
Name This property is required. string
Id string
The ID of this resource.
MetadataK string
MetadataKv map[string]string
ProjectId float64
ProjectName string
RegionId float64
RegionName string
name This property is required. String
id String
The ID of this resource.
metadataK String
metadataKv Map<String,String>
projectId Double
projectName String
regionId Double
regionName String
name This property is required. string
id string
The ID of this resource.
metadataK string
metadataKv {[key: string]: string}
projectId number
projectName string
regionId number
regionName string
name This property is required. str
id str
The ID of this resource.
metadata_k str
metadata_kv Mapping[str, str]
project_id float
project_name str
region_id float
region_name str
name This property is required. String
id String
The ID of this resource.
metadataK String
metadataKv Map<String>
projectId Number
projectName String
regionId Number
regionName String

getVolume Result

The following output properties are available:

Id string
The ID of this resource.
MetadataReadOnlies List<GetVolumeMetadataReadOnly>
Name string
Size double
TypeName string
Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
MetadataK string
MetadataKv Dictionary<string, string>
ProjectId double
ProjectName string
RegionId double
RegionName string
Id string
The ID of this resource.
MetadataReadOnlies []GetVolumeMetadataReadOnly
Name string
Size float64
TypeName string
Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
MetadataK string
MetadataKv map[string]string
ProjectId float64
ProjectName string
RegionId float64
RegionName string
id String
The ID of this resource.
metadataReadOnlies List<GetVolumeMetadataReadOnly>
name String
size Double
typeName String
Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
metadataK String
metadataKv Map<String,String>
projectId Double
projectName String
regionId Double
regionName String
id string
The ID of this resource.
metadataReadOnlies GetVolumeMetadataReadOnly[]
name string
size number
typeName string
Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
metadataK string
metadataKv {[key: string]: string}
projectId number
projectName string
regionId number
regionName string
id str
The ID of this resource.
metadata_read_onlies Sequence[GetVolumeMetadataReadOnly]
name str
size float
type_name str
Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
metadata_k str
metadata_kv Mapping[str, str]
project_id float
project_name str
region_id float
region_name str
id String
The ID of this resource.
metadataReadOnlies List<Property Map>
name String
size Number
typeName String
Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
metadataK String
metadataKv Map<String>
projectId Number
projectName String
regionId Number
regionName String

Supporting Types

GetVolumeMetadataReadOnly

Key This property is required. string
ReadOnly This property is required. bool
Value This property is required. string
Key This property is required. string
ReadOnly This property is required. bool
Value This property is required. string
key This property is required. String
readOnly This property is required. Boolean
value This property is required. String
key This property is required. string
readOnly This property is required. boolean
value This property is required. string
key This property is required. str
read_only This property is required. bool
value This property is required. str
key This property is required. String
readOnly This property is required. Boolean
value This property is required. String

Package Details

Repository
gcorelabs g-core/terraform-provider-gcorelabs
License
Notes
This Pulumi package is based on the gcorelabs Terraform Provider.
gcorelabs 0.3.63 published on Monday, Apr 14, 2025 by g-core
g-core/terraform-provider-gcorelabs