notification_destinations

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

Overview

Name	notification_destinations
Type	Resource
Id	databricks_workspace.workspace.notification_destinations

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully.

Name	Datatype	Description
id	string
display_name	string
destination_type	string

list

Request completed successfully.

Name	Datatype	Description
id	string
display_name	string
destination_type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets a notification destination.
list	select	deployment_name		Lists notification destinations.
create	insert	deployment_name		Creates a notification destination. Requires workspace admin permissions.
update	update	deployment_name		Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body.
delete	delete	deployment_name		Deletes a notification destination. Requires workspace admin permissions.

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

get

Gets a notification destination.

SELECT
id,
display_name,
destination_type
FROM databricks_workspace.workspace.notification_destinations
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Lists notification destinations.

SELECT
id,
display_name,
destination_type
FROM databricks_workspace.workspace.notification_destinations
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a notification destination. Requires workspace admin permissions.

INSERT INTO databricks_workspace.workspace.notification_destinations (
data__display_name,
data__config,
deployment_name
)
SELECT 
'{{ display_name }}',
'{{ config }}',
'{{ deployment_name }}'
RETURNING
id,
display_name,
config,
destination_type
;

Manifest

# Description fields are for documentation purposes
- name: notification_destinations
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the notification_destinations resource.
    - name: display_name
      value: string
    - name: config
      value: object

UPDATE examples

update

Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body.

UPDATE databricks_workspace.workspace.notification_destinations
SET 
data__display_name = '{{ display_name }}',
data__config = '{{ config }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
id,
display_name,
config,
destination_type;

DELETE examples

delete

Deletes a notification destination. Requires workspace admin permissions.

DELETE FROM databricks_workspace.workspace.notification_destinations
WHERE deployment_name = '{{ deployment_name }}' --required;