管理通知目的地

本頁說明如何建立和設定工作區的通知目的地。

系統通知是一種訊息,能夠在工作流程出現執行事件 (啟動、成功和失敗) 時通知您。 預設情況下,通知會寄送至使用者電子郵件地址,但管理員可使用 webhooks 或 Databricks Genie 應用程式(適用於 Slack 與 Microsoft Teams(公開預覽版)設定替代通知目的地。 這讓你能建立與 Azure Databricks 的事件驅動整合。

系統管理員也可以設定通知目的地,以接收來自工作區使用者的存取要求,例如 Unity 目錄物件的許可權要求。

你必須是 Azure Databricks workspace 管理員才能管理通知目的地。 設定目的地之後,所有使用者皆可使用該目的地。

帳戶層級事件,例如預算警示,會使用帳戶層級通知目的地,這些目的地由帳戶管理員在帳戶主控台中設定。 請參閱 管理帳戶層級通知目的地。

網路需求

對於基於 webhook 的目的地,接收端點必須符合以下條件:

  • Azure Databricks 強制使用 HTTPS 以確保安全。 通知目的地必須使用由受信任憑證授權單位簽署的安全通訊端層 (SSL) 憑證。
  • 通知目的地必須將工作區控制平面與資料平面的出站IP位址加入其允許清單:
    • 關於控制平面網頁應用程式的 IP 位址,請參見IP 位址與Azure Databricks服務與資產網域。

    • 關於資料平面的外撥 IP 位址,請參考 ip-ranges.json Azure Databricks 發布的檔案。 在檔案中搜尋你工作區的資料平面區域,並允許列出網路堆疊中對應的出站 IP 位址。

      Azure Databricks 可能每 30 天更新一次外撥 IP。 更新後的 IP 會在發佈後 60 天內生效,因此請定期檢視檔案並在啟用窗口關閉前更新你的允許清單。

      要追蹤版本間的變更,請儲存 JSON 檔案的後續版本並比較數 timestampSeconds 值。 篩選項目如下:

      • 該欄位為serviceDatabricks
      • 該欄位為platformazure
      • 該欄位為typeoutbound

建立新的通知目的地

設定新的通知目的地

  1. 按兩下工作區頂端列中的使用者名稱,然後從下拉式清單中選取 [設定]。
  2. 在 [工作區管理員] 區段中,按下 [通知] 索引標籤 。
  3. 按下 [管理] 按鈕。
  4. 按下 [+新增目的地]。
  5. 選取目的地類型。 目前支援下列目的地:
  6. 根據類型設定目的地。
  7. 按一下 [建立]。

Webhook 酬載

發送通知的服務定義了 webhook 酬載。 關於工作所傳送的有效載荷,請參見 HTTP webhook 有效載荷。 關於 Databricks SQL 警報在狀態變更後所發送的有效載荷,請參見 SQL alert webhook 有效載荷。

為每個目的地使用不同的憑證

目的地的設定會安全地加密儲存在你的 Azure Databricks 工作空間中。 對於需要提供 URL 或憑證的目的地,Azure Databricks 建議為每個設定的目的地使用不同的憑證。 這能限制第三方端點被入侵時的影響。 包括:

  • Slack Webhook:傳送通知的 URL。
  • 使用 Webhook 的 Microsoft Teams:傳送通知的 URL
  • PagerDuty:用於將通知唯一路由至 PagerDuty 服務的整合金鑰。
  • Webhook:用於 HTTP Basic 認證的使用者名稱與密碼,或用於 OAuth 認證(Beta)的用戶端 ID 與用戶端秘密。
  • Asana:個人存取權證。

為每個設定的目的地使用不同的秘密,可以讓你個別撤銷對個別通知目的地的存取,而不會影響 Azure Databricks 工作空間中其他目的地的運作。

Webhook 目的地的 OAuth 驗證

Important

這項功能位於 測試版 (Beta) 中。 要使用此功能,工作區管理員必須從預覽頁面開啟 Destination Type Generic Webhook Oauth。 請參閱管理工作區層級預覽。

使用 OAuth 2.0 用戶端憑證向需要存取權杖的端點發送通知。 Azure Databricks 會從你的身份提供者取得該憑證,並用它來驗證通知請求。

您的身份提供者必須支持客戶憑證授權。 接收端點與令牌端點都必須使用 HTTPS。

若要建立 OAuth Webhook 目的地:

  1. 在 設定>通知中,點選 管理,然後 +新增目的地。
  2. 輸入名稱並選擇 Webhook 作為 類型。
  3. 驗證 模式請選擇 OAuth。
  4. 輸入以下數值:
    • URL:接收通知的端點。
    • 用戶端 ID 與 用戶端密碼:由您的身分識別提供者所核發的憑證。
    • 權杖端點 URL:Azure Databricks 從中取得存取權杖的端點。
    • 範圍 與受眾:如您的身份提供者需要, 請輸入這些選用值。 用逗號分隔多個瞄準鏡。
  5. 按一下 [建立]。

用戶端 ID、用戶端秘密和權杖端點 URL 必須一起提供。 OAuth 無法與 HTTP Basic 認證結合使用。

若要驗證設定,請開啟目的地的三點選單,然後按一下 測試。 Azure Databricks 會取得存取權杖並發送範例通知。 若測試失敗,檢查憑證、範圍、受眾、接收者權限及兩個端點的網路存取。

OAuth webhook 目的地的合規可用性

對於啟用 合規安全設定檔 的工作空間,區域資格取決於所選合規標準。 如需區域名稱,請參閱 支援的區域。

  • 如果選取了一個或多個標準,請從 合規安全性設定檔概覽中開啟每個標準的頁面。 在其區域支援表中尋找「Destination Type Generic Webhook Oauth」。 您的工作區區域必須列在每個所選標準中該功能的清單內。
  • 若未選擇任何合規標準,則不適用額外的特定標準區域限制。 請檢查工作區 預覽頁面 中的 目的地類型:通用 Webhook OAUTH。

AWS EventBridge 目的地

Important

這項功能位於 測試版 (Beta) 中。 要使用此功能,工作區管理員必須在預覽頁面啟用目的地類型 AWS Eventbridge。 請參閱管理工作區層級預覽。

託管於任何支援雲端的工作空間,都可以將通知傳送至您 AWS 帳戶中的 Amazon EventBridge 事件匯流排。 EventBridge 規則會將匹配的通知路由到目標,例如 AWS Lambda 函數。 當您將通知資料傳送至 EventBridge 時,通知資料會離開 Azure Databricks。

EventBridge 需求

EventBridge 設定需要工作區管理員存取權,以及在您的 AWS 帳戶中建立或設定以下資源的權限:

  • 接收通知的區域內的 EventBridge 事件匯流排。
  • 與事件匯流排相同的 AWS 帳戶中的 AWS 身份與存取管理(IAM)角色。
  • 一個 EventBridge 規則以及一個會消耗通知的目標。

你也需要在 AWS CLI 中設定具備該 AWS 帳戶中 iam:GetRole 權限的憑證。

請聯絡您的 Azure Databricks 帳戶團隊,取得建立 IAM 角色的 CloudFormation 範本。

事件匯流排與角色必須使用商用 AWS 分區(arn:aws:)。 事件匯流排中的 Amazon 資源名稱(ARN)區域決定 Azure Databricks 將事件傳送到哪裡。

建立 EventBridge 目的地

  1. 建立事件匯流排,或選取現有匯流排並複製其 ARN。

  2. 在 Azure Databricks 中,前往設定>通知,點選管理,然後 +新增目的地。

  3. 輸入名稱並在 類型 中選擇 AWS EventBridge。

  4. 複製表單中顯示的 Databricks 主體 ARN 與 外部 ID 。

  5. 在擁有事件匯流排的 AWS 帳戶中,開啟 AWS CloudFormation,並從您的帳戶團隊提供的範本建立堆疊。 輸入以下範本參數:

    • DatabricksPrincipalArn:從目標表單複製的主體 ARN。
    • ExternalId:從目標表單複製的外部 ID。
    • EventBusArn:精確的事件匯流排 ARN。 請勿使用萬用字元。

    保持範本的信任與權限政策不變。 確認堆疊會建立 IAM 資源,然後建立堆疊。 此角色僅授予指定匯流排上的 events:PutEvents。

  6. 從堆疊輸出複製 RoleArn 。 執行以下指令,以該 ARN 的最後一個組件取代 <role-name> ,並將輸出傳送給您的帳戶團隊以確認信任原則與外部 ID:

    aws iam get-role --role-name <role-name> --output json
    
  7. 當您的帳戶團隊確認設定後,返回目的地表單並輸入 事件匯流排 ARN 與 角色 ARN。 按一下 [建立]。

目的地會顯示在通知目的地清單中。

點擊目標名稱以編輯其設定,或從三點選單中選擇「刪除」以移除它。 在 Azure Databricks 中刪除目的地並不會刪除您 AWS 帳戶中的 CloudFormation 堆疊、IAM 角色或事件匯流排。 如果您不再需要這些資源,請在 AWS 中分別刪除它們。

外部 ID 是您的 Azure Databricks 帳戶 ID,由該帳戶中的工作區共用。 這不是秘密。 任何在同一 Azure Databricks 帳戶內,且熟悉角色與匯流排 ARN 的工作區管理員,都可以建立一個傳送至此匯流排的目的地。 EventBridge 規則篩選器控制哪些事件會到達目標。 他們不限制哪些工作區可以傳送到匯流排。

Azure Databricks 使用 AWS 安全權杖服務(STS)取得此角色的臨時憑證。 你不需要向 Azure Databricks 提供 AWS 存取金鑰。

將 EventBridge 通知傳送至目標

每個 EventBridge 事件都將source設為detail-type,以detail識別通知類型,並由databricks.notifications包含通知載荷。 此 detail.workspace.id 欄位用來在所有支援的通知類型中識別傳送工作區。

  1. 在您設定的事件匯流排上建立 EventBridge 規則。

  2. 設定事件模式以符合您想要接收的通知。 例如,此模式會匹配 JOB_RUN_ERROR_V2 來自某個工作區的通知。 請以您的工作區 ID 取代 <workspace-id>:

    {
      "source": ["databricks.notifications"],
      "detail-type": ["JOB_RUN_ERROR_V2"],
      "detail": {
        "workspace": {
          "id": ["<workspace-id>"]
        }
      }
    }
    

    若要路由該工作區的所有通知類型,請從該模式中省略 detail-type。

  3. 選取規則的目標,設定其所需權限,並啟用該規則。

EventBridge 使用此規則將匹配事件導向目標。 投遞可能會產生重複通知。 有效載荷會依通知類型而異,且目的地不會提供共用的去重金鑰。 對於 JOB_RUN_ERROR_V2,目標端可以使用 detail.workspace.id、detail.run.run_id、detail.run.attempt 及 detail-type 共同識別重複通知。

Slack 目標

若要設定以 webhook 為基礎的 Slack 目的地,請依照 Slack 的傳入 Webhook 中的說明操作。 將產生的 URL 貼到你的 Azure Databricks 通知目的地。 若要改用 Databricks Genie 應用程式,請參閱 Slack 與 Microsoft Teams Genie 應用程式目的地。

Slack 與 Microsoft Teams Genie 應用程式目的端

Important

這項功能目前處於 公開預覽版。 要使用此功能,工作區管理員必須從預覽頁面開啟 Destination Type Databricks App Slack 或 Destination Type Databricks App Teams。 請參閱管理工作區層級預覽。

使用 Databricks Genie 應用程式,將你的 Slack 工作空間或 Microsoft Teams 租戶連接到 Azure Databricks 工作區。 然後選擇一個可用的頻道作為通知目的地。

你可以將 Genie 應用程式目的地搭配下列功能使用:

建立 Genie 應用程式目的端

在建立 Genie 應用程式目的地前,您必須安裝 Slack 或 Microsoft Teams 的 Databricks Genie 應用程式,並將其連接到您的 Azure Databricks 工作空間,並將其加入接收通知的頻道。 關於應用程式安裝與連線步驟的詳細資訊,請參閱 Slack 或 Microsoft Teams。

若要建立 Genie 應用程式目的地:

  1. 在 設定>通知中,點選 管理,然後 +新增目的地。

  2. 在輸入類型中,選擇 Slack 或 Microsoft Teams,然後選擇使用 Databricks 應用程式。

  3. 輸入目的地名稱。

  4. 選擇工作區或租戶及通道:

    • 對於 Slack,選擇 Slack 工作區 和 頻道。
    • 在 Microsoft Teams 中,選取 租用戶 和 頻道。 租戶選擇器會依據租戶 ID 的最後六個字元來識別每位租戶。

    如果沒有連接 Slack 工作區或 Microsoft Teams 租戶,請分別點擊「連接 Slack 工作區」或「連接 Teams 租戶」,完成 Genie 應用程式的設定。 回到目的地表單,然後按一下 重新整理。 如果你剛把 Genie 應用程式加入頻道,點擊 「重新載入頻道 」以更新頻道列表。

  5. 按一下 [建立]。

Asana 目的端

Important

這項功能位於 測試版 (Beta) 中。 要使用此功能,工作區管理員必須在預覽頁面啟用Destination Type Asana。 請參閱管理工作區層級預覽。

使用 Asana 目的地可在 Project 中建立任務,或在發生通知時觸發現有的 Asana 規則。

發送至 Asana 的通知會離開 Azure Databricks,並依據您在 Asana 中的存取與保留設定進行處理與儲存。 選擇具有適當存取控制的接收資源。

準備 Asana

請使用專屬 Asana 使用者,且存取權限僅限於收到通知的專案與資源。 在 Asana 開發者主控台中為該使用者建立個人存取權杖(PAT)。 PAT 具有長期有效的特性,並繼承使用者的 Asana 存取權限。

為您所選工作流程準備資源:

  • 任務建立:一個 Asana Project 及其數值 Project ID。 每則通知會在該 Project 中建立一個任務,任務名稱與備註皆源自該通知。
  • 規則觸發器:現有的 Asana 規則,包含 一個進站的網頁請求觸發器、其數值規則觸發器 ID,以及該規則要執行的既有任務。 Asana 即使規則的動作沒有使用該任務,也仍需要該任務。

規則會在 action_data 中收到 name 和 notes,以供其動作使用。 某些通知類型還包括 dedup_key。 重試可能會再次觸發該規則,因此請設計其動作以處理重複通知。

請使用數字 ID,而非完整 URL。 對於包含 /rule_triggers/<id>/run 的規則觸發 URL,僅複製數字的 <id> 值。 錨點任務 ID 用來識別現有任務。 PAT 使用者必須具有所選資源的存取權限。

對於 Project URL,例如 https://app.asana.com/1/<workspace-id>/project/<project-id>/list,複製 <project-id>。 對於任務 URL,例如 https://app.asana.com/1/<workspace-id>/project/<project-id>/task/<task-id>,複製 <task-id>。 舊 /0/ 版 URL 使用相同的專案與任務 ID。

建立 Asana 目的地

  1. 在 設定>通知中,點選 管理,然後 +新增目的地。
  2. 輸入名稱並選擇 Asana 作為 類型。
  3. 輸入 個人存取權杖。
  4. 在工作流程中,選擇下列其中一項:
    • 建立任務:輸入數字 Project ID。
    • 規則觸發器:輸入數值 規則觸發 ID 與 錨點任務 ID。
  5. 按一下 [建立]。

當您變更工作流程、專案 ID、規則觸發 ID 或錨點任務 ID 時,即使代幣未變更,也請在儲存前重新輸入 PAT。 僅更改目的地名稱不需要重新輸入令牌。

PagerDuty 目的地

要設定 PagerDuty 目的地:

  1. 在 PagerDuty 中,為你的服務新增一個整合,並選擇 Events API V2 整合類型。
  2. 複製 PagerDuty 為整合產生的整合金鑰。
  3. 在 Azure Databricks 中,將整合金鑰貼到 PagerDuty 通知目的地。

ServiceNow 目標

Important

這項功能位於 測試版 (Beta) 中。 要使用此功能,工作區管理員必須在預覽頁面啟用目的地類型 ServiceNow。 請參閱管理工作區層級預覽。

使用 Table API 與 OAuth 2.0 用戶端認證向 ServiceNow 資料表發送通知。

ServiceNow 需求

在建立目的地之前,請請您的 ServiceNow 管理員準備以下事項:

  • 專屬整合使用者,擁有在您的資料表中建立紀錄的權限。 將使用者的角色與資料表存取限制為整合所需的權限。
  • 支援用戶端憑證授與的 OAuth 應用程式,具有用戶端 ID、用戶端密鑰及 HTTPS 權杖端點。 請依照下列方式設定應用程式:
    • 將 OAuth 應用程式使用者 設定為專屬整合使用者。 如果欄位被隱藏,請將其新增到表單版面配置中。
    • 允許在未明確要求 OAuth 範圍的情況下呼叫 Table API。 Azure Databricks 不會請求權限範圍。
  • 可透過 HTTPS Table API URL 存取的資料表,例如 https://<instance>.service-now.com/api/now/table/<table_name>。
  • 與下表中名稱相符的資料表欄位。 請使用與資料表範圍對應的 應用程式 或 全域 名稱。 payload 欄位必須以字串容納通知的 JSON 內容。
應用程式範圍欄位 全域範圍欄 Content
databricks_event_type u_databricks_event_type 通知事件類型。
databricks_event_id u_databricks_event_id 事件識別碼。 某些活動的此欄位可能為空白。
databricks_description u_databricks_description 事件描述。
databricks_timestamp u_databricks_timestamp 事件時間戳記。 某些事件的此欄位可能為空白。
databricks_payload u_databricks_payload 事件特定 JSON 序列化為字串。

URL 與 Token 端點 URL 值不得包含憑證或敏感查詢參數。 通知資料會從 Azure Databricks 傳送到您的 ServiceNow 實例,而 ServiceNow 可能位於您工作區的區域之外。 在 ServiceNow 中設定存取與保留,以符合您組織的需求。

建立 ServiceNow 目的地

  1. 在 設定>通知中,點選 管理,然後 +新增目的地。
  2. 輸入名稱,並在類型中選擇 ServiceNow。
  3. 輸入以下數值:
    • URL:您的資料表的 ServiceNow 資料表 API 端點。
    • 用戶端 ID 與 用戶端密鑰:由您的 ServiceNow OAuth 應用程式核發的憑證。
    • 令牌端點 URL:您的 ServiceNow OAuth 應用程式的 HTTPS 權杖端點,例如 https://<instance>.service-now.com/oauth_token.do。
    • 資料表範圍:選擇 應用程式 或 全域 ,以匹配資料表中的欄位名稱。
  4. 按一下 [建立]。

建立目的地後,請透過一般工作流程發送通知,並確認 ServiceNow 資料表中會出現新的紀錄。

若要編輯目的地或更換其認證,請點選目的地名稱,更新欄位,然後點選 儲存。 變更 URL 或 Token 端點 URL 時,請重新輸入用戶端密鑰。 若要刪除目的地,打開其三點選單,點選 「刪除」,並確認刪除。

將 Webhook 新增至作業

設定目的地之後,您可以在作業的 作業通知 設定中存取它們。 如需詳細資訊,請參閱 在作業上新增通知。

每個作業可以針對每種類型的事件支援最多三個系統目的地。 設定作業通知時,必須手動輸入電子郵件位址。

限制

通知目的地目前存在下列限制:

  • 電子郵件通知目的地的收件者地址長度有 1,300 個字元的限制。
  • 對於自訂通知實體,非電子郵件目的地如 Slack 和 Microsoft Teams 不支援 HTML 格式。 某些通知目的地支援 Markdown。
  • 針對作業,電子郵件目的地必須在作業的設定中手動設定。