1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudStorageBlockVolumeBackup
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 backup 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 backup = ovh.getCloudStorageBlockVolumeBackup({
        serviceName: "xxxxxxxxx",
        id: "00000000-0000-0000-0000-000000000000",
    });
    
    import pulumi
    import pulumi_ovh as ovh
    
    backup = ovh.get_cloud_storage_block_volume_backup(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.LookupCloudStorageBlockVolumeBackup(ctx, &ovh.LookupCloudStorageBlockVolumeBackupArgs{
    			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 backup = Ovh.GetCloudStorageBlockVolumeBackup.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.GetCloudStorageBlockVolumeBackupArgs;
    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 backup = OvhFunctions.getCloudStorageBlockVolumeBackup(GetCloudStorageBlockVolumeBackupArgs.builder()
                .serviceName("xxxxxxxxx")
                .id("00000000-0000-0000-0000-000000000000")
                .build());
    
        }
    }
    
    variables:
      backup:
        fn::invoke:
          function: ovh:getCloudStorageBlockVolumeBackup
          arguments:
            serviceName: xxxxxxxxx
            id: 00000000-0000-0000-0000-000000000000
    
    Example coming soon!
    

    Using getCloudStorageBlockVolumeBackup

    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 getCloudStorageBlockVolumeBackup(args: GetCloudStorageBlockVolumeBackupArgs, opts?: InvokeOptions): Promise<GetCloudStorageBlockVolumeBackupResult>
    function getCloudStorageBlockVolumeBackupOutput(args: GetCloudStorageBlockVolumeBackupOutputArgs, opts?: InvokeOptions): Output<GetCloudStorageBlockVolumeBackupResult>
    def get_cloud_storage_block_volume_backup(id: Optional[str] = None,
                                              service_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetCloudStorageBlockVolumeBackupResult
    def get_cloud_storage_block_volume_backup_output(id: pulumi.Input[Optional[str]] = None,
                                              service_name: pulumi.Input[Optional[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetCloudStorageBlockVolumeBackupResult]
    func LookupCloudStorageBlockVolumeBackup(ctx *Context, args *LookupCloudStorageBlockVolumeBackupArgs, opts ...InvokeOption) (*LookupCloudStorageBlockVolumeBackupResult, error)
    func LookupCloudStorageBlockVolumeBackupOutput(ctx *Context, args *LookupCloudStorageBlockVolumeBackupOutputArgs, opts ...InvokeOption) LookupCloudStorageBlockVolumeBackupResultOutput

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

    public static class GetCloudStorageBlockVolumeBackup 
    {
        public static Task<GetCloudStorageBlockVolumeBackupResult> InvokeAsync(GetCloudStorageBlockVolumeBackupArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudStorageBlockVolumeBackupResult> Invoke(GetCloudStorageBlockVolumeBackupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudStorageBlockVolumeBackupResult> getCloudStorageBlockVolumeBackup(GetCloudStorageBlockVolumeBackupArgs args, InvokeOptions options)
    public static Output<GetCloudStorageBlockVolumeBackupResult> getCloudStorageBlockVolumeBackup(GetCloudStorageBlockVolumeBackupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ovh:index/getCloudStorageBlockVolumeBackup:getCloudStorageBlockVolumeBackup
      arguments:
        # arguments dictionary
    data "ovh_getcloudstorageblockvolumebackup" "name" {
        # arguments
    }

    The following arguments are supported:

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

    getCloudStorageBlockVolumeBackup Result

    The following output properties are available:

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

    Supporting Types

    GetCloudStorageBlockVolumeBackupLocation

    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