Databricks SDK for JavaScript
    Preparing search index...

    Interface StableUrl

    A stable URL provides a failover-aware endpoint for accessing a workspace. Its lifecycle is independent of any failover group.

    interface StableUrl {
        effectiveWorkspaceId?: string;
        failoverGroupName?: string;
        initialWorkspaceId?: string;
        name?: string;
        stableWorkspaceId?: string;
        url?: string;
    }
    Index

    Properties

    effectiveWorkspaceId? failoverGroupName? initialWorkspaceId? name? stableWorkspaceId? url?

    Properties

    effectiveWorkspaceId?: string

    The workspace this stable URL currently routes to. Set to initial_workspace_id at creation, advanced to the failover group's primary while attached (including across a failover), and preserved when the stable URL is detached from its failover group. Read this to see where an unattached stable URL points: after a failover followed by a detach it reflects the post-failover primary, not initial_workspace_id.

    failoverGroupName?: string

    Fully qualified resource name of the FailoverGroup this stable URL is currently linked to, in the format accounts/{account_id}/failover-groups/{failover_group_id}. Empty when the stable URL is not attached to any failover group.

    initialWorkspaceId?: string

    The workspace this stable URL is initially bound to. Used only in Create requests to associate the stable URL with a workspace. Not returned in responses.

    name?: string

    Fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

    stableWorkspaceId?: string

    The stable workspace ID for this stable URL. Generated on creation and immutable thereafter; identifies the URL across failovers and is the same value embedded in the url (as the w= query parameter for SPOG URLs, or in the conn-<id> hostname for Private-Link URLs).

    url?: string

    The stable URL endpoint. Generated on creation and immutable thereafter. For non-Private-Link workspaces this is https://<spog_host>/?w=<connection_id>. For Private-Link workspaces this is the per-connection hostname.

    Settings

    Member Visibility

    On This Page

    Properties