如何在 Azure API 管理中設定通知和通知範本

適用於：開發人員 | 基本 | 基本 v2 | 標準 | 標準 v2 | 進階 | 進階 v2

Azure API 管理 可讓您設定特定事件的電子郵件通知，並設定用來與 API 管理 實例的系統管理員和開發人員通訊的電子郵件範本。 本文說明如何為可用的事件設定通知，並提供設定這些事件所使用之電子郵件範本的概觀。

先決條件

如果您沒有 API 管理服務執行個體，請完成下列快速入門：建立 Azure API 管理執行個體。

移至您的 API 管理執行個體

1. 在 Azure 入口網站中，搜尋並選取 API 管理 服務：

   

2. 在 [ API 管理服務 ] 頁面上，選取您的 API 管理實例：

   

在 Azure 入口網站中設定通知

1. 從 API 管理 實例的側邊欄功能表中，選取 [部署 + 基礎結構]，然後選擇 [通知] 以檢視可用的通知。

   下列事件清單可設定通知。

   • 訂閱要求 （需要核准）：指定的電子郵件收件者和使用者會收到有關需要核准之產品的訂閱要求的電子郵件通知。
   • 新訂閱：指定的電子郵件收件者和使用者會收到有關新產品訂閱的電子郵件通知。
   • 應用程式資源庫要求：當將新應用程式提交至應用程式資源庫時，下列電子郵件收件者和使用者會收到電子郵件通知。
   • 密件副本: 指定的電子郵件收件人和使用者會收到所有傳送給開發人員的電子郵件之密件副本。
   • 新問題或註解：當在開發人員入口網站上提交新問題或註解時，下列電子郵件收件者和使用者會收到電子郵件通知。
   • 關閉帳戶訊息：當帳戶關閉時，指定的電子郵件收件者和使用者會收到電子郵件通知。
   • 接近訂閱配額限制：當訂閱使用量接近使用量配額時，指定的電子郵件收件者和使用者會收到電子郵件通知。

2. 選取通知，並指定要通知的一或多個電子郵件地址：

   • 若要新增系統管理員電子郵件地址，請選取 [+ 新增管理員]。
   • 若要新增另一個電子郵件地址，請選取 [+ 新增電子郵件]、輸入電子郵件地址，然後選取 [新增]。
   • 視需要繼續新增電子郵件地址。

   

設定通知範本

API 管理提供系統管理電子郵件訊息的通知範本，這些通知會在開發人員存取和使用服務時自動傳送給開發人員。 提供下列通知範本：

• 開發人員離職信
• 開發人員接近配額限制通知
• 開發人員歡迎信件
• 電子郵件變更通知
• 邀請使用者
• 新開發人員帳戶確認
• 已啟用新的訂用帳戶
• 密碼變更確認
• 拒絕訂用帳戶要求
• 收到訂用帳戶要求

每個電子郵件範本都有純文字的主旨行，以及HTML格式的內文定義。 可依需要自訂每一個項目。

附註

範本中的 HTML 內容必須語式正確，並遵循 XML 規格 (英文)。 不允許   字元。

若要在入口網站中檢視及設定通知範本：

1. 在側邊欄功能表中，選取 通知範本。

2. 選取通知範本，並使用編輯器設定範本。

   

   • 此 Parameters 清單包含引數清單，當插入主旨或內文時，會在傳送電子郵件時以指定值取代。
   • 若要插入參數，請將游標移至您要放置參數的地方，然後選取參數名稱。

3. 若要儲存電子郵件範本的變更，請選取 儲存，或選取 捨棄 以取消變更。

設定電子郵件設定

您可以針對從API 管理執行個體傳送的通知修改一般電子郵件設定。 您可以變更系統管理員電子郵件地址、傳送通知的組織名稱，以及原始的電子郵件地址。

重要事項

變更原始電子郵件地址可能會影響收件者接收電子郵件的能力。 請參閱下一節中的考量。

若要修改電子郵件設定：

1. 在側邊欄功能表中，選取 通知範本。

2. 選取 [電子郵件設定]。

3. 在 [一般電子郵件設定 ] 頁面上，輸入下列值：

   • 管理員電子郵件：接收所有系統通知和其他設定通知的電子郵件地址。

   • 組織名稱：用於開發人員入口網站和通知的組織名稱。

   • 原始電子郵件地址：來自 API 管理 實例通知的 From 標頭值。 API 管理會代表此原始地址傳送通知。

     

4. 選取 [儲存]。

變更原始電子郵件地址的考量

當您變更原始電子郵件地址時，來自 APIM 的電子郵件通知收件者可能會受到影響。

• 變更寄件者地址：當您變更原始電子郵件地址（例如，到 no-reply@contoso.com）時， 寄件者 地址標頭將為 noreply@contoso.com apimgmt-noreply@mail.windowsazure.com。 這是因為電子郵件是由 APIM 所傳送，而不是由原始電子郵件地址的電子郵件伺服器所傳送。

• 電子郵件傳送至垃圾郵件資料夾：某些收件者可能不會收到來自 API 管理 的電子郵件通知，或電子郵件可能會傳送至垃圾郵件或垃圾郵件資料夾。 視組織的 SPF 或 DKIM 電子郵件驗證設定而定，可能會發生這種情況：

  • SPF 驗證：變更原始電子郵件地址網域後，電子郵件可能不再通過 SPF 驗證。 為了確保 SPF 驗證和電子郵件傳遞成功，請在電子郵件地址所指定網域的 DNS 資料庫中建立下列 TXT 記錄。 例如，如果電子郵件地址是 noreply@contoso.com，請聯絡contoso.com管理員以新增以下 TXT 記錄：「v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all」

  • DKIM 驗證：若要產生 DKIM 的有效簽章以進行電子郵件驗證，API 管理 需要與原始電子郵件地址網域相關聯的私密金鑰。 不過，目前無法在 API 管理 中上傳此私密金鑰。 因此，為了指派有效的簽章，APIM 會使用與 mail.windowsazure.com 網域相關聯的私密金鑰。

相關內容

• 開發人員入口網站概觀
• 如何建立和使用群組來管理開發人員帳戶