1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudStorageFileShareNetworks
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud

    List the file storage share networks in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const networks = ovh.getCloudStorageFileShareNetworks({
        serviceName: "<public cloud project ID>",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    networks = ovh.get_cloud_storage_file_share_networks(service_name="<public cloud project ID>")
    
    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.GetCloudStorageFileShareNetworks(ctx, &ovh.GetCloudStorageFileShareNetworksArgs{
    			ServiceName: "<public cloud project ID>",
    		}, 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 networks = Ovh.GetCloudStorageFileShareNetworks.Invoke(new()
        {
            ServiceName = "<public cloud project ID>",
        });
    
    });
    
    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.GetCloudStorageFileShareNetworksArgs;
    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 networks = OvhFunctions.getCloudStorageFileShareNetworks(GetCloudStorageFileShareNetworksArgs.builder()
                .serviceName("<public cloud project ID>")
                .build());
    
        }
    }
    
    variables:
      networks:
        fn::invoke:
          function: ovh:getCloudStorageFileShareNetworks
          arguments:
            serviceName: <public cloud project ID>
    
    Example coming soon!
    

    Filter the share networks by region:

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const networks = ovh.getCloudStorageFileShareNetworks({
        serviceName: "<public cloud project ID>",
        region: "GRA9",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    networks = ovh.get_cloud_storage_file_share_networks(service_name="<public cloud project ID>",
        region="GRA9")
    
    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.GetCloudStorageFileShareNetworks(ctx, &ovh.GetCloudStorageFileShareNetworksArgs{
    			ServiceName: "<public cloud project ID>",
    			Region:      pulumi.StringRef("GRA9"),
    		}, 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 networks = Ovh.GetCloudStorageFileShareNetworks.Invoke(new()
        {
            ServiceName = "<public cloud project ID>",
            Region = "GRA9",
        });
    
    });
    
    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.GetCloudStorageFileShareNetworksArgs;
    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 networks = OvhFunctions.getCloudStorageFileShareNetworks(GetCloudStorageFileShareNetworksArgs.builder()
                .serviceName("<public cloud project ID>")
                .region("GRA9")
                .build());
    
        }
    }
    
    variables:
      networks:
        fn::invoke:
          function: ovh:getCloudStorageFileShareNetworks
          arguments:
            serviceName: <public cloud project ID>
            region: GRA9
    
    Example coming soon!
    

    Using getCloudStorageFileShareNetworks

    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 getCloudStorageFileShareNetworks(args: GetCloudStorageFileShareNetworksArgs, opts?: InvokeOptions): Promise<GetCloudStorageFileShareNetworksResult>
    function getCloudStorageFileShareNetworksOutput(args: GetCloudStorageFileShareNetworksOutputArgs, opts?: InvokeOptions): Output<GetCloudStorageFileShareNetworksResult>
    def get_cloud_storage_file_share_networks(region: Optional[str] = None,
                                              service_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetCloudStorageFileShareNetworksResult
    def get_cloud_storage_file_share_networks_output(region: pulumi.Input[Optional[str]] = None,
                                              service_name: pulumi.Input[Optional[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetCloudStorageFileShareNetworksResult]
    func GetCloudStorageFileShareNetworks(ctx *Context, args *GetCloudStorageFileShareNetworksArgs, opts ...InvokeOption) (*GetCloudStorageFileShareNetworksResult, error)
    func GetCloudStorageFileShareNetworksOutput(ctx *Context, args *GetCloudStorageFileShareNetworksOutputArgs, opts ...InvokeOption) GetCloudStorageFileShareNetworksResultOutput

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

    public static class GetCloudStorageFileShareNetworks 
    {
        public static Task<GetCloudStorageFileShareNetworksResult> InvokeAsync(GetCloudStorageFileShareNetworksArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudStorageFileShareNetworksResult> Invoke(GetCloudStorageFileShareNetworksInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudStorageFileShareNetworksResult> getCloudStorageFileShareNetworks(GetCloudStorageFileShareNetworksArgs args, InvokeOptions options)
    public static Output<GetCloudStorageFileShareNetworksResult> getCloudStorageFileShareNetworks(GetCloudStorageFileShareNetworksArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudStorageFileShareNetworks:getCloudStorageFileShareNetworks
      arguments:
        # arguments dictionary
    data "ovh_get_cloud_storage_file_share_networks" "name" {
        # arguments
    }

    The following arguments are supported:

    ServiceName string
    The id of the public cloud project.
    Region string
    If set, only share networks located in this region are returned.
    ServiceName string
    The id of the public cloud project.
    Region string
    If set, only share networks located in this region are returned.
    service_name string
    The id of the public cloud project.
    region string
    If set, only share networks located in this region are returned.
    serviceName String
    The id of the public cloud project.
    region String
    If set, only share networks located in this region are returned.
    serviceName string
    The id of the public cloud project.
    region string
    If set, only share networks located in this region are returned.
    service_name str
    The id of the public cloud project.
    region str
    If set, only share networks located in this region are returned.
    serviceName String
    The id of the public cloud project.
    region String
    If set, only share networks located in this region are returned.

    getCloudStorageFileShareNetworks Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    ShareNetworks List<GetCloudStorageFileShareNetworksShareNetwork>
    List of share networks:
    Region string
    Region.
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceName string
    ShareNetworks []GetCloudStorageFileShareNetworksShareNetwork
    List of share networks:
    Region string
    Region.
    id string
    The provider-assigned unique ID for this managed resource.
    service_name string
    share_networks list(object)
    List of share networks:
    region string
    Region.
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    shareNetworks List<GetCloudStorageFileShareNetworksShareNetwork>
    List of share networks:
    region String
    Region.
    id string
    The provider-assigned unique ID for this managed resource.
    serviceName string
    shareNetworks GetCloudStorageFileShareNetworksShareNetwork[]
    List of share networks:
    region string
    Region.
    id str
    The provider-assigned unique ID for this managed resource.
    service_name str
    share_networks Sequence[GetCloudStorageFileShareNetworksShareNetwork]
    List of share networks:
    region str
    Region.
    id String
    The provider-assigned unique ID for this managed resource.
    serviceName String
    shareNetworks List<Property Map>
    List of share networks:
    region String
    Region.

    Supporting Types

    GetCloudStorageFileShareNetworksShareNetwork

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the share network.
    CurrentState GetCloudStorageFileShareNetworksShareNetworkCurrentState
    Current state of the file storage share network:
    Description string
    Share network description.
    Id string
    Share network ID.
    Location GetCloudStorageFileShareNetworksShareNetworkLocation
    Current location:
    Name string
    Share network name.
    NetworkId string
    ID of the private network.
    ResourceStatus string
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    SubnetId string
    ID of the subnet.
    UpdatedAt string
    Last update date of the share network.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the share network.
    CurrentState GetCloudStorageFileShareNetworksShareNetworkCurrentState
    Current state of the file storage share network:
    Description string
    Share network description.
    Id string
    Share network ID.
    Location GetCloudStorageFileShareNetworksShareNetworkLocation
    Current location:
    Name string
    Share network name.
    NetworkId string
    ID of the private network.
    ResourceStatus string
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    SubnetId string
    ID of the subnet.
    UpdatedAt string
    Last update date of the share network.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the share network.
    current_state object
    Current state of the file storage share network:
    description string
    Share network description.
    id string
    Share network ID.
    location object
    Current location:
    name string
    Share network name.
    network_id string
    ID of the private network.
    resource_status string
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    subnet_id string
    ID of the subnet.
    updated_at string
    Last update date of the share network.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the share network.
    currentState GetCloudStorageFileShareNetworksShareNetworkCurrentState
    Current state of the file storage share network:
    description String
    Share network description.
    id String
    Share network ID.
    location GetCloudStorageFileShareNetworksShareNetworkLocation
    Current location:
    name String
    Share network name.
    networkId String
    ID of the private network.
    resourceStatus String
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    subnetId String
    ID of the subnet.
    updatedAt String
    Last update date of the share network.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the share network.
    currentState GetCloudStorageFileShareNetworksShareNetworkCurrentState
    Current state of the file storage share network:
    description string
    Share network description.
    id string
    Share network ID.
    location GetCloudStorageFileShareNetworksShareNetworkLocation
    Current location:
    name string
    Share network name.
    networkId string
    ID of the private network.
    resourceStatus string
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    subnetId string
    ID of the subnet.
    updatedAt string
    Last update date of the share network.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the share network.
    current_state GetCloudStorageFileShareNetworksShareNetworkCurrentState
    Current state of the file storage share network:
    description str
    Share network description.
    id str
    Share network ID.
    location GetCloudStorageFileShareNetworksShareNetworkLocation
    Current location:
    name str
    Share network name.
    network_id str
    ID of the private network.
    resource_status str
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    subnet_id str
    ID of the subnet.
    updated_at str
    Last update date of the share network.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the share network.
    currentState Property Map
    Current state of the file storage share network:
    description String
    Share network description.
    id String
    Share network ID.
    location Property Map
    Current location:
    name String
    Share network name.
    networkId String
    ID of the private network.
    resourceStatus String
    Share network readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    subnetId String
    ID of the subnet.
    updatedAt String
    Last update date of the share network.

    GetCloudStorageFileShareNetworksShareNetworkCurrentState

    Description string
    Share network description.
    Location GetCloudStorageFileShareNetworksShareNetworkCurrentStateLocation
    Current location:
    Name string
    Share network name.
    NetworkId string
    ID of the private network.
    SubnetId string
    ID of the subnet.
    Description string
    Share network description.
    Location GetCloudStorageFileShareNetworksShareNetworkCurrentStateLocation
    Current location:
    Name string
    Share network name.
    NetworkId string
    ID of the private network.
    SubnetId string
    ID of the subnet.
    description string
    Share network description.
    location object
    Current location:
    name string
    Share network name.
    network_id string
    ID of the private network.
    subnet_id string
    ID of the subnet.
    description String
    Share network description.
    location GetCloudStorageFileShareNetworksShareNetworkCurrentStateLocation
    Current location:
    name String
    Share network name.
    networkId String
    ID of the private network.
    subnetId String
    ID of the subnet.
    description string
    Share network description.
    location GetCloudStorageFileShareNetworksShareNetworkCurrentStateLocation
    Current location:
    name string
    Share network name.
    networkId string
    ID of the private network.
    subnetId string
    ID of the subnet.
    description str
    Share network description.
    location GetCloudStorageFileShareNetworksShareNetworkCurrentStateLocation
    Current location:
    name str
    Share network name.
    network_id str
    ID of the private network.
    subnet_id str
    ID of the subnet.
    description String
    Share network description.
    location Property Map
    Current location:
    name String
    Share network name.
    networkId String
    ID of the private network.
    subnetId String
    ID of the subnet.

    GetCloudStorageFileShareNetworksShareNetworkCurrentStateLocation

    AvailabilityZone string
    Availability zone.
    Region string
    If set, only share networks located in this region are returned.
    AvailabilityZone string
    Availability zone.
    Region string
    If set, only share networks located in this region are returned.
    availability_zone string
    Availability zone.
    region string
    If set, only share networks located in this region are returned.
    availabilityZone String
    Availability zone.
    region String
    If set, only share networks located in this region are returned.
    availabilityZone string
    Availability zone.
    region string
    If set, only share networks located in this region are returned.
    availability_zone str
    Availability zone.
    region str
    If set, only share networks located in this region are returned.
    availabilityZone String
    Availability zone.
    region String
    If set, only share networks located in this region are returned.

    GetCloudStorageFileShareNetworksShareNetworkLocation

    AvailabilityZone string
    Availability zone.
    Region string
    If set, only share networks located in this region are returned.
    AvailabilityZone string
    Availability zone.
    Region string
    If set, only share networks located in this region are returned.
    availability_zone string
    Availability zone.
    region string
    If set, only share networks located in this region are returned.
    availabilityZone String
    Availability zone.
    region String
    If set, only share networks located in this region are returned.
    availabilityZone string
    Availability zone.
    region string
    If set, only share networks located in this region are returned.
    availability_zone str
    Availability zone.
    region str
    If set, only share networks located in this region are returned.
    availabilityZone String
    Availability zone.
    region String
    If set, only share networks located in this region are returned.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial