Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. hbr
  5. getHanaBackupClients
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.hbr.getHanaBackupClients

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

    This data source provides the Hybrid Backup Recovery (HBR) Hana Backup Clients of the current Alibaba Cloud user.

    NOTE: Available in 1.198.0+

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const ids = alicloud.hbr.getHanaBackupClients({
    ids: ["example_id"],
    vaultId: "your_vault_id",
});
export const hbrHanaBackupClientsId1 = ids.then(ids => ids.hanaBackupClients?.[0]?.id);

    import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.hbr.get_hana_backup_clients(ids=["example_id"],
    vault_id="your_vault_id")
pulumi.export("hbrHanaBackupClientsId1", ids.hana_backup_clients[0].id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := hbr.GetHanaBackupClients(ctx, &hbr.GetHanaBackupClientsArgs{
			Ids: []string{
				"example_id",
			},
			VaultId: "your_vault_id",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("hbrHanaBackupClientsId1", ids.HanaBackupClients[0].Id)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.Hbr.GetHanaBackupClients.Invoke(new()
    {
        Ids = new[]
        {
            "example_id",
        },
        VaultId = "your_vault_id",
    });

    return new Dictionary<string, object?>
    {
        ["hbrHanaBackupClientsId1"] = ids.Apply(getHanaBackupClientsResult => getHanaBackupClientsResult.HanaBackupClients[0]?.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.hbr.HbrFunctions;
import com.pulumi.alicloud.hbr.inputs.GetHanaBackupClientsArgs;
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 ids = HbrFunctions.getHanaBackupClients(GetHanaBackupClientsArgs.builder()
            .ids("example_id")
            .vaultId("your_vault_id")
            .build());

        ctx.export("hbrHanaBackupClientsId1", ids.applyValue(getHanaBackupClientsResult -> getHanaBackupClientsResult.hanaBackupClients()[0].id()));
    }
}

    variables:
  ids:
    fn::invoke:
      function: alicloud:hbr:getHanaBackupClients
      arguments:
        ids:
          - example_id
        vaultId: your_vault_id
outputs:
  hbrHanaBackupClientsId1: ${ids.hanaBackupClients[0].id}

    Using getHanaBackupClients

    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 getHanaBackupClients(args: GetHanaBackupClientsArgs, opts?: InvokeOptions): Promise<GetHanaBackupClientsResult>
function getHanaBackupClientsOutput(args: GetHanaBackupClientsOutputArgs, opts?: InvokeOptions): Output<GetHanaBackupClientsResult>
    def get_hana_backup_clients(client_id: Optional[str] = None,
                            cluster_id: Optional[str] = None,
                            ids: Optional[Sequence[str]] = None,
                            output_file: Optional[str] = None,
                            page_number: Optional[int] = None,
                            page_size: Optional[int] = None,
                            status: Optional[str] = None,
                            vault_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetHanaBackupClientsResult
def get_hana_backup_clients_output(client_id: Optional[pulumi.Input[str]] = None,
                            cluster_id: Optional[pulumi.Input[str]] = None,
                            ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                            output_file: Optional[pulumi.Input[str]] = None,
                            page_number: Optional[pulumi.Input[int]] = None,
                            page_size: Optional[pulumi.Input[int]] = None,
                            status: Optional[pulumi.Input[str]] = None,
                            vault_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetHanaBackupClientsResult]
    func GetHanaBackupClients(ctx *Context, args *GetHanaBackupClientsArgs, opts ...InvokeOption) (*GetHanaBackupClientsResult, error)
func GetHanaBackupClientsOutput(ctx *Context, args *GetHanaBackupClientsOutputArgs, opts ...InvokeOption) GetHanaBackupClientsResultOutput

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

    public static class GetHanaBackupClients 
{
    public static Task<GetHanaBackupClientsResult> InvokeAsync(GetHanaBackupClientsArgs args, InvokeOptions? opts = null)
    public static Output<GetHanaBackupClientsResult> Invoke(GetHanaBackupClientsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHanaBackupClientsResult> getHanaBackupClients(GetHanaBackupClientsArgs args, InvokeOptions options)
public static Output<GetHanaBackupClientsResult> getHanaBackupClients(GetHanaBackupClientsArgs args, InvokeOptions options)

    fn::invoke:
  function: alicloud:hbr/getHanaBackupClients:getHanaBackupClients
  arguments:
    # arguments dictionary

    The following arguments are supported:

    VaultId string
    The ID of the backup vault.
    ClientId string
    The ID of the backup client.
    ClusterId string
    The ID of the SAP HANA instance.
    Ids List<string>
    A list of Hana Backup Client IDs.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PageNumber int
    PageSize int
    Status string
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    VaultId string
    The ID of the backup vault.
    ClientId string
    The ID of the backup client.
    ClusterId string
    The ID of the SAP HANA instance.
    Ids []string
    A list of Hana Backup Client IDs.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    PageNumber int
    PageSize int
    Status string
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    vaultId String
    The ID of the backup vault.
    clientId String
    The ID of the backup client.
    clusterId String
    The ID of the SAP HANA instance.
    ids List<String>
    A list of Hana Backup Client IDs.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    pageNumber Integer
    pageSize Integer
    status String
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    vaultId string
    The ID of the backup vault.
    clientId string
    The ID of the backup client.
    clusterId string
    The ID of the SAP HANA instance.
    ids string[]
    A list of Hana Backup Client IDs.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    pageNumber number
    pageSize number
    status string
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    vault_id str
    The ID of the backup vault.
    client_id str
    The ID of the backup client.
    cluster_id str
    The ID of the SAP HANA instance.
    ids Sequence[str]
    A list of Hana Backup Client IDs.
    output_file str
    File name where to save data source results (after running pulumi preview).
    page_number int
    page_size int
    status str
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    vaultId String
    The ID of the backup vault.
    clientId String
    The ID of the backup client.
    clusterId String
    The ID of the SAP HANA instance.
    ids List<String>
    A list of Hana Backup Client IDs.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    pageNumber Number
    pageSize Number
    status String
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.

    getHanaBackupClients Result

    The following output properties are available:

    HanaBackupClients List<Pulumi.AliCloud.Hbr.Outputs.GetHanaBackupClientsHanaBackupClient>
    A list of Hana Backup Clients. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    VaultId string
    The ID of the backup vault.
    ClientId string
    The ID of the backup client.
    ClusterId string
    The ID of the SAP HANA instance.
    OutputFile string
    PageNumber int
    PageSize int
    Status string
    The status of the backup client.
    HanaBackupClients []GetHanaBackupClientsHanaBackupClient
    A list of Hana Backup Clients. Each element contains the following attributes:
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    VaultId string
    The ID of the backup vault.
    ClientId string
    The ID of the backup client.
    ClusterId string
    The ID of the SAP HANA instance.
    OutputFile string
    PageNumber int
    PageSize int
    Status string
    The status of the backup client.
    hanaBackupClients List<GetHanaBackupClientsHanaBackupClient>
    A list of Hana Backup Clients. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    vaultId String
    The ID of the backup vault.
    clientId String
    The ID of the backup client.
    clusterId String
    The ID of the SAP HANA instance.
    outputFile String
    pageNumber Integer
    pageSize Integer
    status String
    The status of the backup client.
    hanaBackupClients GetHanaBackupClientsHanaBackupClient[]
    A list of Hana Backup Clients. Each element contains the following attributes:
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    vaultId string
    The ID of the backup vault.
    clientId string
    The ID of the backup client.
    clusterId string
    The ID of the SAP HANA instance.
    outputFile string
    pageNumber number
    pageSize number
    status string
    The status of the backup client.
    hana_backup_clients Sequence[GetHanaBackupClientsHanaBackupClient]
    A list of Hana Backup Clients. Each element contains the following attributes:
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    vault_id str
    The ID of the backup vault.
    client_id str
    The ID of the backup client.
    cluster_id str
    The ID of the SAP HANA instance.
    output_file str
    page_number int
    page_size int
    status str
    The status of the backup client.
    hanaBackupClients List<Property Map>
    A list of Hana Backup Clients. Each element contains the following attributes:
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    vaultId String
    The ID of the backup vault.
    clientId String
    The ID of the backup client.
    clusterId String
    The ID of the SAP HANA instance.
    outputFile String
    pageNumber Number
    pageSize Number
    status String
    The status of the backup client.

    Supporting Types

    GetHanaBackupClientsHanaBackupClient

    AlertSetting string
    The alert settings.
    ClientId string
    The ID of the backup client.
    ClientName string
    The name of the backup client.
    ClientType string
    The type of the backup client.
    ClientVersion string
    The version number of the backup client.
    ClusterId string
    The ID of the SAP HANA instance.
    Id string
    The id of the Hana Backup Client. It formats as <vault_id>:<client_id>.
    InstanceId string
    The ID of the instance.
    InstanceName string
    The name of the ECS instance.
    MaxVersion string
    The maximum version number of the backup client.
    NetworkType string
    The network type.
    Status string
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    StatusMessage string
    The status information.
    UseHttps bool
    Indicates whether data is transmitted over HTTPS.
    VaultId string
    The ID of the backup vault.
    AlertSetting string
    The alert settings.
    ClientId string
    The ID of the backup client.
    ClientName string
    The name of the backup client.
    ClientType string
    The type of the backup client.
    ClientVersion string
    The version number of the backup client.
    ClusterId string
    The ID of the SAP HANA instance.
    Id string
    The id of the Hana Backup Client. It formats as <vault_id>:<client_id>.
    InstanceId string
    The ID of the instance.
    InstanceName string
    The name of the ECS instance.
    MaxVersion string
    The maximum version number of the backup client.
    NetworkType string
    The network type.
    Status string
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    StatusMessage string
    The status information.
    UseHttps bool
    Indicates whether data is transmitted over HTTPS.
    VaultId string
    The ID of the backup vault.
    alertSetting String
    The alert settings.
    clientId String
    The ID of the backup client.
    clientName String
    The name of the backup client.
    clientType String
    The type of the backup client.
    clientVersion String
    The version number of the backup client.
    clusterId String
    The ID of the SAP HANA instance.
    id String
    The id of the Hana Backup Client. It formats as <vault_id>:<client_id>.
    instanceId String
    The ID of the instance.
    instanceName String
    The name of the ECS instance.
    maxVersion String
    The maximum version number of the backup client.
    networkType String
    The network type.
    status String
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    statusMessage String
    The status information.
    useHttps Boolean
    Indicates whether data is transmitted over HTTPS.
    vaultId String
    The ID of the backup vault.
    alertSetting string
    The alert settings.
    clientId string
    The ID of the backup client.
    clientName string
    The name of the backup client.
    clientType string
    The type of the backup client.
    clientVersion string
    The version number of the backup client.
    clusterId string
    The ID of the SAP HANA instance.
    id string
    The id of the Hana Backup Client. It formats as <vault_id>:<client_id>.
    instanceId string
    The ID of the instance.
    instanceName string
    The name of the ECS instance.
    maxVersion string
    The maximum version number of the backup client.
    networkType string
    The network type.
    status string
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    statusMessage string
    The status information.
    useHttps boolean
    Indicates whether data is transmitted over HTTPS.
    vaultId string
    The ID of the backup vault.
    alert_setting str
    The alert settings.
    client_id str
    The ID of the backup client.
    client_name str
    The name of the backup client.
    client_type str
    The type of the backup client.
    client_version str
    The version number of the backup client.
    cluster_id str
    The ID of the SAP HANA instance.
    id str
    The id of the Hana Backup Client. It formats as <vault_id>:<client_id>.
    instance_id str
    The ID of the instance.
    instance_name str
    The name of the ECS instance.
    max_version str
    The maximum version number of the backup client.
    network_type str
    The network type.
    status str
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    status_message str
    The status information.
    use_https bool
    Indicates whether data is transmitted over HTTPS.
    vault_id str
    The ID of the backup vault.
    alertSetting String
    The alert settings.
    clientId String
    The ID of the backup client.
    clientName String
    The name of the backup client.
    clientType String
    The type of the backup client.
    clientVersion String
    The version number of the backup client.
    clusterId String
    The ID of the SAP HANA instance.
    id String
    The id of the Hana Backup Client. It formats as <vault_id>:<client_id>.
    instanceId String
    The ID of the instance.
    instanceName String
    The name of the ECS instance.
    maxVersion String
    The maximum version number of the backup client.
    networkType String
    The network type.
    status String
    The status of the Hana Backup Client. Valid Values: REGISTERED, ACTIVATED, DEACTIVATED, INSTALLING, INSTALL_FAILED, NOT_INSTALLED, UPGRADING, UPGRADE_FAILED, UNINSTALLING, UNINSTALL_FAILED, STOPPED, UNKNOWN.
    statusMessage String
    The status information.
    useHttps Boolean
    Indicates whether data is transmitted over HTTPS.
    vaultId String
    The ID of the backup vault.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-alicloud