getCloudFileShares

gcore 2.0.0-alpha.3, Mar 30 26

Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";

const exampleCloudFileShares = gcore.getCloudFileShares({
    projectId: 1,
    regionId: 1,
    name: "test-sfs",
    typeName: "standard",
});

import pulumi
import pulumi_gcore as gcore

example_cloud_file_shares = gcore.get_cloud_file_shares(project_id=1,
    region_id=1,
    name="test-sfs",
    type_name="standard")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.GetCloudFileShares(ctx, &gcore.GetCloudFileSharesArgs{
			ProjectId: pulumi.Float64Ref(1),
			RegionId:  pulumi.Float64Ref(1),
			Name:      pulumi.StringRef("test-sfs"),
			TypeName:  pulumi.StringRef("standard"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    var exampleCloudFileShares = Gcore.GetCloudFileShares.Invoke(new()
    {
        ProjectId = 1,
        RegionId = 1,
        Name = "test-sfs",
        TypeName = "standard",
    });

});

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.GetCloudFileSharesArgs;
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 exampleCloudFileShares = GcoreFunctions.getCloudFileShares(GetCloudFileSharesArgs.builder()
            .projectId(1)
            .regionId(1)
            .name("test-sfs")
            .typeName("standard")
            .build());

    }
}

variables:
  exampleCloudFileShares:
    fn::invoke:
      function: gcore:getCloudFileShares
      arguments:
        projectId: 1
        regionId: 1
        name: test-sfs
        typeName: standard

Using getCloudFileShares

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 getCloudFileShares(args: GetCloudFileSharesArgs, opts?: InvokeOptions): Promise<GetCloudFileSharesResult>
function getCloudFileSharesOutput(args: GetCloudFileSharesOutputArgs, opts?: InvokeOptions): Output<GetCloudFileSharesResult>

def get_cloud_file_shares(max_items: Optional[float] = None,
                          name: Optional[str] = None,
                          project_id: Optional[float] = None,
                          region_id: Optional[float] = None,
                          type_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCloudFileSharesResult
def get_cloud_file_shares_output(max_items: Optional[pulumi.Input[float]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          project_id: Optional[pulumi.Input[float]] = None,
                          region_id: Optional[pulumi.Input[float]] = None,
                          type_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCloudFileSharesResult]

func GetCloudFileShares(ctx *Context, args *GetCloudFileSharesArgs, opts ...InvokeOption) (*GetCloudFileSharesResult, error)
func GetCloudFileSharesOutput(ctx *Context, args *GetCloudFileSharesOutputArgs, opts ...InvokeOption) GetCloudFileSharesResultOutput

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

public static class GetCloudFileShares 
{
    public static Task<GetCloudFileSharesResult> InvokeAsync(GetCloudFileSharesArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudFileSharesResult> Invoke(GetCloudFileSharesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudFileSharesResult> getCloudFileShares(GetCloudFileSharesArgs args, InvokeOptions options)
public static Output<GetCloudFileSharesResult> getCloudFileShares(GetCloudFileSharesArgs args, InvokeOptions options)

fn::invoke:
  function: gcore:index/getCloudFileShares:getCloudFileShares
  arguments:
    # arguments dictionary

The following arguments are supported:

MaxItems double
Name string
ProjectId double
RegionId double
TypeName string

MaxItems float64
Name string
ProjectId float64
RegionId float64
TypeName string

maxItems Double
name String
projectId Double
regionId Double
typeName String

maxItems number
name string
projectId number
regionId number
typeName string

max_items float
name str
project_id float
region_id float
type_name str

maxItems Number
name String
projectId Number
regionId Number
typeName String

getCloudFileShares Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetCloudFileSharesItem>
MaxItems double
Name string
ProjectId double
RegionId double
TypeName string

Id string: The provider-assigned unique ID for this managed resource.
Items []GetCloudFileSharesItem
MaxItems float64
Name string
ProjectId float64
RegionId float64
TypeName string

id String: The provider-assigned unique ID for this managed resource.
items List<GetCloudFileSharesItem>
maxItems Double
name String
projectId Double
regionId Double
typeName String

id string: The provider-assigned unique ID for this managed resource.
items GetCloudFileSharesItem[]
maxItems number
name string
projectId number
regionId number
typeName string

id str: The provider-assigned unique ID for this managed resource.
items Sequence[GetCloudFileSharesItem]
max_items float
name str
project_id float
region_id float
type_name str

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>
maxItems Number
name String
projectId Number
regionId Number
typeName String

Supporting Types

GetCloudFileSharesItem

ConnectionPoint string: Connection point. Can be null during File share creation
CreatedAt string: Datetime when the file share was created
CreatorTaskId string: Task that created this entity
Id string: File share ID
Name string: File share name
NetworkId string: Network ID.
NetworkName string: Network name.
ProjectId double: Project ID
Protocol string: File share protocol
Region string: Region name
RegionId double: Region ID
ShareNetworkName string: Share network name. May be null if the file share was created with volume type VAST
ShareSettings GetCloudFileSharesItemShareSettings: Share settings specific to the file share type
Size double: File share size in GiB
Status string: File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
SubnetId string: Subnet ID.
SubnetName string: Subnet name.
Tags List<GetCloudFileSharesItemTag>: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
TypeName string: File share type name Available values: "standard", "vast".

ConnectionPoint string: Connection point. Can be null during File share creation
CreatedAt string: Datetime when the file share was created
CreatorTaskId string: Task that created this entity
Id string: File share ID
Name string: File share name
NetworkId string: Network ID.
NetworkName string: Network name.
ProjectId float64: Project ID
Protocol string: File share protocol
Region string: Region name
RegionId float64: Region ID
ShareNetworkName string: Share network name. May be null if the file share was created with volume type VAST
ShareSettings GetCloudFileSharesItemShareSettings: Share settings specific to the file share type
Size float64: File share size in GiB
Status string: File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
SubnetId string: Subnet ID.
SubnetName string: Subnet name.
Tags []GetCloudFileSharesItemTag: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
TypeName string: File share type name Available values: "standard", "vast".

connectionPoint String: Connection point. Can be null during File share creation
createdAt String: Datetime when the file share was created
creatorTaskId String: Task that created this entity
id String: File share ID
name String: File share name
networkId String: Network ID.
networkName String: Network name.
projectId Double: Project ID
protocol String: File share protocol
region String: Region name
regionId Double: Region ID
shareNetworkName String: Share network name. May be null if the file share was created with volume type VAST
shareSettings GetCloudFileSharesItemShareSettings: Share settings specific to the file share type
size Double: File share size in GiB
status String: File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
subnetId String: Subnet ID.
subnetName String: Subnet name.
tags List<GetCloudFileSharesItemTag>: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
typeName String: File share type name Available values: "standard", "vast".

connectionPoint string: Connection point. Can be null during File share creation
createdAt string: Datetime when the file share was created
creatorTaskId string: Task that created this entity
id string: File share ID
name string: File share name
networkId string: Network ID.
networkName string: Network name.
projectId number: Project ID
protocol string: File share protocol
region string: Region name
regionId number: Region ID
shareNetworkName string: Share network name. May be null if the file share was created with volume type VAST
shareSettings GetCloudFileSharesItemShareSettings: Share settings specific to the file share type
size number: File share size in GiB
status string: File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
subnetId string: Subnet ID.
subnetName string: Subnet name.
tags GetCloudFileSharesItemTag[]: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
typeName string: File share type name Available values: "standard", "vast".

connection_point str: Connection point. Can be null during File share creation
created_at str: Datetime when the file share was created
creator_task_id str: Task that created this entity
id str: File share ID
name str: File share name
network_id str: Network ID.
network_name str: Network name.
project_id float: Project ID
protocol str: File share protocol
region str: Region name
region_id float: Region ID
share_network_name str: Share network name. May be null if the file share was created with volume type VAST
share_settings GetCloudFileSharesItemShareSettings: Share settings specific to the file share type
size float: File share size in GiB
status str: File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
subnet_id str: Subnet ID.
subnet_name str: Subnet name.
tags Sequence[GetCloudFileSharesItemTag]: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
type_name str: File share type name Available values: "standard", "vast".

connectionPoint String: Connection point. Can be null during File share creation
createdAt String: Datetime when the file share was created
creatorTaskId String: Task that created this entity
id String: File share ID
name String: File share name
networkId String: Network ID.
networkName String: Network name.
projectId Number: Project ID
protocol String: File share protocol
region String: Region name
regionId Number: Region ID
shareNetworkName String: Share network name. May be null if the file share was created with volume type VAST
shareSettings Property Map: Share settings specific to the file share type
size Number: File share size in GiB
status String: File share status Available values: "available", "awaiting_transfer", "backup_creating", "backup_restoring", "backup_restoring_error", "creating", "creating_from_snapshot", "deleted", "deleting", "ensuring", "error", "error_deleting", "extending", "extending_error", "inactive", "manage_error", "manage_starting", "migrating", "migrating_to", "replication_change", "reverting", "reverting_error", "shrinking", "shrinking_error", "shrinking_possible_data_loss_error", "unmanage_error", "unmanage_starting", "unmanaged".
subnetId String: Subnet ID.
subnetName String: Subnet name.
tags List<Property Map>: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
typeName String: File share type name Available values: "standard", "vast".

GetCloudFileSharesItemShareSettings

AllowedCharacters string

Available values: "LCD", "NPL".

PathLength string

Available values: "LCD", "NPL".

RootSquash bool

Enables or disables root squash for NFS clients.

If true, root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
If false, root squash is disabled: the NFS client root user retains root privileges.

TypeName string

Standard file share type Available values: "standard", "vast".

AllowedCharacters string

Available values: "LCD", "NPL".

PathLength string

Available values: "LCD", "NPL".

RootSquash bool

Enables or disables root squash for NFS clients.

If true, root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
If false, root squash is disabled: the NFS client root user retains root privileges.

TypeName string

Standard file share type Available values: "standard", "vast".

allowedCharacters String

Available values: "LCD", "NPL".

pathLength String

Available values: "LCD", "NPL".

rootSquash Boolean

Enables or disables root squash for NFS clients.

If true, root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
If false, root squash is disabled: the NFS client root user retains root privileges.

typeName String

Standard file share type Available values: "standard", "vast".

allowedCharacters string

Available values: "LCD", "NPL".

pathLength string

Available values: "LCD", "NPL".

rootSquash boolean

Enables or disables root squash for NFS clients.

If true, root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
If false, root squash is disabled: the NFS client root user retains root privileges.

typeName string

Standard file share type Available values: "standard", "vast".

allowed_characters str

Available values: "LCD", "NPL".

path_length str

Available values: "LCD", "NPL".

root_squash bool

Enables or disables root squash for NFS clients.

If true, root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
If false, root squash is disabled: the NFS client root user retains root privileges.

type_name str

Standard file share type Available values: "standard", "vast".

allowedCharacters String

Available values: "LCD", "NPL".

pathLength String

Available values: "LCD", "NPL".

rootSquash Boolean

Enables or disables root squash for NFS clients.

If true, root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export.
If false, root squash is disabled: the NFS client root user retains root privileges.

typeName String

Standard file share type Available values: "standard", "vast".

GetCloudFileSharesItemTag

Key string: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
ReadOnly bool: If true, the tag is read-only and cannot be modified by the user
Value string: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

Key string: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
ReadOnly bool: If true, the tag is read-only and cannot be modified by the user
Value string: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key String: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
readOnly Boolean: If true, the tag is read-only and cannot be modified by the user
value String: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key string: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
readOnly boolean: If true, the tag is read-only and cannot be modified by the user
value string: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key str: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
read_only bool: If true, the tag is read-only and cannot be modified by the user
value str: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key String: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
readOnly Boolean: If true, the tag is read-only and cannot be modified by the user
value String: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.