1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getBackupRecoveryConnectorAgentConfig
Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud

    Provides a read-only data source to retrieve information about a Connector agent config. 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 backupRecoveryConnectorAgentConfig = ibm.getBackupRecoveryConnectorAgentConfig({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    backup_recovery_connector_agent_config = ibm.get_backup_recovery_connector_agent_config()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetBackupRecoveryConnectorAgentConfig(ctx, &ibm.GetBackupRecoveryConnectorAgentConfigArgs{}, 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 backupRecoveryConnectorAgentConfig = Ibm.GetBackupRecoveryConnectorAgentConfig.Invoke();
    
    });
    
    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.GetBackupRecoveryConnectorAgentConfigArgs;
    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 backupRecoveryConnectorAgentConfig = IbmFunctions.getBackupRecoveryConnectorAgentConfig(GetBackupRecoveryConnectorAgentConfigArgs.builder()
                .build());
    
        }
    }
    
    variables:
      backupRecoveryConnectorAgentConfig:
        fn::invoke:
          function: ibm:getBackupRecoveryConnectorAgentConfig
          arguments: {}
    
    Example coming soon!
    

    Using getBackupRecoveryConnectorAgentConfig

    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 getBackupRecoveryConnectorAgentConfig(args: GetBackupRecoveryConnectorAgentConfigArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryConnectorAgentConfigResult>
    function getBackupRecoveryConnectorAgentConfigOutput(args: GetBackupRecoveryConnectorAgentConfigOutputArgs, opts?: InvokeOptions): Output<GetBackupRecoveryConnectorAgentConfigResult>
    def get_backup_recovery_connector_agent_config(endpoint_type: Optional[str] = None,
                                                   id: Optional[str] = None,
                                                   instance_id: Optional[str] = None,
                                                   region: Optional[str] = None,
                                                   service_name: Optional[str] = None,
                                                   x_ibm_tenant_id: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryConnectorAgentConfigResult
    def get_backup_recovery_connector_agent_config_output(endpoint_type: pulumi.Input[Optional[str]] = None,
                                                   id: pulumi.Input[Optional[str]] = None,
                                                   instance_id: pulumi.Input[Optional[str]] = None,
                                                   region: pulumi.Input[Optional[str]] = None,
                                                   service_name: pulumi.Input[Optional[str]] = None,
                                                   x_ibm_tenant_id: pulumi.Input[Optional[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetBackupRecoveryConnectorAgentConfigResult]
    func GetBackupRecoveryConnectorAgentConfig(ctx *Context, args *GetBackupRecoveryConnectorAgentConfigArgs, opts ...InvokeOption) (*GetBackupRecoveryConnectorAgentConfigResult, error)
    func GetBackupRecoveryConnectorAgentConfigOutput(ctx *Context, args *GetBackupRecoveryConnectorAgentConfigOutputArgs, opts ...InvokeOption) GetBackupRecoveryConnectorAgentConfigResultOutput

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

    public static class GetBackupRecoveryConnectorAgentConfig 
    {
        public static Task<GetBackupRecoveryConnectorAgentConfigResult> InvokeAsync(GetBackupRecoveryConnectorAgentConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetBackupRecoveryConnectorAgentConfigResult> Invoke(GetBackupRecoveryConnectorAgentConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBackupRecoveryConnectorAgentConfigResult> getBackupRecoveryConnectorAgentConfig(GetBackupRecoveryConnectorAgentConfigArgs args, InvokeOptions options)
    public static Output<GetBackupRecoveryConnectorAgentConfigResult> getBackupRecoveryConnectorAgentConfig(GetBackupRecoveryConnectorAgentConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getBackupRecoveryConnectorAgentConfig:getBackupRecoveryConnectorAgentConfig
      arguments:
        # arguments dictionary
    data "ibm_get_backup_recovery_connector_agent_config" "name" {
        # arguments
    }

    The following arguments are supported:

    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
    Id string
    InstanceId string
    Region string
    ServiceName string
    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
    Id string
    InstanceId string
    Region string
    ServiceName string
    x_ibm_tenant_id string
    Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.
    endpoint_type string
    id string
    instance_id string
    region string
    service_name string
    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
    id String
    instanceId String
    region String
    serviceName String
    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
    id string
    instanceId string
    region string
    serviceName string
    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
    id str
    instance_id str
    region str
    service_name str
    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
    id String
    instanceId String
    region String
    serviceName String

    getBackupRecoveryConnectorAgentConfig Result

    The following output properties are available:

    Id string
    Region string
    RegistrationToken string
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    XIbmTenantId string
    EndpointType string
    InstanceId string
    ServiceName string
    Id string
    Region string
    RegistrationToken string
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    XIbmTenantId string
    EndpointType string
    InstanceId string
    ServiceName string
    id string
    region string
    registration_token string
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    x_ibm_tenant_id string
    endpoint_type string
    instance_id string
    service_name string
    id String
    region String
    registrationToken String
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    xIbmTenantId String
    endpointType String
    instanceId String
    serviceName String
    id string
    region string
    registrationToken string
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    xIbmTenantId string
    endpointType string
    instanceId string
    serviceName string
    id str
    region str
    registration_token str
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    x_ibm_tenant_id str
    endpoint_type str
    instance_id str
    service_name str
    id String
    region String
    registrationToken String
    (String) Token that is used for authenticating the connector agent with the DataProtect cluster.
    xIbmTenantId String
    endpointType String
    instanceId String
    serviceName String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.5.0
    published on Wednesday, Aug 5, 2026 by ibm-cloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial