w.workspace_bindings: Workspace Bindings

class databricks.sdk.service.catalog.WorkspaceBindingsAPI

A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An __OPEN__ securable can be accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a configured list of workspaces. This API allows you to configure (bind) securables to workspaces.

NOTE: The __isolation_mode__ is configured for the securable itself (using its Update method) and the workspace bindings are only consulted when the securable’s __isolation_mode__ is set to __ISOLATED__.

A securable’s workspace bindings can be configured by a metastore admin or the owner of the securable.

The original path (/api/2.1/unity-catalog/workspace-bindings/catalogs/{name}) is deprecated. Please use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which introduces the ability to bind a securable in READ_ONLY mode (catalogs only).

Securable types that support binding: - catalog - storage_credential - external_location

get(name: str) → CurrentWorkspaceBindings

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created = w.catalogs.create(name=f"sdk-{time.time_ns()}")

bindings = w.workspace_bindings.get(name=created.name)

# cleanup
w.catalogs.delete(name=created.name, force=True)

Get catalog workspace bindings.

Gets workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.

Parameters:

name – str The name of the catalog.

Returns:

CurrentWorkspaceBindings

get_bindings(securable_type: GetBindingsSecurableType, securable_name: str [, max_results: Optional[int], page_token: Optional[str]]) → Iterator[WorkspaceBinding]

Get securable workspace bindings.

Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

Parameters:

  • securable_type – GetBindingsSecurableType The type of the securable to bind to a workspace.

  • securable_name – str The name of the securable.

  • max_results – int (optional) Maximum number of workspace bindings to return. - When set to 0, the page length is set to a server configured value (recommended); - 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 a value less than 0, an invalid parameter error is returned; - If not set, all the workspace bindings are returned (not recommended).

  • page_token – str (optional) Opaque pagination token to go to next page based on previous query.

Returns:

Iterator over WorkspaceBinding

update(name: str [, assign_workspaces: Optional[List[int]], unassign_workspaces: Optional[List[int]]]) → CurrentWorkspaceBindings

Usage:

import os
import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

this_workspace_id = os.environ["THIS_WORKSPACE_ID"]

created = w.catalogs.create(name=f"sdk-{time.time_ns()}")

_ = w.workspace_bindings.update(name=created.name, assign_workspaces=[this_workspace_id])

# cleanup
w.catalogs.delete(name=created.name, force=True)

Update catalog workspace bindings.

Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.

Parameters:

  • name – str The name of the catalog.

  • assign_workspaces – List[int] (optional) A list of workspace IDs.

  • unassign_workspaces – List[int] (optional) A list of workspace IDs.

Returns:

CurrentWorkspaceBindings

update_bindings(securable_type: UpdateBindingsSecurableType, securable_name: str [, add: Optional[List[WorkspaceBinding]], remove: Optional[List[WorkspaceBinding]]]) → WorkspaceBindingsResponse

Update securable workspace bindings.

Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

Parameters:
Returns:

WorkspaceBindingsResponse