-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added documentation and improved integration test
- Loading branch information
1 parent
36f845e
commit e7b7381
Showing
3 changed files
with
122 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
--- | ||
subcategory: "Workspace" | ||
--- | ||
# databricks_notification_destination Resource | ||
|
||
This resource allows you to manage [Notification Destinations](https://docs.databricks.com/api/workspace/notificationdestinations). Notification destinations are used to send notifications for query alerts and jobs to destinations outside of Databricks. Only workspace admins can create, update, and delete notification destinations. | ||
|
||
## Example Usage | ||
|
||
`Email` notification destination: | ||
|
||
```hcl | ||
resource "databricks_notification_destination" "ndresource" { | ||
display_name = "Notification Destination" | ||
config { | ||
email { | ||
addresses = ["abc@gmail.com"] | ||
} | ||
} | ||
} | ||
``` | ||
`Slack` notification destination: | ||
|
||
```hcl | ||
resource "databricks_notification_destination" "ndresource" { | ||
display_name = "Notification Destination" | ||
config { | ||
slack { | ||
url = "https://hooks.slack.com/services/..." | ||
} | ||
} | ||
} | ||
``` | ||
`PagerDuty` notification destination: | ||
|
||
```hcl | ||
resource "databricks_notification_destination" "ndresource" { | ||
display_name = "Notification Destination" | ||
config { | ||
pagerduty { | ||
integration_key = "xxxxxx" | ||
} | ||
} | ||
} | ||
``` | ||
`Microsoft Teams` notification destination: | ||
|
||
```hcl | ||
resource "databricks_notification_destination" "ndresource" { | ||
display_name = "Notification Destination" | ||
config { | ||
microsoft_teams { | ||
url = "https://outlook.office.com/webhook/..." | ||
} | ||
} | ||
} | ||
``` | ||
`Generic Webhook` notification destination: | ||
|
||
```hcl | ||
resource "databricks_notification_destination" "ndresource" { | ||
display_name = "Notification Destination" | ||
config { | ||
generic_webhook { | ||
url = "https://example.com/webhook" | ||
username = "username" // Optional | ||
password = "password" // Optional | ||
} | ||
} | ||
} | ||
``` | ||
|
||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `display_name` - (Required) The display name of the Notification Destination. | ||
* `config` - (Required) The configuration of the Notification Destination. It must be one of the following: | ||
* `email` - The email configuration of the Notification Destination. It must contain the following: | ||
* `addresses` - (Required) The list of email addresses to send notifications to. | ||
* `slack` - The Slack configuration of the Notification Destination. It must contain the following: | ||
* `url` - (Required) The Slack webhook URL. | ||
* `pagerduty` - The PagerDuty configuration of the Notification Destination. It must contain the following: | ||
* `integration_key` - (Required) The PagerDuty integration key. | ||
* `microsoft_teams` - The Microsoft Teams configuration of the Notification Destination. It must contain the following: | ||
* `url` - (Required) The Microsoft Teams webhook URL. | ||
* `generic_webhook` - The Generic Webhook configuration of the Notification Destination. It must contain the following: | ||
* `url` - (Required) The Generic Webhook URL. | ||
* `username` - (Optional) The username for basic authentication. | ||
* `password` - (Optional) The password for basic authentication. | ||
|
||
|
||
## Attribute Reference | ||
|
||
In addition to all arguments above, the following attributes are exported: | ||
|
||
* `id` - The unique ID of the Notification Destination. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,44 @@ | ||
package acceptance | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"github.com/databricks/databricks-sdk-go/service/settings" | ||
"github.com/databricks/terraform-provider-databricks/common" | ||
"github.com/databricks/terraform-provider-databricks/qa" | ||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestAccNDEmail(t *testing.T) { | ||
display_name := "Email Notification Destination - " + qa.RandomName() | ||
workspaceLevel(t, step{ | ||
Template: ` | ||
resource "databricks_notification_destination" "this" { | ||
display_name = "Email Notification Destination" | ||
display_name = "` + display_name + `" | ||
config { | ||
email { | ||
addresses = ["` + qa.RandomEmail() + `"] | ||
} | ||
} | ||
} | ||
`, | ||
Check: resourceCheck("databricks_notification_destination.this", func(ctx context.Context, client *common.DatabricksClient, id string) error { | ||
w, err := client.WorkspaceClient() | ||
if err != nil { | ||
return err | ||
} | ||
ndResource, err := w.NotificationDestinations.Get(ctx, settings.GetNotificationDestinationRequest{ | ||
Id: id, | ||
}) | ||
if err != nil { | ||
return err | ||
} | ||
assert.Equal(t, settings.DestinationType("EMAIL"), ndResource.DestinationType) | ||
assert.Equal(t, display_name, ndResource.DisplayName) | ||
require.NoError(t, err) | ||
return nil | ||
}), | ||
}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters