1. Packages
  2. Ibm Provider
  3. API Docs
  4. getBackupRecoveryDownloadAgent
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getBackupRecoveryDownloadAgent

Get Started
ibm logo
ibm 1.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about a backup_recovery_download_agent. 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 backupRecoveryDownloadAgent = ibm.getBackupRecoveryDownloadAgent({
    filePath: "./agent.exe",
    platform: "kWindows",
    xIbmTenantId: "x_ibm_tenant_id",
});

    import pulumi
import pulumi_ibm as ibm

backup_recovery_download_agent = ibm.get_backup_recovery_download_agent(file_path="./agent.exe",
    platform="kWindows",
    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.GetBackupRecoveryDownloadAgent(ctx, &ibm.GetBackupRecoveryDownloadAgentArgs{
			FilePath:     "./agent.exe",
			Platform:     "kWindows",
			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 backupRecoveryDownloadAgent = Ibm.GetBackupRecoveryDownloadAgent.Invoke(new()
    {
        FilePath = "./agent.exe",
        Platform = "kWindows",
        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.GetBackupRecoveryDownloadAgentArgs;
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 backupRecoveryDownloadAgent = IbmFunctions.getBackupRecoveryDownloadAgent(GetBackupRecoveryDownloadAgentArgs.builder()
            .filePath("./agent.exe")
            .platform("kWindows")
            .xIbmTenantId("x_ibm_tenant_id")
            .build());

    }
}

    variables:
  backupRecoveryDownloadAgent:
    fn::invoke:
      function: ibm:getBackupRecoveryDownloadAgent
      arguments:
        filePath: ./agent.exe
        platform: kWindows
        xIbmTenantId: x_ibm_tenant_id

    Using getBackupRecoveryDownloadAgent

    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 getBackupRecoveryDownloadAgent(args: GetBackupRecoveryDownloadAgentArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryDownloadAgentResult>
function getBackupRecoveryDownloadAgentOutput(args: GetBackupRecoveryDownloadAgentOutputArgs, opts?: InvokeOptions): Output<GetBackupRecoveryDownloadAgentResult>
    def get_backup_recovery_download_agent(endpoint_type: Optional[str] = None,
                                       file_path: Optional[str] = None,
                                       id: Optional[str] = None,
                                       instance_id: Optional[str] = None,
                                       linux_params: Optional[GetBackupRecoveryDownloadAgentLinuxParams] = None,
                                       platform: Optional[str] = None,
                                       region: Optional[str] = None,
                                       x_ibm_tenant_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryDownloadAgentResult
def get_backup_recovery_download_agent_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                                       file_path: Optional[pulumi.Input[str]] = None,
                                       id: Optional[pulumi.Input[str]] = None,
                                       instance_id: Optional[pulumi.Input[str]] = None,
                                       linux_params: Optional[pulumi.Input[GetBackupRecoveryDownloadAgentLinuxParamsArgs]] = None,
                                       platform: Optional[pulumi.Input[str]] = None,
                                       region: Optional[pulumi.Input[str]] = None,
                                       x_ibm_tenant_id: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetBackupRecoveryDownloadAgentResult]
    func GetBackupRecoveryDownloadAgent(ctx *Context, args *GetBackupRecoveryDownloadAgentArgs, opts ...InvokeOption) (*GetBackupRecoveryDownloadAgentResult, error)
func GetBackupRecoveryDownloadAgentOutput(ctx *Context, args *GetBackupRecoveryDownloadAgentOutputArgs, opts ...InvokeOption) GetBackupRecoveryDownloadAgentResultOutput

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

    public static class GetBackupRecoveryDownloadAgent 
{
    public static Task<GetBackupRecoveryDownloadAgentResult> InvokeAsync(GetBackupRecoveryDownloadAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryDownloadAgentResult> Invoke(GetBackupRecoveryDownloadAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupRecoveryDownloadAgentResult> getBackupRecoveryDownloadAgent(GetBackupRecoveryDownloadAgentArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryDownloadAgentResult> getBackupRecoveryDownloadAgent(GetBackupRecoveryDownloadAgentArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getBackupRecoveryDownloadAgent:getBackupRecoveryDownloadAgent
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FilePath string
    Specifies the absolute path for download.

    • Constraints: Allowable values are: kWindows, kLinux.
    Platform string
    Specifies the platform for which agent needs to be downloaded.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    EndpointType string
    Backup Recovery Endpoint type. By default set to "public".
    Id string
    The unique identifier of the backup_recovery_download_agent.
    InstanceId string
    Backup Recovery instance ID. If provided here along with region, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    LinuxParams GetBackupRecoveryDownloadAgentLinuxParams
    Linux agent parameters. Nested schema for linux_params:
    Region string
    Backup Recovery region. If provided here along with instance_id, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    FilePath string
    Specifies the absolute path for download.

    • Constraints: Allowable values are: kWindows, kLinux.
    Platform string
    Specifies the platform for which agent needs to be downloaded.
    XIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    EndpointType string
    Backup Recovery Endpoint type. By default set to "public".
    Id string
    The unique identifier of the backup_recovery_download_agent.
    InstanceId string
    Backup Recovery instance ID. If provided here along with region, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    LinuxParams GetBackupRecoveryDownloadAgentLinuxParams
    Linux agent parameters. Nested schema for linux_params:
    Region string
    Backup Recovery region. If provided here along with instance_id, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    filePath String
    Specifies the absolute path for download.

    • Constraints: Allowable values are: kWindows, kLinux.
    platform String
    Specifies the platform for which agent needs to be downloaded.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    endpointType String
    Backup Recovery Endpoint type. By default set to "public".
    id String
    The unique identifier of the backup_recovery_download_agent.
    instanceId String
    Backup Recovery instance ID. If provided here along with region, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    linuxParams GetBackupRecoveryDownloadAgentLinuxParams
    Linux agent parameters. Nested schema for linux_params:
    region String
    Backup Recovery region. If provided here along with instance_id, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    filePath string
    Specifies the absolute path for download.

    • Constraints: Allowable values are: kWindows, kLinux.
    platform string
    Specifies the platform for which agent needs to be downloaded.
    xIbmTenantId string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    endpointType string
    Backup Recovery Endpoint type. By default set to "public".
    id string
    The unique identifier of the backup_recovery_download_agent.
    instanceId string
    Backup Recovery instance ID. If provided here along with region, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    linuxParams GetBackupRecoveryDownloadAgentLinuxParams
    Linux agent parameters. Nested schema for linux_params:
    region string
    Backup Recovery region. If provided here along with instance_id, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    file_path str
    Specifies the absolute path for download.

    • Constraints: Allowable values are: kWindows, kLinux.
    platform str
    Specifies the platform for which agent needs to be downloaded.
    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.
    endpoint_type str
    Backup Recovery Endpoint type. By default set to "public".
    id str
    The unique identifier of the backup_recovery_download_agent.
    instance_id str
    Backup Recovery instance ID. If provided here along with region, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    linux_params GetBackupRecoveryDownloadAgentLinuxParams
    Linux agent parameters. Nested schema for linux_params:
    region str
    Backup Recovery region. If provided here along with instance_id, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    filePath String
    Specifies the absolute path for download.

    • Constraints: Allowable values are: kWindows, kLinux.
    platform String
    Specifies the platform for which agent needs to be downloaded.
    xIbmTenantId String
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    endpointType String
    Backup Recovery Endpoint type. By default set to "public".
    id String
    The unique identifier of the backup_recovery_download_agent.
    instanceId String
    Backup Recovery instance ID. If provided here along with region, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.
    linuxParams Property Map
    Linux agent parameters. Nested schema for linux_params:
    region String
    Backup Recovery region. If provided here along with instance_id, the provider constructs the endpoint URL using them, which overrides any value set through environment variables or the endpoints.json file.

    getBackupRecoveryDownloadAgent Result

    The following output properties are available:

    FilePath string
    Id string
    The unique identifier of the backup_recovery_download_agent.
    Platform string
    Region string
    XIbmTenantId string
    EndpointType string
    InstanceId string
    LinuxParams GetBackupRecoveryDownloadAgentLinuxParams
    FilePath string
    Id string
    The unique identifier of the backup_recovery_download_agent.
    Platform string
    Region string
    XIbmTenantId string
    EndpointType string
    InstanceId string
    LinuxParams GetBackupRecoveryDownloadAgentLinuxParams
    filePath String
    id String
    The unique identifier of the backup_recovery_download_agent.
    platform String
    region String
    xIbmTenantId String
    endpointType String
    instanceId String
    linuxParams GetBackupRecoveryDownloadAgentLinuxParams
    filePath string
    id string
    The unique identifier of the backup_recovery_download_agent.
    platform string
    region string
    xIbmTenantId string
    endpointType string
    instanceId string
    linuxParams GetBackupRecoveryDownloadAgentLinuxParams
    file_path str
    id str
    The unique identifier of the backup_recovery_download_agent.
    platform str
    region str
    x_ibm_tenant_id str
    endpoint_type str
    instance_id str
    linux_params GetBackupRecoveryDownloadAgentLinuxParams
    filePath String
    id String
    The unique identifier of the backup_recovery_download_agent.
    platform String
    region String
    xIbmTenantId String
    endpointType String
    instanceId String
    linuxParams Property Map

    Supporting Types

    GetBackupRecoveryDownloadAgentLinuxParams

    PackageType string
    Specifies the type of installer.

    • Constraints: Allowable values are: kScript, kRPM, kSuseRPM, kDEB, kPowerPCRPM.
    PackageType string
    Specifies the type of installer.

    • Constraints: Allowable values are: kScript, kRPM, kSuseRPM, kDEB, kPowerPCRPM.
    packageType String
    Specifies the type of installer.

    • Constraints: Allowable values are: kScript, kRPM, kSuseRPM, kDEB, kPowerPCRPM.
    packageType string
    Specifies the type of installer.

    • Constraints: Allowable values are: kScript, kRPM, kSuseRPM, kDEB, kPowerPCRPM.
    package_type str
    Specifies the type of installer.

    • Constraints: Allowable values are: kScript, kRPM, kSuseRPM, kDEB, kPowerPCRPM.
    packageType String
    Specifies the type of installer.

    • Constraints: Allowable values are: kScript, kRPM, kSuseRPM, kDEB, kPowerPCRPM.

    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.85.0-beta0 published on Wednesday, Oct 29, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm
      Meet Neo: Your AI Platform Teammate