다음을 통해 공유

如何在 Azure API 管理中配置通知和通知模板

Azure API 管理允许为特定事件配置电子邮件通知，并配置用于与 API 管理实例的管理员和开发人员通信的电子邮件模板。 本文演示如何为可用事件配置通知，并提供配置用于这些事件的电子邮件模板的概述。

先决条件

如果没有 API 管理服务实例，请完成以下快速入门：创建 Azure API 管理实例。

转到你的 API 管理实例

  1. 在 Azure 门户中搜索并选择“API 管理服务” 。

    选择“API 管理服务”

  2. 在“API 管理”服务页上，选择你的 API 管理实例。

    选择你的 API 管理实例

在 Azure 门户中配置通知

  1. 在 API 管理实例的边栏菜单中，选择 “部署 + 基础结构”，然后选择“ 通知 ”以查看可用的通知。

    为通知可以配置以下事件的列表。

    • 订阅请求（需要审批）：指定的电子邮件收件人和用户收到有关需要审批的产品订阅请求的电子邮件通知。
    • 新订阅：指定的电子邮件收件人和用户会收到有关新产品订阅的电子邮件通知。
    • 应用程序库请求：将新应用程序提交到应用程序库时，以下电子邮件收件人和用户会收到电子邮件通知。
    • 密件抄送：指定的电子邮件收件人和用户会收到发送给开发人员的所有电子邮件的电子邮件盲件抄送副本。
    • 新问题或评论：在开发人员门户中提交新问题或批注时，以下电子邮件收件人和用户会收到电子邮件通知。
    • 关闭帐户消息：关闭帐户时指定的电子邮件收件人和用户会收到电子邮件通知。
    • 接近订阅配额限制：当订阅使用情况接近使用配额时，指定的电子邮件收件人和用户会收到电子邮件通知。

  2. 选择一种通知，并指定要通知的一个或多个电子邮件地址：

    • 若要添加管理员电子邮件地址，请选择“+ 添加管理员”。
    • 若要添加其他电子邮件地址，请选择“+ 添加电子邮件”，输入电子邮件地址，然后选择“添加”。
    • 根据需要继续添加电子邮件地址。

    显示如何在门户中添加通知收件人的屏幕截图。

配置通知模板

API 管理提供管理电子邮件通知模板，当开发人员访问和使用服务时，系统会自动向他们发送这些电子邮件。 提供以下通知模板：

  • 开发人员告别信
  • 开发人员配额限制接近通知
  • 开发人员欢迎信
  • 电子邮件更改通知
  • 邀请用户
  • 新的开发人员帐户确认
  • 新订阅已激活
  • 密码更改确认
  • 已拒绝订阅请求
  • 接收的订阅请求

每个电子邮件模板都有一个纯文本的主题行，以及 HTML 格式的正文定义。 可按需自定义每一项。

注意

模板中的 HTML 内容必须格式正确并符合 XML 规范。 不允许使用   字符。

若要在门户中查看和配置通知模板，请执行以下操作：

  1. 在边栏菜单中，选择 “通知模板”。 门户中通知模板的屏幕截图。

  2. 选择一个通知模板，然后使用编辑器配置该模板。

    门户中通知模板编辑器的屏幕截图。

    • “参数”列表包含一个参数列表，当插入主题或正文时，在发送电子邮件时将被指定值替换。
    • 若要插入某个参数，请将光标放在要插入该参数的位置，然后选择该参数的名称。

  3. 若要保存对电子邮件模板的更改，请选择“ 保存”，或选择“ 放弃 ”以取消更改。

配置电子邮件设置

可以修改从 API 管理实例发送的通知的常规电子邮件设置。 可以更改管理员电子邮件地址、发送通知的组织名称以及来源电子邮件地址。

重要

更改原始电子邮件地址可能会影响收件人接收电子邮件的能力。 请参阅以下部分中的 注意事项。

若要修改电子邮件设置，请执行以下操作：

  1. 在边栏菜单中，选择 “通知模板”。

  2. 选择“电子邮件设置”。

  3. 在 “常规电子邮件设置 ”页上，输入以下项的值：

    • 管理员电子邮件：用于接收所有系统通知和其他已配置的通知的电子邮件地址。

    • 组织名称：组织名称，供开发人员门户和通知使用。

    • 发起通知的电子邮件地址：API 管理实例中通知的 From 标头的值。 API 管理将代表此来源地址发送通知。

      屏幕截图显示门户中的 API 管理电子邮件设置

  4. 选择“保存” 。

更改原始电子邮件地址的注意事项

更改原始电子邮件地址时，来自 API 管理的电子邮件通知的收件人可能会受到影响。

  • 更改发件人地址：更改原始电子邮件地址（例如，更改为 no-reply@contoso.com）， 发件人 地址标头将为 noreply@contoso.com apimgmt-noreply@mail.windowsazure.cn。 这是因为电子邮件由 API 管理（而非原始电子邮件地址的电子邮件服务器）发送。

  • 发送到垃圾邮件文件夹的电子邮件：某些收件人可能不会收到来自 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 管理中上传此私钥。 因此，为了分配有效签名，API 管理使用与 mail.windowsazure.cn 域关联的私钥。

相关内容