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

ovh.getCloudStorageFileShareSnapshot

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 snapshot (NFS share snapshot) in a public cloud project.

    Example Usage

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

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

    import pulumi
import pulumi_ovh as ovh

snapshot = ovh.get_cloud_storage_file_share_snapshot(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.LookupCloudStorageFileShareSnapshot(ctx, &ovh.LookupCloudStorageFileShareSnapshotArgs{
			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 snapshot = Ovh.GetCloudStorageFileShareSnapshot.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.GetCloudStorageFileShareSnapshotArgs;
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 snapshot = OvhFunctions.getCloudStorageFileShareSnapshot(GetCloudStorageFileShareSnapshotArgs.builder()
            .serviceName("<public cloud project ID>")
            .id("00000000-0000-0000-0000-000000000000")
            .build());

    }
}

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

    Example coming soon!

    Using getCloudStorageFileShareSnapshot

    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 getCloudStorageFileShareSnapshot(args: GetCloudStorageFileShareSnapshotArgs, opts?: InvokeOptions): Promise<GetCloudStorageFileShareSnapshotResult>
function getCloudStorageFileShareSnapshotOutput(args: GetCloudStorageFileShareSnapshotOutputArgs, opts?: InvokeOptions): Output<GetCloudStorageFileShareSnapshotResult>
    def get_cloud_storage_file_share_snapshot(id: Optional[str] = None,
                                          service_name: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetCloudStorageFileShareSnapshotResult
def get_cloud_storage_file_share_snapshot_output(id: pulumi.Input[Optional[str]] = None,
                                          service_name: pulumi.Input[Optional[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetCloudStorageFileShareSnapshotResult]
    func LookupCloudStorageFileShareSnapshot(ctx *Context, args *LookupCloudStorageFileShareSnapshotArgs, opts ...InvokeOption) (*LookupCloudStorageFileShareSnapshotResult, error)
func LookupCloudStorageFileShareSnapshotOutput(ctx *Context, args *LookupCloudStorageFileShareSnapshotOutputArgs, opts ...InvokeOption) LookupCloudStorageFileShareSnapshotResultOutput

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

    public static class GetCloudStorageFileShareSnapshot 
{
    public static Task<GetCloudStorageFileShareSnapshotResult> InvokeAsync(GetCloudStorageFileShareSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudStorageFileShareSnapshotResult> Invoke(GetCloudStorageFileShareSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudStorageFileShareSnapshotResult> getCloudStorageFileShareSnapshot(GetCloudStorageFileShareSnapshotArgs args, InvokeOptions options)
public static Output<GetCloudStorageFileShareSnapshotResult> getCloudStorageFileShareSnapshot(GetCloudStorageFileShareSnapshotArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:index/getCloudStorageFileShareSnapshot:getCloudStorageFileShareSnapshot
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_storage_file_share_snapshot" "name" {
    # arguments
}

    The following arguments are supported:

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

    getCloudStorageFileShareSnapshot Result

    The following output properties are available:

    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the snapshot.
    CurrentState GetCloudStorageFileShareSnapshotCurrentState
    Current state of the file storage snapshot:
    Description string
    Snapshot description.
    Id string
    Name string
    Snapshot name.
    ResourceStatus string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    ShareId string
    ID of the snapshotted file share.
    UpdatedAt string
    Last update date of the snapshot.
    Checksum string
    Computed hash representing the current target specification value.
    CreatedAt string
    Creation date of the snapshot.
    CurrentState GetCloudStorageFileShareSnapshotCurrentState
    Current state of the file storage snapshot:
    Description string
    Snapshot description.
    Id string
    Name string
    Snapshot name.
    ResourceStatus string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    ShareId string
    ID of the snapshotted file share.
    UpdatedAt string
    Last update date of the snapshot.
    checksum string
    Computed hash representing the current target specification value.
    created_at string
    Creation date of the snapshot.
    current_state object
    Current state of the file storage snapshot:
    description string
    Snapshot description.
    id string
    name string
    Snapshot name.
    resource_status string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    share_id string
    ID of the snapshotted file share.
    updated_at string
    Last update date of the snapshot.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the snapshot.
    currentState GetCloudStorageFileShareSnapshotCurrentState
    Current state of the file storage snapshot:
    description String
    Snapshot description.
    id String
    name String
    Snapshot name.
    resourceStatus String
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    shareId String
    ID of the snapshotted file share.
    updatedAt String
    Last update date of the snapshot.
    checksum string
    Computed hash representing the current target specification value.
    createdAt string
    Creation date of the snapshot.
    currentState GetCloudStorageFileShareSnapshotCurrentState
    Current state of the file storage snapshot:
    description string
    Snapshot description.
    id string
    name string
    Snapshot name.
    resourceStatus string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    shareId string
    ID of the snapshotted file share.
    updatedAt string
    Last update date of the snapshot.
    checksum str
    Computed hash representing the current target specification value.
    created_at str
    Creation date of the snapshot.
    current_state GetCloudStorageFileShareSnapshotCurrentState
    Current state of the file storage snapshot:
    description str
    Snapshot description.
    id str
    name str
    Snapshot name.
    resource_status str
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    share_id str
    ID of the snapshotted file share.
    updated_at str
    Last update date of the snapshot.
    checksum String
    Computed hash representing the current target specification value.
    createdAt String
    Creation date of the snapshot.
    currentState Property Map
    Current state of the file storage snapshot:
    description String
    Snapshot description.
    id String
    name String
    Snapshot name.
    resourceStatus String
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    shareId String
    ID of the snapshotted file share.
    updatedAt String
    Last update date of the snapshot.

    Supporting Types

    GetCloudStorageFileShareSnapshotCurrentState

    Description string
    Snapshot description.
    Location GetCloudStorageFileShareSnapshotCurrentStateLocation
    Current location:
    Name string
    Snapshot name.
    ShareId string
    ID of the snapshotted file share.
    Size int
    Size of the snapshot in GB.
    Description string
    Snapshot description.
    Location GetCloudStorageFileShareSnapshotCurrentStateLocation
    Current location:
    Name string
    Snapshot name.
    ShareId string
    ID of the snapshotted file share.
    Size int
    Size of the snapshot in GB.
    description string
    Snapshot description.
    location object
    Current location:
    name string
    Snapshot name.
    share_id string
    ID of the snapshotted file share.
    size number
    Size of the snapshot in GB.
    description String
    Snapshot description.
    location GetCloudStorageFileShareSnapshotCurrentStateLocation
    Current location:
    name String
    Snapshot name.
    shareId String
    ID of the snapshotted file share.
    size Integer
    Size of the snapshot in GB.
    description string
    Snapshot description.
    location GetCloudStorageFileShareSnapshotCurrentStateLocation
    Current location:
    name string
    Snapshot name.
    shareId string
    ID of the snapshotted file share.
    size number
    Size of the snapshot in GB.
    description str
    Snapshot description.
    location GetCloudStorageFileShareSnapshotCurrentStateLocation
    Current location:
    name str
    Snapshot name.
    share_id str
    ID of the snapshotted file share.
    size int
    Size of the snapshot in GB.
    description String
    Snapshot description.
    location Property Map
    Current location:
    name String
    Snapshot name.
    shareId String
    ID of the snapshotted file share.
    size Number
    Size of the snapshot in GB.

    GetCloudStorageFileShareSnapshotCurrentStateLocation

    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