gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core
gcore.getVolume
Explore with Pulumi AI
Represent volume. A volume is a file storage which is similar to SSD and HDD hard disks
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";
const pr = gcore.getProject({
name: "test",
});
const rg = gcore.getRegion({
name: "ED-10 Preprod",
});
const tv = Promise.all([rg, pr]).then(([rg, pr]) => gcore.getVolume({
name: "test-hd",
regionId: rg.id,
projectId: pr.id,
}));
export const view = tv;
import pulumi
import pulumi_gcore as gcore
pr = gcore.get_project(name="test")
rg = gcore.get_region(name="ED-10 Preprod")
tv = gcore.get_volume(name="test-hd",
region_id=rg.id,
project_id=pr.id)
pulumi.export("view", tv)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
pr, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
Name: "test",
}, nil)
if err != nil {
return err
}
rg, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
Name: "ED-10 Preprod",
}, nil)
if err != nil {
return err
}
tv, err := gcore.LookupVolume(ctx, &gcore.LookupVolumeArgs{
Name: "test-hd",
RegionId: pulumi.Float64Ref(rg.Id),
ProjectId: pulumi.Float64Ref(pr.Id),
}, nil)
if err != nil {
return err
}
ctx.Export("view", tv)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;
return await Deployment.RunAsync(() =>
{
var pr = Gcore.GetProject.Invoke(new()
{
Name = "test",
});
var rg = Gcore.GetRegion.Invoke(new()
{
Name = "ED-10 Preprod",
});
var tv = Gcore.GetVolume.Invoke(new()
{
Name = "test-hd",
RegionId = rg.Apply(getRegionResult => getRegionResult.Id),
ProjectId = pr.Apply(getProjectResult => getProjectResult.Id),
});
return new Dictionary<string, object?>
{
["view"] = tv,
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.GcoreFunctions;
import com.pulumi.gcore.inputs.GetProjectArgs;
import com.pulumi.gcore.inputs.GetRegionArgs;
import com.pulumi.gcore.inputs.GetVolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var pr = GcoreFunctions.getProject(GetProjectArgs.builder()
.name("test")
.build());
final var rg = GcoreFunctions.getRegion(GetRegionArgs.builder()
.name("ED-10 Preprod")
.build());
final var tv = GcoreFunctions.getVolume(GetVolumeArgs.builder()
.name("test-hd")
.regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
.projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
.build());
ctx.export("view", tv.applyValue(getVolumeResult -> getVolumeResult));
}
}
variables:
pr:
fn::invoke:
function: gcore:getProject
arguments:
name: test
rg:
fn::invoke:
function: gcore:getRegion
arguments:
name: ED-10 Preprod
tv:
fn::invoke:
function: gcore:getVolume
arguments:
name: test-hd
regionId: ${rg.id}
projectId: ${pr.id}
outputs:
view: ${tv}
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(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]
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: gcore:index/getVolume:getVolume
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Id string
- The ID of this resource.
- Metadata
K string - Metadata
Kv Dictionary<string, string> - Project
Id double - Project
Name string - Region
Id double - Region
Name string
- Name string
- Id string
- The ID of this resource.
- Metadata
K string - Metadata
Kv map[string]string - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string
- name String
- id String
- The ID of this resource.
- metadata
K String - metadata
Kv Map<String,String> - project
Id Double - project
Name String - region
Id Double - region
Name String
- name string
- id string
- The ID of this resource.
- metadata
K string - metadata
Kv {[key: string]: string} - project
Id number - project
Name string - region
Id number - region
Name string
- name 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 String
- id String
- The ID of this resource.
- metadata
K String - metadata
Kv Map<String> - project
Id Number - project
Name String - region
Id Number - region
Name String
getVolume Result
The following output properties are available:
- Id string
- The ID of this resource.
- Metadata
Read List<GetOnlies Volume Metadata Read Only> - Name string
- Size double
- Type
Name string - Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
- Metadata
K string - Metadata
Kv Dictionary<string, string> - Project
Id double - Project
Name string - Region
Id double - Region
Name string
- Id string
- The ID of this resource.
- Metadata
Read []GetOnlies Volume Metadata Read Only - Name string
- Size float64
- Type
Name string - Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
- Metadata
K string - Metadata
Kv map[string]string - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string
- id String
- The ID of this resource.
- metadata
Read List<GetOnlies Volume Metadata Read Only> - name String
- size Double
- type
Name String - Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
- metadata
K String - metadata
Kv Map<String,String> - project
Id Double - project
Name String - region
Id Double - region
Name String
- id string
- The ID of this resource.
- metadata
Read GetOnlies Volume Metadata Read Only[] - name string
- size number
- type
Name string - Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
- metadata
K string - metadata
Kv {[key: string]: string} - project
Id number - project
Name string - region
Id number - region
Name string
- id str
- The ID of this resource.
- metadata_
read_ Sequence[Getonlies Volume Metadata Read Only] - 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.
- metadata
Read List<Property Map>Onlies - name String
- size Number
- type
Name String - Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard
- metadata
K String - metadata
Kv Map<String> - project
Id Number - project
Name String - region
Id Number - region
Name String
Supporting Types
GetVolumeMetadataReadOnly
Package Details
- Repository
- gcore g-core/terraform-provider-gcore
- License
- Notes
- This Pulumi package is based on the
gcore
Terraform Provider.