1. Packages
  2. Ibm Provider
  3. API Docs
  4. getBackupRecoveryDownloadIndexedFiles
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getBackupRecoveryDownloadIndexedFiles

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about backup_recovery_download_indexed_files. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const backupRecoveryDownloadIndexedFiles = ibm.getBackupRecoveryDownloadIndexedFiles({
        snapshotsId: "snapshots_id",
        xIbmTenantId: "x_ibm_tenant_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    backup_recovery_download_indexed_files = ibm.get_backup_recovery_download_indexed_files(snapshots_id="snapshots_id",
        x_ibm_tenant_id="x_ibm_tenant_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetBackupRecoveryDownloadIndexedFiles(ctx, &ibm.GetBackupRecoveryDownloadIndexedFilesArgs{
    			SnapshotsId:  "snapshots_id",
    			XIbmTenantId: "x_ibm_tenant_id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var backupRecoveryDownloadIndexedFiles = Ibm.GetBackupRecoveryDownloadIndexedFiles.Invoke(new()
        {
            SnapshotsId = "snapshots_id",
            XIbmTenantId = "x_ibm_tenant_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetBackupRecoveryDownloadIndexedFilesArgs;
    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 backupRecoveryDownloadIndexedFiles = IbmFunctions.getBackupRecoveryDownloadIndexedFiles(GetBackupRecoveryDownloadIndexedFilesArgs.builder()
                .snapshotsId("snapshots_id")
                .xIbmTenantId("x_ibm_tenant_id")
                .build());
    
        }
    }
    
    variables:
      backupRecoveryDownloadIndexedFiles:
        fn::invoke:
          function: ibm:getBackupRecoveryDownloadIndexedFiles
          arguments:
            snapshotsId: snapshots_id
            xIbmTenantId: x_ibm_tenant_id
    

    Using getBackupRecoveryDownloadIndexedFiles

    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 getBackupRecoveryDownloadIndexedFiles(args: GetBackupRecoveryDownloadIndexedFilesArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryDownloadIndexedFilesResult>
    function getBackupRecoveryDownloadIndexedFilesOutput(args: GetBackupRecoveryDownloadIndexedFilesOutputArgs, opts?: InvokeOptions): Output<GetBackupRecoveryDownloadIndexedFilesResult>
    def get_backup_recovery_download_indexed_files(file_path: Optional[str] = None,
                                                   id: Optional[str] = None,
                                                   length: Optional[float] = None,
                                                   nvram_file: Optional[bool] = None,
                                                   retry_attempt: Optional[float] = None,
                                                   snapshots_id: Optional[str] = None,
                                                   start_offset: Optional[float] = None,
                                                   x_ibm_tenant_id: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryDownloadIndexedFilesResult
    def get_backup_recovery_download_indexed_files_output(file_path: Optional[pulumi.Input[str]] = None,
                                                   id: Optional[pulumi.Input[str]] = None,
                                                   length: Optional[pulumi.Input[float]] = None,
                                                   nvram_file: Optional[pulumi.Input[bool]] = None,
                                                   retry_attempt: Optional[pulumi.Input[float]] = None,
                                                   snapshots_id: Optional[pulumi.Input[str]] = None,
                                                   start_offset: Optional[pulumi.Input[float]] = None,
                                                   x_ibm_tenant_id: Optional[pulumi.Input[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetBackupRecoveryDownloadIndexedFilesResult]
    func GetBackupRecoveryDownloadIndexedFiles(ctx *Context, args *GetBackupRecoveryDownloadIndexedFilesArgs, opts ...InvokeOption) (*GetBackupRecoveryDownloadIndexedFilesResult, error)
    func GetBackupRecoveryDownloadIndexedFilesOutput(ctx *Context, args *GetBackupRecoveryDownloadIndexedFilesOutputArgs, opts ...InvokeOption) GetBackupRecoveryDownloadIndexedFilesResultOutput

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

    public static class GetBackupRecoveryDownloadIndexedFiles 
    {
        public static Task<GetBackupRecoveryDownloadIndexedFilesResult> InvokeAsync(GetBackupRecoveryDownloadIndexedFilesArgs args, InvokeOptions? opts = null)
        public static Output<GetBackupRecoveryDownloadIndexedFilesResult> Invoke(GetBackupRecoveryDownloadIndexedFilesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackupRecoveryDownloadIndexedFilesResult> getBackupRecoveryDownloadIndexedFiles(GetBackupRecoveryDownloadIndexedFilesArgs args, InvokeOptions options)
    public static Output<GetBackupRecoveryDownloadIndexedFilesResult> getBackupRecoveryDownloadIndexedFiles(GetBackupRecoveryDownloadIndexedFilesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getBackupRecoveryDownloadIndexedFiles:getBackupRecoveryDownloadIndexedFiles
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SnapshotsId string
    Specifies the snapshot id to download from.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    FilePath string
    Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
    Id string
    The unique identifier of the backup_recovery_download_indexed_files.
    Length double
    Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets).
    NvramFile bool
    Specifies if NVRAM file for VMware should be downloaded.
    RetryAttempt double
    Specifies the number of attempts the protection run took to create this file.
    StartOffset double
    Specifies the start offset of file chunk to be downloaded.
    SnapshotsId string
    Specifies the snapshot id to download from.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    FilePath string
    Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
    Id string
    The unique identifier of the backup_recovery_download_indexed_files.
    Length float64
    Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets).
    NvramFile bool
    Specifies if NVRAM file for VMware should be downloaded.
    RetryAttempt float64
    Specifies the number of attempts the protection run took to create this file.
    StartOffset float64
    Specifies the start offset of file chunk to be downloaded.
    snapshotsId String
    Specifies the snapshot id to download from.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    filePath String
    Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
    id String
    The unique identifier of the backup_recovery_download_indexed_files.
    length Double
    Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets).
    nvramFile Boolean
    Specifies if NVRAM file for VMware should be downloaded.
    retryAttempt Double
    Specifies the number of attempts the protection run took to create this file.
    startOffset Double
    Specifies the start offset of file chunk to be downloaded.
    snapshotsId string
    Specifies the snapshot id to download from.
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    filePath string
    Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
    id string
    The unique identifier of the backup_recovery_download_indexed_files.
    length number
    Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets).
    nvramFile boolean
    Specifies if NVRAM file for VMware should be downloaded.
    retryAttempt number
    Specifies the number of attempts the protection run took to create this file.
    startOffset number
    Specifies the start offset of file chunk to be downloaded.
    snapshots_id str
    Specifies the snapshot id to download from.
    x_ibm_tenant_id str
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    file_path str
    Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
    id str
    The unique identifier of the backup_recovery_download_indexed_files.
    length float
    Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets).
    nvram_file bool
    Specifies if NVRAM file for VMware should be downloaded.
    retry_attempt float
    Specifies the number of attempts the protection run took to create this file.
    start_offset float
    Specifies the start offset of file chunk to be downloaded.
    snapshotsId String
    Specifies the snapshot id to download from.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    filePath String
    Specifies the path to the file to download. If no path is specified and snapshot environment is kVMWare, VMX file for VMware will be downloaded. For other snapshot environments, this field must be specified.
    id String
    The unique identifier of the backup_recovery_download_indexed_files.
    length Number
    Specifies the length of bytes to download. This can not be greater than 8MB (8388608 byets).
    nvramFile Boolean
    Specifies if NVRAM file for VMware should be downloaded.
    retryAttempt Number
    Specifies the number of attempts the protection run took to create this file.
    startOffset Number
    Specifies the start offset of file chunk to be downloaded.

    getBackupRecoveryDownloadIndexedFiles Result

    The following output properties are available:

    Id string
    The unique identifier of the backup_recovery_download_indexed_files.
    SnapshotsId string
    XIbmTenantId string
    FilePath string
    Length double
    NvramFile bool
    RetryAttempt double
    StartOffset double
    Id string
    The unique identifier of the backup_recovery_download_indexed_files.
    SnapshotsId string
    XIbmTenantId string
    FilePath string
    Length float64
    NvramFile bool
    RetryAttempt float64
    StartOffset float64
    id String
    The unique identifier of the backup_recovery_download_indexed_files.
    snapshotsId String
    xIbmTenantId String
    filePath String
    length Double
    nvramFile Boolean
    retryAttempt Double
    startOffset Double
    id string
    The unique identifier of the backup_recovery_download_indexed_files.
    snapshotsId string
    xIbmTenantId string
    filePath string
    length number
    nvramFile boolean
    retryAttempt number
    startOffset number
    id str
    The unique identifier of the backup_recovery_download_indexed_files.
    snapshots_id str
    x_ibm_tenant_id str
    file_path str
    length float
    nvram_file bool
    retry_attempt float
    start_offset float
    id String
    The unique identifier of the backup_recovery_download_indexed_files.
    snapshotsId String
    xIbmTenantId String
    filePath String
    length Number
    nvramFile Boolean
    retryAttempt Number
    startOffset Number

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud