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]

Create an 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
delete(name: str) → App

Delete an app.

Deletes an app.

Parameters:

name – str The name of the app.

Returns:

App

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

Create an app deployment.

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

Parameters:

  • app_name – str The name of the app.

  • app_deployment – AppDeployment

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

Get an 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

Get an app deployment.

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

Get app permission levels.

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

Get app permissions.

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

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

List apps.

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.

Returns:

Iterator over App

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

List app deployments.

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

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

Set app permissions.

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 an 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]

Stop an 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

Update an 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_permissions(app_name: str [, access_control_list: Optional[List[AppAccessControlRequest]]]) → AppPermissions

Update app permissions.

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

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