`w.apps`: Apps¶

class databricks.sdk.service.apps.AppsAPI¶

Apps run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on.

create(app: App [, no_compute: Optional[bool]]) → Wait[App]¶

Creates a new app.

Parameters:

app – App
no_compute – bool (optional) If true, the app will not be started after creation.

Returns:

Long-running operation waiter for App. See :method:wait_get_app_active for more details.

create_and_wait(app: App [, no_compute: Optional[bool], timeout: datetime.timedelta = 0:20:00]) → App¶

create_space(space: Space) → CreateSpaceOperation¶

Creates a new app space.

Parameters:: space – Space
Returns:: Operation

create_update(app_name: str, update_mask: str [, app: Optional[App]]) → Wait[AppUpdate]¶

Creates an app update and starts the update process. The update process is asynchronous and the status of the update can be checked with the GetAppUpdate method.

Parameters:

app_name – str
update_mask –
str The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.

A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future.
app – App (optional)

Returns:

Long-running operation waiter for AppUpdate. See :method:wait_get_update_app_succeeded for more details.

create_update_and_wait(app_name: str, update_mask: str [, app: Optional[App], timeout: datetime.timedelta = 0:20:00]) → AppUpdate¶

delete(name: str) → App¶

Deletes an app.

Parameters:: name – str The name of the app.
Returns:: App

delete_app_thumbnail(name: str)¶

Deletes the thumbnail for an app.

Parameters:: name – str The name of the app.

delete_space(name: str) → DeleteSpaceOperation¶

Deletes an app space.

Parameters:: name – str The name of the app space.
Returns:: Operation

deploy(app_name: str, app_deployment: AppDeployment) → Wait[AppDeployment]¶

Creates an app deployment for the app with the supplied name.

Parameters:

app_name – str The name of the app.
app_deployment – AppDeployment The app deployment configuration.

Returns:

Long-running operation waiter for AppDeployment. See :method:wait_get_deployment_app_succeeded for more details.

deploy_and_wait(app_name: str, app_deployment: AppDeployment, timeout: datetime.timedelta = 0:20:00) → AppDeployment¶

get(name: str) → App¶

Retrieves information for the app with the supplied name.

Parameters:: name – str The name of the app.
Returns:: App

get_deployment(app_name: str, deployment_id: str) → AppDeployment¶

Retrieves information for the app deployment with the supplied name and deployment id.

Parameters:

app_name – str The name of the app.
deployment_id – str The unique id of the deployment.

Returns:

AppDeployment

get_permission_levels(app_name: str) → GetAppPermissionLevelsResponse¶

Gets the permission levels that a user can have on an object.

Parameters:: app_name – str The app for which to get or manage permissions.
Returns:: GetAppPermissionLevelsResponse

get_permissions(app_name: str) → AppPermissions¶

Gets the permissions of an app. Apps can inherit permissions from their root object.

Parameters:: app_name – str The app for which to get or manage permissions.
Returns:: AppPermissions

get_space(name: str) → Space¶

Retrieves information for the app space with the supplied name.

Parameters:: name – str The name of the app space.
Returns:: Space

get_space_operation(name: str) → Operation¶

Gets the status of an app space update operation.

Parameters:: name – str The name of the operation resource.
Returns:: Operation

get_update(app_name: str) → AppUpdate¶

Gets the status of an app update.

Parameters:: app_name – str The name of the app.
Returns:: AppUpdate

list([, page_size: Optional[int], page_token: Optional[str], space: Optional[str]]) → Iterator[App]¶

Lists all apps in the workspace.

Parameters:

page_size – int (optional) Upper bound for items returned.
page_token – str (optional) Pagination token to go to the next page of apps. Requests first page if absent.
space – str (optional) Filter apps by app space name. When specified, only apps belonging to this space are returned.

Returns:

Iterator over App

list_deployments(app_name: str [, page_size: Optional[int], page_token: Optional[str]]) → Iterator[AppDeployment]¶

Lists all app deployments for the app with the supplied name.

Parameters:

app_name – str The name of the app.
page_size – int (optional) Upper bound for items returned.
page_token – str (optional) Pagination token to go to the next page of apps. Requests first page if absent.

Returns:

Iterator over AppDeployment

list_spaces([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[Space]¶

Lists all app spaces in the workspace.

Parameters:

page_size – int (optional) Upper bound for items returned.
page_token – str (optional) Pagination token to go to the next page of app spaces. Requests first page if absent.

Returns:

Iterator over Space

set_permissions(app_name: str [, access_control_list: Optional[List[AppAccessControlRequest]]]) → AppPermissions¶

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

Parameters:

app_name – str The app for which to get or manage permissions.
access_control_list – List[AppAccessControlRequest] (optional)

Returns:

AppPermissions

start(name: str) → Wait[App]¶

Start the last active deployment of the app in the workspace.

Parameters:: name – str The name of the app.
Returns:: Long-running operation waiter for App. See :method:wait_get_app_active for more details.

start_and_wait(name: str, timeout: datetime.timedelta = 0:20:00) → App¶

stop(name: str) → Wait[App]¶

Stops the active deployment of the app in the workspace.

Parameters:: name – str The name of the app.
Returns:: Long-running operation waiter for App. See :method:wait_get_app_stopped for more details.

stop_and_wait(name: str, timeout: datetime.timedelta = 0:20:00) → App¶

update(name: str, app: App) → App¶

Updates the app with the supplied name.

Parameters:

name – str The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
app – App

Returns:

App

update_app_thumbnail(name: str [, app_thumbnail: Optional[AppThumbnail]]) → AppThumbnail¶

Updates the thumbnail for an app.

Parameters:

name – str The name of the app.
app_thumbnail – AppThumbnail (optional) The app thumbnail to set.

Returns:

AppThumbnail

update_permissions(app_name: str [, access_control_list: Optional[List[AppAccessControlRequest]]]) → AppPermissions¶

Updates the permissions on an app. Apps can inherit permissions from their root object.

Parameters:

app_name – str The app for which to get or manage permissions.
access_control_list – List[AppAccessControlRequest] (optional)

Returns:

AppPermissions

update_space(name: str, space: Space, update_mask: FieldMask) → UpdateSpaceOperation¶

Updates an app space. The update process is asynchronous and the status of the update can be checked with the GetSpaceOperation method.

Parameters:

name – str The name of the app space. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
space – Space
update_mask –
FieldMask The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.

A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future.

Returns:

Operation

wait_get_app_active(name: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[App], None]]) → App¶

wait_get_app_stopped(name: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[App], None]]) → App¶

wait_get_deployment_app_succeeded(app_name: str, deployment_id: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[AppDeployment], None]]) → AppDeployment¶

wait_get_update_app_succeeded(app_name: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[AppUpdate], None]]) → AppUpdate¶

Navigation

Related Topics

`w.apps`: Apps¶

w.apps: Apps¶

`w.apps`: Apps¶