Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getDisasterRecoveryFailoverGroup
Viewing docs for Databricks v1.94.0
published on Friday, May 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getDisasterRecoveryFailoverGroup

databricks logo
Viewing docs for Databricks v1.94.0
published on Friday, May 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Private Preview

    Using getDisasterRecoveryFailoverGroup

    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 getDisasterRecoveryFailoverGroup(args: GetDisasterRecoveryFailoverGroupArgs, opts?: InvokeOptions): Promise<GetDisasterRecoveryFailoverGroupResult>
function getDisasterRecoveryFailoverGroupOutput(args: GetDisasterRecoveryFailoverGroupOutputArgs, opts?: InvokeOptions): Output<GetDisasterRecoveryFailoverGroupResult>
    def get_disaster_recovery_failover_group(name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetDisasterRecoveryFailoverGroupResult
def get_disaster_recovery_failover_group_output(name: pulumi.Input[Optional[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetDisasterRecoveryFailoverGroupResult]
    func LookupDisasterRecoveryFailoverGroup(ctx *Context, args *LookupDisasterRecoveryFailoverGroupArgs, opts ...InvokeOption) (*LookupDisasterRecoveryFailoverGroupResult, error)
func LookupDisasterRecoveryFailoverGroupOutput(ctx *Context, args *LookupDisasterRecoveryFailoverGroupOutputArgs, opts ...InvokeOption) LookupDisasterRecoveryFailoverGroupResultOutput

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

    public static class GetDisasterRecoveryFailoverGroup 
{
    public static Task<GetDisasterRecoveryFailoverGroupResult> InvokeAsync(GetDisasterRecoveryFailoverGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDisasterRecoveryFailoverGroupResult> Invoke(GetDisasterRecoveryFailoverGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDisasterRecoveryFailoverGroupResult> getDisasterRecoveryFailoverGroup(GetDisasterRecoveryFailoverGroupArgs args, InvokeOptions options)
public static Output<GetDisasterRecoveryFailoverGroupResult> getDisasterRecoveryFailoverGroup(GetDisasterRecoveryFailoverGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getDisasterRecoveryFailoverGroup:getDisasterRecoveryFailoverGroup
  arguments:
    # arguments dictionary
    data "databricks_getdisasterrecoveryfailovergroup" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name str
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}

    getDisasterRecoveryFailoverGroup Result

    The following output properties are available:

    CreateTime string
    (string) - Time at which this failover group was created
    EffectivePrimaryRegion string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    Etag string
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialPrimaryRegion string
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    Name string
    (string) - Resource name for this workspace set
    Regions List<string>
    (list of string) - List of all regions participating in this failover group
    ReplicationPoint string
    (string) - The latest point in time to which data has been replicated
    State string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    UnityCatalogAssets GetDisasterRecoveryFailoverGroupUnityCatalogAssets
    (UcReplicationConfig) - Unity Catalog replication configuration
    UpdateTime string
    (string) - Time at which this failover group was last modified
    WorkspaceSets List<GetDisasterRecoveryFailoverGroupWorkspaceSet>
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other
    CreateTime string
    (string) - Time at which this failover group was created
    EffectivePrimaryRegion string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    Etag string
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialPrimaryRegion string
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    Name string
    (string) - Resource name for this workspace set
    Regions []string
    (list of string) - List of all regions participating in this failover group
    ReplicationPoint string
    (string) - The latest point in time to which data has been replicated
    State string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    UnityCatalogAssets GetDisasterRecoveryFailoverGroupUnityCatalogAssets
    (UcReplicationConfig) - Unity Catalog replication configuration
    UpdateTime string
    (string) - Time at which this failover group was last modified
    WorkspaceSets []GetDisasterRecoveryFailoverGroupWorkspaceSet
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other
    create_time string
    (string) - Time at which this failover group was created
    effective_primary_region string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    etag string
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    id string
    The provider-assigned unique ID for this managed resource.
    initial_primary_region string
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name string
    (string) - Resource name for this workspace set
    regions list(string)
    (list of string) - List of all regions participating in this failover group
    replication_point string
    (string) - The latest point in time to which data has been replicated
    state string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unity_catalog_assets object
    (UcReplicationConfig) - Unity Catalog replication configuration
    update_time string
    (string) - Time at which this failover group was last modified
    workspace_sets list(object)
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other
    createTime String
    (string) - Time at which this failover group was created
    effectivePrimaryRegion String
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    etag String
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    id String
    The provider-assigned unique ID for this managed resource.
    initialPrimaryRegion String
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name String
    (string) - Resource name for this workspace set
    regions List<String>
    (list of string) - List of all regions participating in this failover group
    replicationPoint String
    (string) - The latest point in time to which data has been replicated
    state String
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unityCatalogAssets GetDisasterRecoveryFailoverGroupUnityCatalogAssets
    (UcReplicationConfig) - Unity Catalog replication configuration
    updateTime String
    (string) - Time at which this failover group was last modified
    workspaceSets List<GetDisasterRecoveryFailoverGroupWorkspaceSet>
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other
    createTime string
    (string) - Time at which this failover group was created
    effectivePrimaryRegion string
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    etag string
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    id string
    The provider-assigned unique ID for this managed resource.
    initialPrimaryRegion string
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name string
    (string) - Resource name for this workspace set
    regions string[]
    (list of string) - List of all regions participating in this failover group
    replicationPoint string
    (string) - The latest point in time to which data has been replicated
    state string
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unityCatalogAssets GetDisasterRecoveryFailoverGroupUnityCatalogAssets
    (UcReplicationConfig) - Unity Catalog replication configuration
    updateTime string
    (string) - Time at which this failover group was last modified
    workspaceSets GetDisasterRecoveryFailoverGroupWorkspaceSet[]
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other
    create_time str
    (string) - Time at which this failover group was created
    effective_primary_region str
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    etag str
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    id str
    The provider-assigned unique ID for this managed resource.
    initial_primary_region str
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name str
    (string) - Resource name for this workspace set
    regions Sequence[str]
    (list of string) - List of all regions participating in this failover group
    replication_point str
    (string) - The latest point in time to which data has been replicated
    state str
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unity_catalog_assets GetDisasterRecoveryFailoverGroupUnityCatalogAssets
    (UcReplicationConfig) - Unity Catalog replication configuration
    update_time str
    (string) - Time at which this failover group was last modified
    workspace_sets Sequence[GetDisasterRecoveryFailoverGroupWorkspaceSet]
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other
    createTime String
    (string) - Time at which this failover group was created
    effectivePrimaryRegion String
    (string) - Current effective primary region. Replication flows FROM workspaces in this region. Changes after a successful failover
    etag String
    (string) - Opaque version string for optimistic locking. Server-generated, returned in responses. Must be provided on Update requests to prevent concurrent modifications
    id String
    The provider-assigned unique ID for this managed resource.
    initialPrimaryRegion String
    (string) - Initial primary region. Used only in Create requests to set the starting primary region. Not returned in responses
    name String
    (string) - Resource name for this workspace set
    regions List<String>
    (list of string) - List of all regions participating in this failover group
    replicationPoint String
    (string) - The latest point in time to which data has been replicated
    state String
    (string) - Aggregate state of the failover group. Possible values are: ACTIVE, CREATING, CREATION_FAILED, DELETING, DELETION_FAILED, FAILING_OVER, FAILOVER_FAILED, INITIAL_REPLICATION
    unityCatalogAssets Property Map
    (UcReplicationConfig) - Unity Catalog replication configuration
    updateTime String
    (string) - Time at which this failover group was last modified
    workspaceSets List<Property Map>
    (list of WorkspaceSet) - Workspace sets, each containing workspaces that replicate to each other

    Supporting Types

    GetDisasterRecoveryFailoverGroupUnityCatalogAssets

    Catalogs List<GetDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog>
    (list of UcCatalog) - UC catalogs to replicate
    DataReplicationWorkspaceSet string
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    LocationMappings List<GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping>
    (list of LocationMapping) - Location mappings - storage URI per region for each location
    Catalogs []GetDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog
    (list of UcCatalog) - UC catalogs to replicate
    DataReplicationWorkspaceSet string
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    LocationMappings []GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping
    (list of LocationMapping) - Location mappings - storage URI per region for each location
    catalogs list(object)
    (list of UcCatalog) - UC catalogs to replicate
    data_replication_workspace_set string
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    location_mappings list(object)
    (list of LocationMapping) - Location mappings - storage URI per region for each location
    catalogs List<GetDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog>
    (list of UcCatalog) - UC catalogs to replicate
    dataReplicationWorkspaceSet String
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    locationMappings List<GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping>
    (list of LocationMapping) - Location mappings - storage URI per region for each location
    catalogs GetDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog[]
    (list of UcCatalog) - UC catalogs to replicate
    dataReplicationWorkspaceSet string
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    locationMappings GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping[]
    (list of LocationMapping) - Location mappings - storage URI per region for each location
    catalogs Sequence[GetDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog]
    (list of UcCatalog) - UC catalogs to replicate
    data_replication_workspace_set str
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    location_mappings Sequence[GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping]
    (list of LocationMapping) - Location mappings - storage URI per region for each location
    catalogs List<Property Map>
    (list of UcCatalog) - UC catalogs to replicate
    dataReplicationWorkspaceSet String
    (string) - The workspace set whose workspaces will be used for data replication of all UC catalogs' underlying storage
    locationMappings List<Property Map>
    (list of LocationMapping) - Location mappings - storage URI per region for each location

    GetDisasterRecoveryFailoverGroupUnityCatalogAssetsCatalog

    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name str
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}

    GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMapping

    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    UriByRegions List<GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion>
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI
    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    UriByRegions []GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uri_by_regions list(object)
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uriByRegions List<GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion>
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uriByRegions GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion[]
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI
    name str
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uri_by_regions Sequence[GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion]
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    uriByRegions List<Property Map>
    (list of LocationMappingEntry) - URI for each region. Each entry maps a region name to a storage URI

    GetDisasterRecoveryFailoverGroupUnityCatalogAssetsLocationMappingUriByRegion

    Region string
    (string) - The region name
    Uri string
    (string) - The storage URI for this region
    Region string
    (string) - The region name
    Uri string
    (string) - The storage URI for this region
    region string
    (string) - The region name
    uri string
    (string) - The storage URI for this region
    region String
    (string) - The region name
    uri String
    (string) - The storage URI for this region
    region string
    (string) - The region name
    uri string
    (string) - The storage URI for this region
    region str
    (string) - The region name
    uri str
    (string) - The storage URI for this region
    region String
    (string) - The region name
    uri String
    (string) - The storage URI for this region

    GetDisasterRecoveryFailoverGroupWorkspaceSet

    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    ReplicateWorkspaceAssets bool
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    WorkspaceIds List<string>
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    StableUrlNames List<string>
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    Name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    ReplicateWorkspaceAssets bool
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    WorkspaceIds []string
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    StableUrlNames []string
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicate_workspace_assets bool
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspace_ids list(string)
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stable_url_names list(string)
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicateWorkspaceAssets Boolean
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspaceIds List<String>
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stableUrlNames List<String>
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name string
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicateWorkspaceAssets boolean
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspaceIds string[]
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stableUrlNames string[]
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name str
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicate_workspace_assets bool
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspace_ids Sequence[str]
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stable_url_names Sequence[str]
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)
    name String
    Fully qualified resource name in the format accounts/{account_id}/failover-groups/{failover_group_id}
    replicateWorkspaceAssets Boolean
    (boolean) - Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Requires all workspaces in the set to be Mission Critical tier
    workspaceIds List<String>
    (list of string) - Workspace IDs in this set. The system derives and validates regions. EA: exactly 2 workspaces (one per region)
    stableUrlNames List<String>
    (list of string) - Resource names of stable URLs associated with this workspace set. Format: accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already exist (via CreateStableUrl)

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v1.94.0
    published on Friday, May 29, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial