ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm.getBackupRecoveryDownloadAgent
Explore with Pulumi AI
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(file_path: Optional[str] = None,
                                       id: Optional[str] = None,
                                       linux_params: Optional[GetBackupRecoveryDownloadAgentLinuxParams] = None,
                                       platform: Optional[str] = None,
                                       x_ibm_tenant_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryDownloadAgentResult
def get_backup_recovery_download_agent_output(file_path: Optional[pulumi.Input[str]] = None,
                                       id: Optional[pulumi.Input[str]] = None,
                                       linux_params: Optional[pulumi.Input[GetBackupRecoveryDownloadAgentLinuxParamsArgs]] = None,
                                       platform: 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 dictionaryThe following arguments are supported:
- File
Path string - Specifies the absolute path for download.
- Constraints: Allowable values are: 
kWindows,kLinux. 
 - Constraints: Allowable values are: 
 - Platform string
 - Specifies the platform for which agent needs to be downloaded.
 - XIbm
Tenant stringId  - Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
 - Id string
 - The unique identifier of the backup_recovery_download_agent.
 - Linux
Params GetBackup Recovery Download Agent Linux Params  - Linux agent parameters. Nested schema for linux_params:
 
- File
Path string - Specifies the absolute path for download.
- Constraints: Allowable values are: 
kWindows,kLinux. 
 - Constraints: Allowable values are: 
 - Platform string
 - Specifies the platform for which agent needs to be downloaded.
 - XIbm
Tenant stringId  - Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
 - Id string
 - The unique identifier of the backup_recovery_download_agent.
 - Linux
Params GetBackup Recovery Download Agent Linux Params  - Linux agent parameters. Nested schema for linux_params:
 
- file
Path String - Specifies the absolute path for download.
- Constraints: Allowable values are: 
kWindows,kLinux. 
 - Constraints: Allowable values are: 
 - platform String
 - Specifies the platform for which agent needs to be downloaded.
 - x
Ibm StringTenant Id  - Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
 - id String
 - The unique identifier of the backup_recovery_download_agent.
 - linux
Params GetBackup Recovery Download Agent Linux Params  - Linux agent parameters. Nested schema for linux_params:
 
- file
Path string - Specifies the absolute path for download.
- Constraints: Allowable values are: 
kWindows,kLinux. 
 - Constraints: Allowable values are: 
 - platform string
 - Specifies the platform for which agent needs to be downloaded.
 - x
Ibm stringTenant Id  - Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
 - id string
 - The unique identifier of the backup_recovery_download_agent.
 - linux
Params GetBackup Recovery Download Agent Linux Params  - Linux agent parameters. Nested schema for linux_params:
 
- file_
path str - Specifies the absolute path for download.
- Constraints: Allowable values are: 
kWindows,kLinux. 
 - Constraints: Allowable values are: 
 - platform str
 - Specifies the platform for which agent needs to be downloaded.
 - x_
ibm_ strtenant_ id  - Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
 - id str
 - The unique identifier of the backup_recovery_download_agent.
 - linux_
params GetBackup Recovery Download Agent Linux Params  - Linux agent parameters. Nested schema for linux_params:
 
- file
Path String - Specifies the absolute path for download.
- Constraints: Allowable values are: 
kWindows,kLinux. 
 - Constraints: Allowable values are: 
 - platform String
 - Specifies the platform for which agent needs to be downloaded.
 - x
Ibm StringTenant Id  - Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
 - id String
 - The unique identifier of the backup_recovery_download_agent.
 - linux
Params Property Map - Linux agent parameters. Nested schema for linux_params:
 
getBackupRecoveryDownloadAgent Result
The following output properties are available:
- File
Path string - Id string
 - The unique identifier of the backup_recovery_download_agent.
 - Platform string
 - XIbm
Tenant stringId  - Linux
Params GetBackup Recovery Download Agent Linux Params  
- File
Path string - Id string
 - The unique identifier of the backup_recovery_download_agent.
 - Platform string
 - XIbm
Tenant stringId  - Linux
Params GetBackup Recovery Download Agent Linux Params  
- file
Path String - id String
 - The unique identifier of the backup_recovery_download_agent.
 - platform String
 - x
Ibm StringTenant Id  - linux
Params GetBackup Recovery Download Agent Linux Params  
- file
Path string - id string
 - The unique identifier of the backup_recovery_download_agent.
 - platform string
 - x
Ibm stringTenant Id  - linux
Params GetBackup Recovery Download Agent Linux Params  
- file_
path str - id str
 - The unique identifier of the backup_recovery_download_agent.
 - platform str
 - x_
ibm_ strtenant_ id  - linux_
params GetBackup Recovery Download Agent Linux Params  
- file
Path String - id String
 - The unique identifier of the backup_recovery_download_agent.
 - platform String
 - x
Ibm StringTenant Id  - linux
Params Property Map 
Supporting Types
GetBackupRecoveryDownloadAgentLinuxParams      
- Package
Type string - Specifies the type of installer.
- Constraints: Allowable values are: 
kScript,kRPM,kSuseRPM,kDEB,kPowerPCRPM. 
 - Constraints: Allowable values are: 
 
- Package
Type string - Specifies the type of installer.
- Constraints: Allowable values are: 
kScript,kRPM,kSuseRPM,kDEB,kPowerPCRPM. 
 - Constraints: Allowable values are: 
 
- package
Type String - Specifies the type of installer.
- Constraints: Allowable values are: 
kScript,kRPM,kSuseRPM,kDEB,kPowerPCRPM. 
 - Constraints: Allowable values are: 
 
- package
Type string - Specifies the type of installer.
- Constraints: Allowable values are: 
kScript,kRPM,kSuseRPM,kDEB,kPowerPCRPM. 
 - Constraints: Allowable values are: 
 
- package_
type str - Specifies the type of installer.
- Constraints: Allowable values are: 
kScript,kRPM,kSuseRPM,kDEB,kPowerPCRPM. 
 - Constraints: Allowable values are: 
 
- package
Type String - Specifies the type of installer.
- Constraints: Allowable values are: 
kScript,kRPM,kSuseRPM,kDEB,kPowerPCRPM. 
 - Constraints: Allowable values are: 
 
Package Details
- Repository
 - ibm ibm-cloud/terraform-provider-ibm
 - License
 - Notes
 - This Pulumi package is based on the 
ibmTerraform Provider.