Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getBackupRecoveryVaultRecoveryScanStatus
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getBackupRecoveryVaultRecoveryScanStatus

ibm
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to retrieve information about Get Batch Vault Recovery Scan Status. 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 backupRecoveryVaultRecoveryScanStatus = ibm.getBackupRecoveryVaultRecoveryScanStatus({
    cloudType: "ibm",
    xIbmTenantId: "tenantId",
});

    import pulumi
import pulumi_ibm as ibm

backup_recovery_vault_recovery_scan_status = ibm.get_backup_recovery_vault_recovery_scan_status(cloud_type="ibm",
    x_ibm_tenant_id="tenantId")

    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.GetBackupRecoveryVaultRecoveryScanStatus(ctx, &ibm.GetBackupRecoveryVaultRecoveryScanStatusArgs{
			CloudType:    "ibm",
			XIbmTenantId: "tenantId",
		}, 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 backupRecoveryVaultRecoveryScanStatus = Ibm.GetBackupRecoveryVaultRecoveryScanStatus.Invoke(new()
    {
        CloudType = "ibm",
        XIbmTenantId = "tenantId",
    });

});

    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.GetBackupRecoveryVaultRecoveryScanStatusArgs;
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 backupRecoveryVaultRecoveryScanStatus = IbmFunctions.getBackupRecoveryVaultRecoveryScanStatus(GetBackupRecoveryVaultRecoveryScanStatusArgs.builder()
            .cloudType("ibm")
            .xIbmTenantId("tenantId")
            .build());

    }
}

    variables:
  backupRecoveryVaultRecoveryScanStatus:
    fn::invoke:
      function: ibm:getBackupRecoveryVaultRecoveryScanStatus
      arguments:
        cloudType: ibm
        xIbmTenantId: tenantId

    Example coming soon!

    Using getBackupRecoveryVaultRecoveryScanStatus

    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 getBackupRecoveryVaultRecoveryScanStatus(args: GetBackupRecoveryVaultRecoveryScanStatusArgs, opts?: InvokeOptions): Promise<GetBackupRecoveryVaultRecoveryScanStatusResult>
function getBackupRecoveryVaultRecoveryScanStatusOutput(args: GetBackupRecoveryVaultRecoveryScanStatusOutputArgs, opts?: InvokeOutputOptions): Output<GetBackupRecoveryVaultRecoveryScanStatusResult>
    def get_backup_recovery_vault_recovery_scan_status(cloud_type: Optional[str] = None,
                                                   endpoint_type: Optional[str] = None,
                                                   id: Optional[str] = None,
                                                   instance_id: Optional[str] = None,
                                                   region: Optional[str] = None,
                                                   service_name: Optional[str] = None,
                                                   vault_ids: Optional[Sequence[float]] = None,
                                                   x_ibm_tenant_id: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetBackupRecoveryVaultRecoveryScanStatusResult
def get_backup_recovery_vault_recovery_scan_status_output(cloud_type: pulumi.Input[Optional[str]] = None,
                                                   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,
                                                   vault_ids: pulumi.Input[Optional[Sequence[pulumi.Input[float]]]] = None,
                                                   x_ibm_tenant_id: pulumi.Input[Optional[str]] = None,
                                                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetBackupRecoveryVaultRecoveryScanStatusResult]
    func GetBackupRecoveryVaultRecoveryScanStatus(ctx *Context, args *GetBackupRecoveryVaultRecoveryScanStatusArgs, opts ...InvokeOption) (*GetBackupRecoveryVaultRecoveryScanStatusResult, error)
func GetBackupRecoveryVaultRecoveryScanStatusOutput(ctx *Context, args *GetBackupRecoveryVaultRecoveryScanStatusOutputArgs, opts ...InvokeOption) GetBackupRecoveryVaultRecoveryScanStatusResultOutput

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

    public static class GetBackupRecoveryVaultRecoveryScanStatus 
{
    public static Task<GetBackupRecoveryVaultRecoveryScanStatusResult> InvokeAsync(GetBackupRecoveryVaultRecoveryScanStatusArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryVaultRecoveryScanStatusResult> Invoke(GetBackupRecoveryVaultRecoveryScanStatusInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupRecoveryVaultRecoveryScanStatusResult> Invoke(GetBackupRecoveryVaultRecoveryScanStatusInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBackupRecoveryVaultRecoveryScanStatusResult> getBackupRecoveryVaultRecoveryScanStatus(GetBackupRecoveryVaultRecoveryScanStatusArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryVaultRecoveryScanStatusResult> getBackupRecoveryVaultRecoveryScanStatus(GetBackupRecoveryVaultRecoveryScanStatusArgs args, InvokeOptions options)
public static Output<GetBackupRecoveryVaultRecoveryScanStatusResult> getBackupRecoveryVaultRecoveryScanStatus(GetBackupRecoveryVaultRecoveryScanStatusArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ibm:index/getBackupRecoveryVaultRecoveryScanStatus:getBackupRecoveryVaultRecoveryScanStatus
  arguments:
    # arguments dictionary
    data "ibm_get_backup_recovery_vault_recovery_scan_status" "name" {
    # arguments
}

    The following arguments are supported:

    CloudType string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    XIbmTenantId string
    Id of the tenant accessing the cluster.
    EndpointType string
    Id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    InstanceId string
    Region string
    ServiceName string
    VaultIds List<double>
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.
    CloudType string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    XIbmTenantId string
    Id of the tenant accessing the cluster.
    EndpointType string
    Id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    InstanceId string
    Region string
    ServiceName string
    VaultIds []float64
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.
    cloud_type string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    x_ibm_tenant_id string
    Id of the tenant accessing the cluster.
    endpoint_type string
    id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    instance_id string
    region string
    service_name string
    vault_ids list(number)
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.
    cloudType String
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    xIbmTenantId String
    Id of the tenant accessing the cluster.
    endpointType String
    id String
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    instanceId String
    region String
    serviceName String
    vaultIds List<Double>
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.
    cloudType string
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    xIbmTenantId string
    Id of the tenant accessing the cluster.
    endpointType string
    id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    instanceId string
    region string
    serviceName string
    vaultIds number[]
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.
    cloud_type str
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    x_ibm_tenant_id str
    Id of the tenant accessing the cluster.
    endpoint_type str
    id str
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    instance_id str
    region str
    service_name str
    vault_ids Sequence[float]
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.
    cloudType String
    Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for recover scans.

    • Constraints: Allowable values are: ibm.
    xIbmTenantId String
    Id of the tenant accessing the cluster.
    endpointType String
    id String
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    instanceId String
    region String
    serviceName String
    vaultIds List<Number>
    Specifies the unique ids of the Backup and Recovery instances for which the latest recovery scan status is to be fetched.

    getBackupRecoveryVaultRecoveryScanStatus Result

    The following output properties are available:

    CloudType string
    ErrorMessage string
    (String) Specifies the error message if the recovery scan failed.
    Id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    RecoveryScanStatuses List<GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatus>
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    Region string
    XIbmTenantId string
    EndpointType string
    InstanceId string
    ServiceName string
    VaultIds List<double>
    CloudType string
    ErrorMessage string
    (String) Specifies the error message if the recovery scan failed.
    Id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    RecoveryScanStatuses []GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatus
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    Region string
    XIbmTenantId string
    EndpointType string
    InstanceId string
    ServiceName string
    VaultIds []float64
    cloud_type string
    error_message string
    (String) Specifies the error message if the recovery scan failed.
    id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    recovery_scan_statuses list(object)
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    region string
    x_ibm_tenant_id string
    endpoint_type string
    instance_id string
    service_name string
    vault_ids list(number)
    cloudType String
    errorMessage String
    (String) Specifies the error message if the recovery scan failed.
    id String
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    recoveryScanStatuses List<GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatus>
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    region String
    xIbmTenantId String
    endpointType String
    instanceId String
    serviceName String
    vaultIds List<Double>
    cloudType string
    errorMessage string
    (String) Specifies the error message if the recovery scan failed.
    id string
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    recoveryScanStatuses GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatus[]
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    region string
    xIbmTenantId string
    endpointType string
    instanceId string
    serviceName string
    vaultIds number[]
    cloud_type str
    error_message str
    (String) Specifies the error message if the recovery scan failed.
    id str
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    recovery_scan_statuses Sequence[GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatus]
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    region str
    x_ibm_tenant_id str
    endpoint_type str
    instance_id str
    service_name str
    vault_ids Sequence[float]
    cloudType String
    errorMessage String
    (String) Specifies the error message if the recovery scan failed.
    id String
    The unique identifier of the Get Batch Vault Recovery Scan Status.
    recoveryScanStatuses List<Property Map>
    (List) Array of recovery scan statuses for the specified Backup and Recovery instances. Nested schema for recovery_scan_statuses:
    region String
    xIbmTenantId String
    endpointType String
    instanceId String
    serviceName String
    vaultIds List<Number>

    Supporting Types

    GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatus

    Statuses List<GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatusStatus>
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    VaultId double
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    Statuses []GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatusStatus
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    VaultId float64
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses list(object)
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vault_id number
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses List<GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatusStatus>
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vaultId Double
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatusStatus[]
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vaultId number
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses Sequence[GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatusStatus]
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vault_id float
    (Integer) Specifies the unique id of the Backup and Recovery instance.
    statuses List<Property Map>
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    vaultId Number
    (Integer) Specifies the unique id of the Backup and Recovery instance.

    GetBackupRecoveryVaultRecoveryScanStatusRecoveryScanStatusStatus

    EndTimeUsecs double
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    ErrorMessage string
    (String) Specifies the error message if the recovery scan failed.
    StartTimeUsecs double
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    Status string
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    Uid string
    (String) Specifies the unique id of the recovery scan.
    EndTimeUsecs float64
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    ErrorMessage string
    (String) Specifies the error message if the recovery scan failed.
    StartTimeUsecs float64
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    Status string
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    Uid string
    (String) Specifies the unique id of the recovery scan.
    end_time_usecs number
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    error_message string
    (String) Specifies the error message if the recovery scan failed.
    start_time_usecs number
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    status string
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid string
    (String) Specifies the unique id of the recovery scan.
    endTimeUsecs Double
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    errorMessage String
    (String) Specifies the error message if the recovery scan failed.
    startTimeUsecs Double
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    status String
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid String
    (String) Specifies the unique id of the recovery scan.
    endTimeUsecs number
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    errorMessage string
    (String) Specifies the error message if the recovery scan failed.
    startTimeUsecs number
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    status string
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid string
    (String) Specifies the unique id of the recovery scan.
    end_time_usecs float
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    error_message str
    (String) Specifies the error message if the recovery scan failed.
    start_time_usecs float
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    status str
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid str
    (String) Specifies the unique id of the recovery scan.
    endTimeUsecs Number
    (Integer) Specifies the end time of the recovery scan in microseconds since epoch.
    errorMessage String
    (String) Specifies the error message if the recovery scan failed.
    startTimeUsecs Number
    (Integer) Specifies the start time of the recovery scan in microseconds since epoch.
    status String
    (String) Specifies the current status of the recovery scan.

    • Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, LegalHold.
    uid String
    (String) Specifies the unique id of the recovery scan.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm
    Viewing docs for ibm 2.9.0
    published on Thursday, Nov 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial