Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudStorageFileShare
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.getCloudStorageFileShare

ovh logo
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Get a file storage share (NFS) in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const share = ovh.getCloudStorageFileShare({
    serviceName: "<public cloud project ID>",
    id: "00000000-0000-0000-0000-000000000000",
});

    import pulumi
import pulumi_ovh as ovh

share = ovh.get_cloud_storage_file_share(service_name="<public cloud project ID>",
    id="00000000-0000-0000-0000-000000000000")

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.LookupCloudStorageFileShare(ctx, &ovh.LookupCloudStorageFileShareArgs{
			ServiceName: "<public cloud project ID>",
			Id:          "00000000-0000-0000-0000-000000000000",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var share = Ovh.GetCloudStorageFileShare.Invoke(new()
    {
        ServiceName = "<public cloud project ID>",
        Id = "00000000-0000-0000-0000-000000000000",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.OvhFunctions;
import com.pulumi.ovh.inputs.GetCloudStorageFileShareArgs;
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 share = OvhFunctions.getCloudStorageFileShare(GetCloudStorageFileShareArgs.builder()
            .serviceName("<public cloud project ID>")
            .id("00000000-0000-0000-0000-000000000000")
            .build());

    }
}

    variables:
  share:
    fn::invoke:
      function: ovh:getCloudStorageFileShare
      arguments:
        serviceName: <public cloud project ID>
        id: 00000000-0000-0000-0000-000000000000

    Example coming soon!

    Using getCloudStorageFileShare

    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 getCloudStorageFileShare(args: GetCloudStorageFileShareArgs, opts?: InvokeOptions): Promise<GetCloudStorageFileShareResult>
function getCloudStorageFileShareOutput(args: GetCloudStorageFileShareOutputArgs, opts?: InvokeOptions): Output<GetCloudStorageFileShareResult>
    def get_cloud_storage_file_share(id: Optional[str] = None,
                                 service_name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCloudStorageFileShareResult
def get_cloud_storage_file_share_output(id: pulumi.Input[Optional[str]] = None,
                                 service_name: pulumi.Input[Optional[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetCloudStorageFileShareResult]
    func LookupCloudStorageFileShare(ctx *Context, args *LookupCloudStorageFileShareArgs, opts ...InvokeOption) (*LookupCloudStorageFileShareResult, error)
func LookupCloudStorageFileShareOutput(ctx *Context, args *LookupCloudStorageFileShareOutputArgs, opts ...InvokeOption) LookupCloudStorageFileShareResultOutput

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

    public static class GetCloudStorageFileShare 
{
    public static Task<GetCloudStorageFileShareResult> InvokeAsync(GetCloudStorageFileShareArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudStorageFileShareResult> Invoke(GetCloudStorageFileShareInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudStorageFileShareResult> getCloudStorageFileShare(GetCloudStorageFileShareArgs args, InvokeOptions options)
public static Output<GetCloudStorageFileShareResult> getCloudStorageFileShare(GetCloudStorageFileShareArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:index/getCloudStorageFileShare:getCloudStorageFileShare
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_storage_file_share" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    The ID of the file share.
    ServiceName string
    The id of the public cloud project.
    Id string
    The ID of the file share.
    ServiceName string
    The id of the public cloud project.
    id string
    The ID of the file share.
    service_name string
    The id of the public cloud project.
    id String
    The ID of the file share.
    serviceName String
    The id of the public cloud project.
    id string
    The ID of the file share.
    serviceName string
    The id of the public cloud project.
    id str
    The ID of the file share.
    service_name str
    The id of the public cloud project.
    id String
    The ID of the file share.
    serviceName String
    The id of the public cloud project.

    getCloudStorageFileShare Result

    The following output properties are available:

    AccessRules List<GetCloudStorageFileShareAccessRule>
    Current access rules for the file share:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Access rule creation date.
    CurrentState GetCloudStorageFileShareCurrentState
    Current state of the file storage share:
    Description string
    File share description.
    Id string
    Access rule ID.
    Location GetCloudStorageFileShareLocation
    Current location:
    Name string
    Capability name.
    Protocol string
    File share protocol.
    ResourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    ShareNetworkId string
    ID of the share network the file share is attached to.
    ShareType string
    File share type.
    Size int
    Size of the file share in GB.
    UpdatedAt string
    Last update date of the file share.
    AccessRules []GetCloudStorageFileShareAccessRule
    Current access rules for the file share:
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Access rule creation date.
    CurrentState GetCloudStorageFileShareCurrentState
    Current state of the file storage share:
    Description string
    File share description.
    Id string
    Access rule ID.
    Location GetCloudStorageFileShareLocation
    Current location:
    Name string
    Capability name.
    Protocol string
    File share protocol.
    ResourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    ShareNetworkId string
    ID of the share network the file share is attached to.
    ShareType string
    File share type.
    Size int
    Size of the file share in GB.
    UpdatedAt string
    Last update date of the file share.
    access_rules list(object)
    Current access rules for the file share:
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Access rule creation date.
    current_state object
    Current state of the file storage share:
    description string
    File share description.
    id string
    Access rule ID.
    location object
    Current location:
    name string
    Capability name.
    protocol string
    File share protocol.
    resource_status string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    share_network_id string
    ID of the share network the file share is attached to.
    share_type string
    File share type.
    size number
    Size of the file share in GB.
    updated_at string
    Last update date of the file share.
    accessRules List<GetCloudStorageFileShareAccessRule>
    Current access rules for the file share:
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Access rule creation date.
    currentState GetCloudStorageFileShareCurrentState
    Current state of the file storage share:
    description String
    File share description.
    id String
    Access rule ID.
    location GetCloudStorageFileShareLocation
    Current location:
    name String
    Capability name.
    protocol String
    File share protocol.
    resourceStatus String
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    shareNetworkId String
    ID of the share network the file share is attached to.
    shareType String
    File share type.
    size Integer
    Size of the file share in GB.
    updatedAt String
    Last update date of the file share.
    accessRules GetCloudStorageFileShareAccessRule[]
    Current access rules for the file share:
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Access rule creation date.
    currentState GetCloudStorageFileShareCurrentState
    Current state of the file storage share:
    description string
    File share description.
    id string
    Access rule ID.
    location GetCloudStorageFileShareLocation
    Current location:
    name string
    Capability name.
    protocol string
    File share protocol.
    resourceStatus string
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    shareNetworkId string
    ID of the share network the file share is attached to.
    shareType string
    File share type.
    size number
    Size of the file share in GB.
    updatedAt string
    Last update date of the file share.
    access_rules Sequence[GetCloudStorageFileShareAccessRule]
    Current access rules for the file share:
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Access rule creation date.
    current_state GetCloudStorageFileShareCurrentState
    Current state of the file storage share:
    description str
    File share description.
    id str
    Access rule ID.
    location GetCloudStorageFileShareLocation
    Current location:
    name str
    Capability name.
    protocol str
    File share protocol.
    resource_status str
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    share_network_id str
    ID of the share network the file share is attached to.
    share_type str
    File share type.
    size int
    Size of the file share in GB.
    updated_at str
    Last update date of the file share.
    accessRules List<Property Map>
    Current access rules for the file share:
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Access rule creation date.
    currentState Property Map
    Current state of the file storage share:
    description String
    File share description.
    id String
    Access rule ID.
    location Property Map
    Current location:
    name String
    Capability name.
    protocol String
    File share protocol.
    resourceStatus String
    File share readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    shareNetworkId String
    ID of the share network the file share is attached to.
    shareType String
    File share type.
    size Number
    Size of the file share in GB.
    updatedAt String
    Last update date of the file share.

    Supporting Types

    GetCloudStorageFileShareAccessRule

    AccessLevel string
    Access level.
    AccessTo string
    IP address or CIDR.
    AccessLevel string
    Access level.
    AccessTo string
    IP address or CIDR.
    access_level string
    Access level.
    access_to string
    IP address or CIDR.
    accessLevel String
    Access level.
    accessTo String
    IP address or CIDR.
    accessLevel string
    Access level.
    accessTo string
    IP address or CIDR.
    access_level str
    Access level.
    access_to str
    IP address or CIDR.
    accessLevel String
    Access level.
    accessTo String
    IP address or CIDR.

    GetCloudStorageFileShareCurrentState

    AccessRules List<GetCloudStorageFileShareCurrentStateAccessRule>
    Current access rules for the file share:
    Capabilities List<GetCloudStorageFileShareCurrentStateCapability>
    Action-availability flags derived from the file share status:
    Description string
    File share description.
    ExportLocations List<GetCloudStorageFileShareCurrentStateExportLocation>
    Export locations for the file share:
    Location GetCloudStorageFileShareCurrentStateLocation
    Current location:
    Name string
    Capability name.
    Protocol string
    File share protocol.
    ShareNetworkId string
    ID of the share network the file share is attached to.
    ShareType string
    File share type.
    Size int
    Size of the file share in GB.
    AccessRules []GetCloudStorageFileShareCurrentStateAccessRule
    Current access rules for the file share:
    Capabilities []GetCloudStorageFileShareCurrentStateCapability
    Action-availability flags derived from the file share status:
    Description string
    File share description.
    ExportLocations []GetCloudStorageFileShareCurrentStateExportLocation
    Export locations for the file share:
    Location GetCloudStorageFileShareCurrentStateLocation
    Current location:
    Name string
    Capability name.
    Protocol string
    File share protocol.
    ShareNetworkId string
    ID of the share network the file share is attached to.
    ShareType string
    File share type.
    Size int
    Size of the file share in GB.
    access_rules list(object)
    Current access rules for the file share:
    capabilities list(object)
    Action-availability flags derived from the file share status:
    description string
    File share description.
    export_locations list(object)
    Export locations for the file share:
    location object
    Current location:
    name string
    Capability name.
    protocol string
    File share protocol.
    share_network_id string
    ID of the share network the file share is attached to.
    share_type string
    File share type.
    size number
    Size of the file share in GB.
    accessRules List<GetCloudStorageFileShareCurrentStateAccessRule>
    Current access rules for the file share:
    capabilities List<GetCloudStorageFileShareCurrentStateCapability>
    Action-availability flags derived from the file share status:
    description String
    File share description.
    exportLocations List<GetCloudStorageFileShareCurrentStateExportLocation>
    Export locations for the file share:
    location GetCloudStorageFileShareCurrentStateLocation
    Current location:
    name String
    Capability name.
    protocol String
    File share protocol.
    shareNetworkId String
    ID of the share network the file share is attached to.
    shareType String
    File share type.
    size Integer
    Size of the file share in GB.
    accessRules GetCloudStorageFileShareCurrentStateAccessRule[]
    Current access rules for the file share:
    capabilities GetCloudStorageFileShareCurrentStateCapability[]
    Action-availability flags derived from the file share status:
    description string
    File share description.
    exportLocations GetCloudStorageFileShareCurrentStateExportLocation[]
    Export locations for the file share:
    location GetCloudStorageFileShareCurrentStateLocation
    Current location:
    name string
    Capability name.
    protocol string
    File share protocol.
    shareNetworkId string
    ID of the share network the file share is attached to.
    shareType string
    File share type.
    size number
    Size of the file share in GB.
    access_rules Sequence[GetCloudStorageFileShareCurrentStateAccessRule]
    Current access rules for the file share:
    capabilities Sequence[GetCloudStorageFileShareCurrentStateCapability]
    Action-availability flags derived from the file share status:
    description str
    File share description.
    export_locations Sequence[GetCloudStorageFileShareCurrentStateExportLocation]
    Export locations for the file share:
    location GetCloudStorageFileShareCurrentStateLocation
    Current location:
    name str
    Capability name.
    protocol str
    File share protocol.
    share_network_id str
    ID of the share network the file share is attached to.
    share_type str
    File share type.
    size int
    Size of the file share in GB.
    accessRules List<Property Map>
    Current access rules for the file share:
    capabilities List<Property Map>
    Action-availability flags derived from the file share status:
    description String
    File share description.
    exportLocations List<Property Map>
    Export locations for the file share:
    location Property Map
    Current location:
    name String
    Capability name.
    protocol String
    File share protocol.
    shareNetworkId String
    ID of the share network the file share is attached to.
    shareType String
    File share type.
    size Number
    Size of the file share in GB.

    GetCloudStorageFileShareCurrentStateAccessRule

    AccessLevel string
    Access level.
    AccessTo string
    IP address or CIDR.
    CreatedAt string
    Access rule creation date.
    Id string
    The ID of the file share.
    State string
    Access rule state.
    AccessLevel string
    Access level.
    AccessTo string
    IP address or CIDR.
    CreatedAt string
    Access rule creation date.
    Id string
    The ID of the file share.
    State string
    Access rule state.
    access_level string
    Access level.
    access_to string
    IP address or CIDR.
    created_at string
    Access rule creation date.
    id string
    The ID of the file share.
    state string
    Access rule state.
    accessLevel String
    Access level.
    accessTo String
    IP address or CIDR.
    createdAt String
    Access rule creation date.
    id String
    The ID of the file share.
    state String
    Access rule state.
    accessLevel string
    Access level.
    accessTo string
    IP address or CIDR.
    createdAt string
    Access rule creation date.
    id string
    The ID of the file share.
    state string
    Access rule state.
    access_level str
    Access level.
    access_to str
    IP address or CIDR.
    created_at str
    Access rule creation date.
    id str
    The ID of the file share.
    state str
    Access rule state.
    accessLevel String
    Access level.
    accessTo String
    IP address or CIDR.
    createdAt String
    Access rule creation date.
    id String
    The ID of the file share.
    state String
    Access rule state.

    GetCloudStorageFileShareCurrentStateCapability

    Enabled bool
    Whether the capability is enabled.
    Name string
    Capability name.
    Reason string
    Reason why the capability is disabled.
    Enabled bool
    Whether the capability is enabled.
    Name string
    Capability name.
    Reason string
    Reason why the capability is disabled.
    enabled bool
    Whether the capability is enabled.
    name string
    Capability name.
    reason string
    Reason why the capability is disabled.
    enabled Boolean
    Whether the capability is enabled.
    name String
    Capability name.
    reason String
    Reason why the capability is disabled.
    enabled boolean
    Whether the capability is enabled.
    name string
    Capability name.
    reason string
    Reason why the capability is disabled.
    enabled bool
    Whether the capability is enabled.
    name str
    Capability name.
    reason str
    Reason why the capability is disabled.
    enabled Boolean
    Whether the capability is enabled.
    name String
    Capability name.
    reason String
    Reason why the capability is disabled.

    GetCloudStorageFileShareCurrentStateExportLocation

    Path string
    Export path.
    Preferred bool
    Whether this is the preferred export location.
    Path string
    Export path.
    Preferred bool
    Whether this is the preferred export location.
    path string
    Export path.
    preferred bool
    Whether this is the preferred export location.
    path String
    Export path.
    preferred Boolean
    Whether this is the preferred export location.
    path string
    Export path.
    preferred boolean
    Whether this is the preferred export location.
    path str
    Export path.
    preferred bool
    Whether this is the preferred export location.
    path String
    Export path.
    preferred Boolean
    Whether this is the preferred export location.

    GetCloudStorageFileShareCurrentStateLocation

    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    availability_zone string
    Availability zone.
    region string
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.
    availabilityZone string
    Availability zone.
    region string
    Region.
    availability_zone str
    Availability zone.
    region str
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.

    GetCloudStorageFileShareLocation

    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    AvailabilityZone string
    Availability zone.
    Region string
    Region.
    availability_zone string
    Availability zone.
    region string
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.
    availabilityZone string
    Availability zone.
    region string
    Region.
    availability_zone str
    Availability zone.
    region str
    Region.
    availabilityZone String
    Availability zone.
    region String
    Region.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.17.0
    published on Friday, Jul 17, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial