1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudStorageBlockVolumeSnapshot
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud
ovh logo
Viewing docs for OVHCloud v2.14.0
published on Monday, Jun 15, 2026 by OVHcloud

    Get a snapshot of a block storage volume in a public cloud project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ovh from "@ovhcloud/pulumi-ovh";
    
    const snapshot = ovh.getCloudStorageBlockVolumeSnapshot({
        serviceName: "xxxxxxxxx",
        id: "00000000-0000-0000-0000-000000000000",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    snapshot = ovh.get_cloud_storage_block_volume_snapshot(service_name="xxxxxxxxx",
        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.LookupCloudStorageBlockVolumeSnapshot(ctx, &ovh.LookupCloudStorageBlockVolumeSnapshotArgs{
    			ServiceName: "xxxxxxxxx",
    			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.GetCloudStorageBlockVolumeSnapshot.Invoke(new()
        {
            ServiceName = "xxxxxxxxx",
            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.GetCloudStorageBlockVolumeSnapshotArgs;
    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.getCloudStorageBlockVolumeSnapshot(GetCloudStorageBlockVolumeSnapshotArgs.builder()
                .serviceName("xxxxxxxxx")
                .id("00000000-0000-0000-0000-000000000000")
                .build());
    
        }
    }
    
    variables:
      snapshot:
        fn::invoke:
          function: ovh:getCloudStorageBlockVolumeSnapshot
          arguments:
            serviceName: xxxxxxxxx
            id: 00000000-0000-0000-0000-000000000000
    
    Example coming soon!
    

    Using getCloudStorageBlockVolumeSnapshot

    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 getCloudStorageBlockVolumeSnapshot(args: GetCloudStorageBlockVolumeSnapshotArgs, opts?: InvokeOptions): Promise<GetCloudStorageBlockVolumeSnapshotResult>
    function getCloudStorageBlockVolumeSnapshotOutput(args: GetCloudStorageBlockVolumeSnapshotOutputArgs, opts?: InvokeOptions): Output<GetCloudStorageBlockVolumeSnapshotResult>
    def get_cloud_storage_block_volume_snapshot(id: Optional[str] = None,
                                                service_name: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetCloudStorageBlockVolumeSnapshotResult
    def get_cloud_storage_block_volume_snapshot_output(id: pulumi.Input[Optional[str]] = None,
                                                service_name: pulumi.Input[Optional[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetCloudStorageBlockVolumeSnapshotResult]
    func LookupCloudStorageBlockVolumeSnapshot(ctx *Context, args *LookupCloudStorageBlockVolumeSnapshotArgs, opts ...InvokeOption) (*LookupCloudStorageBlockVolumeSnapshotResult, error)
    func LookupCloudStorageBlockVolumeSnapshotOutput(ctx *Context, args *LookupCloudStorageBlockVolumeSnapshotOutputArgs, opts ...InvokeOption) LookupCloudStorageBlockVolumeSnapshotResultOutput

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

    public static class GetCloudStorageBlockVolumeSnapshot 
    {
        public static Task<GetCloudStorageBlockVolumeSnapshotResult> InvokeAsync(GetCloudStorageBlockVolumeSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudStorageBlockVolumeSnapshotResult> Invoke(GetCloudStorageBlockVolumeSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudStorageBlockVolumeSnapshotResult> getCloudStorageBlockVolumeSnapshot(GetCloudStorageBlockVolumeSnapshotArgs args, InvokeOptions options)
    public static Output<GetCloudStorageBlockVolumeSnapshotResult> getCloudStorageBlockVolumeSnapshot(GetCloudStorageBlockVolumeSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudStorageBlockVolumeSnapshot:getCloudStorageBlockVolumeSnapshot
      arguments:
        # arguments dictionary
    data "ovh_getcloudstorageblockvolumesnapshot" "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.

    getCloudStorageBlockVolumeSnapshot Result

    The following output properties are available:

    Description string
    Snapshot description.
    Id string
    Location GetCloudStorageBlockVolumeSnapshotLocation
    Location of the snapshot:
    Name string
    Snapshot name.
    ResourceStatus string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    Size int
    Size of the snapshot in GB.
    VolumeId string
    ID of the snapshotted volume.
    Description string
    Snapshot description.
    Id string
    Location GetCloudStorageBlockVolumeSnapshotLocation
    Location of the snapshot:
    Name string
    Snapshot name.
    ResourceStatus string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    ServiceName string
    Size int
    Size of the snapshot in GB.
    VolumeId string
    ID of the snapshotted volume.
    description string
    Snapshot description.
    id string
    location object
    Location of the snapshot:
    name string
    Snapshot name.
    resource_status string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name string
    size number
    Size of the snapshot in GB.
    volume_id string
    ID of the snapshotted volume.
    description String
    Snapshot description.
    id String
    location GetCloudStorageBlockVolumeSnapshotLocation
    Location of the snapshot:
    name String
    Snapshot name.
    resourceStatus String
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    size Integer
    Size of the snapshot in GB.
    volumeId String
    ID of the snapshotted volume.
    description string
    Snapshot description.
    id string
    location GetCloudStorageBlockVolumeSnapshotLocation
    Location of the snapshot:
    name string
    Snapshot name.
    resourceStatus string
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName string
    size number
    Size of the snapshot in GB.
    volumeId string
    ID of the snapshotted volume.
    description str
    Snapshot description.
    id str
    location GetCloudStorageBlockVolumeSnapshotLocation
    Location of the snapshot:
    name str
    Snapshot name.
    resource_status str
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    service_name str
    size int
    Size of the snapshot in GB.
    volume_id str
    ID of the snapshotted volume.
    description String
    Snapshot description.
    id String
    location Property Map
    Location of the snapshot:
    name String
    Snapshot name.
    resourceStatus String
    Snapshot readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING).
    serviceName String
    size Number
    Size of the snapshot in GB.
    volumeId String
    ID of the snapshotted volume.

    Supporting Types

    GetCloudStorageBlockVolumeSnapshotLocation

    Region string
    Region.
    Region string
    Region.
    region string
    Region.
    region String
    Region.
    region string
    Region.
    region str
    Region.
    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.14.0
    published on Monday, Jun 15, 2026 by OVHcloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial