stable_urls

Creates, updates, deletes, gets or lists a stable_urls resource.

Overview

Name	stable_urls
Type	Resource
Id	databricks_account.disasterrecovery.stable_urls

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.
effective_workspace_id	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``.
initial_workspace_id	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.
stable_workspace_id	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).
failover_group_name	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.
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.

get

Name	Datatype	Description
name	string	Fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.
effective_workspace_id	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``.
initial_workspace_id	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.
stable_workspace_id	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).
failover_group_name	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.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	parent	page_size, page_token	List stable URLs for an account.
get	select	name		Get a stable URL.
create	insert	parent, stable_url_id, stable_url	validate_only	Create a new stable URL.
delete	delete	name		Delete a stable URL.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.
parent	string	The parent resource. Format: accounts/{account_id}.
stable_url_id	string	Client-provided identifier for the stable URL. Used to construct the resource name as {parent}/stable-urls/{stable_url_id}.
page_size	integer	Maximum number of stable URLs to return per page: - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0 or unset, the page length is set to a server configured value (recommended); - when set to a value less than 0, an invalid parameter error is returned.
page_token	string	Page token received from a previous ListStableUrls call. Provide this to retrieve the subsequent page.
validate_only	boolean	When true, validates the request without creating the stable URL.

SELECT examples

list

List stable URLs for an account.

SELECT
name,
effective_workspace_id,
initial_workspace_id,
stable_workspace_id,
failover_group_name,
url
FROM databricks_account.disasterrecovery.stable_urls
WHERE parent = '{{ parent }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

get

Get a stable URL.

SELECT
name,
effective_workspace_id,
initial_workspace_id,
stable_workspace_id,
failover_group_name,
url
FROM databricks_account.disasterrecovery.stable_urls
WHERE name = '{{ name }}' -- required
;

INSERT examples

create

Create a new stable URL.

INSERT INTO databricks_account.disasterrecovery.stable_urls (
stable_url,
parent,
stable_url_id,
validate_only
)
SELECT 
'{{ stable_url }}' /* required */,
'{{ parent }}',
'{{ stable_url_id }}',
'{{ validate_only }}'
RETURNING
name,
effective_workspace_id,
initial_workspace_id,
stable_workspace_id,
failover_group_name,
url
;

Manifest

# Description fields are for documentation purposes
- name: stable_urls
props:
  - name: parent
    value: "{{ parent }}"
    description: Required parameter for the stable_urls resource.
  - name: stable_url_id
    value: "{{ stable_url_id }}"
    description: Required parameter for the stable_urls resource.
  - name: stable_url
    description: |
      The stable URL to create.
    value:
      initial_workspace_id: "{{ initial_workspace_id }}"
      effective_workspace_id: "{{ effective_workspace_id }}"
      failover_group_name: "{{ failover_group_name }}"
      name: "{{ name }}"
      stable_workspace_id: "{{ stable_workspace_id }}"
      url: "{{ url }}"
  - name: validate_only
    value: {{ validate_only }}
    description: When true, validates the request without creating the stable URL.
    description: When true, validates the request without creating the stable URL.

DELETE examples

delete

Delete a stable URL.

DELETE FROM databricks_account.disasterrecovery.stable_urls
WHERE name = '{{ name }}' --required
;