You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
API Management provides the ability to configure email notifications for specific events, and to configure the email templates that are used to communicate with the administrators and developers of an API Management instance. This article shows how to configure notifications for the available events, and provides an overview of configuring the email templates used for these events.
21
+
Azure API Management lets you configure email notifications for specific events, and configure the email templates that are used to communicate with the administrators and developers of an API Management instance. This article shows how to configure notifications for the available events, and provides an overview of configuring the email templates used for these events.
22
22
23
23
## Prerequisites
24
24
25
25
If you don't have an API Management service instance, complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md).
## <aname="publisher-notifications"> </a>Configure notifications in the portal
29
+
## <aname="publisher-notifications"> </a>Configure notifications in the Azure portal
30
30
31
-
1.In the left navigation of your API Management instance, select **Notifications** to view the available notifications.
31
+
1.From the sidebar menu of your API Management instance, select**Deployment + infrastructure**, then choose**Notifications** to view the available notifications.
32
32
33
33
The following list of events can be configured for notifications.
34
34
35
-
-**Subscription requests (requiring approval)** - The specified email recipients and users will receive email notifications about subscription requests for products requiring approval.
36
-
-**New subscriptions** - The specified email recipients and users will receive email notifications about new product subscriptions.
37
-
-**BCC** - The specified email recipients and users will receive email blind carbon copies of all emails sent to developers.
38
-
-**Close account message** - The specified email recipients and users will receive email notifications when an account is closed.
39
-
-**Approaching subscription quota limit** - The specified email recipients and users will receive email notifications when subscription usage gets close to usage quota.
35
+
-**Subscription requests (requiring approval)**: The specified email recipients and users receive email notifications about subscription requests for products requiring approval.
36
+
-**New subscriptions**: The specified email recipients and users receive email notifications about new product subscriptions.
37
+
-**Application gallery requests**: The following email recipients and users receive email notifications when new applications are submitted to the application gallery.
38
+
-**BCC**: The specified email recipients and users receive email blind carbon copies of all emails sent to developers.
39
+
-**New issue or comment**: The following email recipients and users receive email notifications when a new issue or comment is submitted on the developer portal.
40
+
-**Close account message**: The specified email recipients and users receive email notifications when an account is closed.
41
+
-**Approaching subscription quota limit**: The specified email recipients and users receive email notifications when subscription usage gets close to usage quota.
40
42
41
43
1. Select a notification, and specify one or more email addresses to be notified:
42
44
* To add the administrator email address, select **+ Add admin**.
43
45
* To add another email address, select **+ Add email**, enter an email address, and select **Add**.
44
46
* Continue adding email addresses as needed.
45
47
46
-
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-addresses.png" alt-text="Screenshot showing how to add notification recipients in the portal":::
48
+
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-addresses.png" alt-text="Screenshot showing how to add notification recipients in the portal.":::
API Management provides notification templates for the administrative email messages that are sent automatically to developers when they access and use the service. The following notification templates are provided:
Each email template has a subject in plain text, and a body definition in HTML format. Each item can be customized as desired.
54
+
- Developer farewell letter
55
+
- Developer quota limit approaching notification
56
+
- Developer welcome letter
57
+
- Email change notification
58
+
- Invite user
59
+
- New developer account confirmation
60
+
- New subscription activated
61
+
- Password change confirmation
62
+
- Subscription request declined
63
+
- Subscription request received
64
+
65
+
Each email template has a subject line in plain text, and a body definition in HTML format. Each item can be customized as desired.
67
66
68
67
> [!NOTE]
69
68
> HTML content in a template must be well-formed and adhere to the [XML specification](https://www.w3.org/XML/). The ` ` character isn't allowed.
70
69
71
70
To view and configure a notification template in the portal:
72
71
73
-
1. In the left menu, select **Notification templates**.
74
-
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-templates.png" alt-text="Screenshot of notification templates in the portal":::
72
+
1. In the sidebar menu, select **Notification templates**.
73
+
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-templates.png" alt-text="Screenshot of notification templates in the portal.":::
75
74
76
75
1. Select a notification template, and configure the template using the editor.
77
76
78
-
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-template.png" alt-text="Screenshot of notification template editor in the portal":::
77
+
:::image type="content" source="media/api-management-howto-configure-notifications/api-management-email-template.png" alt-text="Screenshot of notification template editor in the portal.":::
79
78
80
-
* The **Parameters** list contains a list of parameters, which when inserted into the subject or body, will be replaced by the designated value when the email is sent.
79
+
* The **Parameters** list contains a list of parameters that, when inserted into the subject or body, are replaced by the designated value when the email is sent.
81
80
* To insert a parameter, place the cursor where you wish the parameter to go, and select the parameter name.
82
81
83
-
1. To save the changes to the email template, select **Save**, or to cancel the changes select **Discard**.
82
+
1. To save changes to the email template, select **Save**, or select **Discard** to cancel the changes.
84
83
85
84
## Configure email settings
86
85
87
86
You can modify general email settings for notifications that are sent from your API Management instance. You can change the administrator email address, the name of the organization sending notifications, and the originating email address.
88
87
89
88
> [!IMPORTANT]
90
-
> Changing the originating email address may affect recipients' ability to receive email. See the [considerations](#considerations-for-changing-the-originating-email-address) in the following section.
89
+
> Changing the originating email address might affect recipients' ability to receive email. See the [considerations](#considerations-for-changing-the-originating-email-address) in the following section.
91
90
>
92
91
To modify email settings:
93
92
94
-
1. In the left menu, select **Notification templates**.
93
+
1. In the sidebar menu, select **Notification templates**.
94
+
95
95
1. Select **E-mail settings**.
96
+
96
97
1. On the **General email settings** page, enter values for:
97
-
***Administrator email** - the email address to receive all system notifications and other configured notifications
98
-
***Organization name** - the name of your organization for use in the developer portal and notifications
99
-
***Originating email address** - The value of the `From` header for notifications from the API Management instance. API Management sends notifications on behalf of this originating address.
100
-
101
-
98
+
***Administrator email**: the email address to receive all system notifications and other configured notifications.
99
+
***Organization name**: the name of your organization for use in the developer portal and notifications.
100
+
***Originating email address**: The value of the **From** header for notifications from the API Management instance. API Management sends notifications on behalf of this originating address.
101
+
102
102
:::image type="content" source="media/api-management-howto-configure-notifications/configure-email-settings.png" alt-text="Screenshot of API Management email settings in the portal":::
103
+
103
104
1. Select **Save**.
104
105
105
106
### Considerations for changing the originating email address
106
107
107
108
Recipients of email notifications from API Management could be affected when you change the originating email address.
108
109
109
-
***Change to From address** - When you change the originating email address (for example, to `[email protected]`), the `From` address header will be `[email protected][email protected]`. This is because the email is being sent by API Management, and not the email server of the originating email address.
110
+
***Change the From address**: When you change the originating email address (for example, to `[email protected]`), the **From** address header will be `[email protected][email protected]`. This is because the email is being sent by API Management, and not the email server of the originating email address.
110
111
111
-
***Email set to Junk or Spam folder** - Some recipients may not receive the email notifications from API Management or emails may get sent to the Junk or Spam folder. This can happen depending on the organization's SPF or DKIM email authentication settings:
112
+
***Email sent to junk or spam folder**: Some recipients might not receive the email notifications from API Management, or emails might get sent to the junk or spam folder. This can happen depending on the organization's SPF or DKIM email authentication settings:
112
113
113
-
***SPF authentication** - Email might no longer pass SPF authentication after you change the originating email address domain. To ensure successful SPF authentication and delivery of email, create the following TXT record in the DNS database of the domain specified in the email address. For instance, if the email address is `[email protected]`, contact the administrator of contoso.com to add the following TXT record: **"v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"**
114
+
***SPF authentication**: Email might no longer pass SPF authentication after you change the originating email address domain. To ensure successful SPF authentication and delivery of email, create the following TXT record in the DNS database of the domain specified in the email address. For instance, if the email address is `[email protected]`, contact the administrator of `contoso.com` to add the following TXT record: **"v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"**
114
115
115
-
***DKIM authentication** - To generate a valid signature for DKIM for email authentication, API Management requires the private key associated with the domain of the originating email address. However, it is currently not possible to upload this private key in API Management. Therefore, to assign a valid signature, API Management uses the private key associated with the `mail.windowsazure.com` domain.
116
+
***DKIM authentication**: To generate a valid signature for DKIM for email authentication, API Management requires the private key associated with the domain of the originating email address. However, it's currently not possible to upload this private key in API Management. Therefore, to assign a valid signature, API Management uses the private key associated with the `mail.windowsazure.com` domain.
116
117
117
118
## Related content
118
119
119
-
*[Overview of the developer portal](api-management-howto-developer-portal.md).
120
+
*[Overview of the developer portal](api-management-howto-developer-portal.md)
120
121
*[How to create and use groups to manage developer accounts](api-management-howto-create-groups.md)
The API Management developer portal supports programmatic access to content. It allows you to import data to or export from an API Management service through the [content management REST API](/rest/api/apimanagement/). The REST API access works for both managed and self-hosted portals.
16
+
The developer portal in Azure API Management supports programmatic access to content. The developer portal allows you to import data to, or export from, an API Management service through the [content management REST API](/rest/api/apimanagement/). The REST API access works for both managed and self-hosted developer portals.
17
17
18
18
## Automated migration script
19
19
20
-
You can use the API to automate migration of content between two API Management services - for example, a service in the test environment and a service in the production environment. The `scripts.v3/migrate.js` script in the API Management developer portal [GitHub repo](https://github.com/Azure/api-management-developer-portal/blob/master/scripts.v3/migrate.js) simplifies this automation process.
20
+
You can automate the migration of content between two API Management services, for example, a service in the test environment and a service in the production environment. The `scripts.v3/migrate.js` script in the [developer portal GitHub repo](https://github.com/Azure/api-management-developer-portal/blob/master/scripts.v3/migrate.js) simplifies this automation process.
21
21
22
22
> [!WARNING]
23
-
> The script removes contents of the developer portal in your destination API Management service. If you're concerned about it, make sure you perform a backup.
23
+
> The script removes the contents of the developer portal in your destination API Management service. If you're concerned about it, make sure you perform a backup.
24
24
25
25
> [!NOTE]
26
26
> Using the script to migrate developer portal content between an API Management instance in a classic tier (for example, Standard) and an instance in a v2 tier (for example, Standard v2) isn't currently supported. Migration of portal content between instances in the v2 tiers is also not supported.
27
27
28
28
> [!NOTE]
29
-
> If you're using a self-hosted portal with an explicitly defined custom storage account to host media files (i.e., you define the `blobStorageUrl` setting in the `config.design.json` configuration file), you need to use the original `scripts/migrate.js`[script](https://github.com/Azure/api-management-developer-portal/blob/master/scripts.v2/migrate.js). The original script doesn't work for managed or self-hosted portals with the media storage account managed by API Management. In that case, use the script from the `/scripts.v3` folder instead.
29
+
> If you're using a self-hosted developer portal with an explicitly defined custom storage account to host media files (that is, you define the `blobStorageUrl` setting in the `config.design.json` configuration file), you need to use the [original `scripts.v2/migrate.js` script](https://github.com/Azure/api-management-developer-portal/blob/master/scripts.v2/migrate.js). The original script doesn't work for managed or self-hosted portals with the media storage account managed by API Management. In that case, use the script from the `/scripts.v3` folder instead.
30
30
31
31
The script performs the following steps:
32
32
33
-
1.Capture the portal content and media from the source API Management service.
34
-
1.Remove the portal content and media from the destination API Management service.
35
-
1.Upload the portal content and media to the destination API Management service.
36
-
1. Optionally and for managed portals only - automatically publish the portal.
33
+
1.Captures the portal content and media from the source API Management service.
34
+
1.Removes the portal content and media from the destination API Management service.
35
+
1.Uploads the portal content and media to the destination API Management service.
36
+
1. Optionally and for managed portals only: automatically publishes the portal.
37
37
38
-
After the script is successfully executed, the target API Management service should contain the same portal content as the source service and you'll be able to see it as an administrator.
38
+
After the script runs successfully, the target API Management service should contain the same portal content as the source service and you'll be able to see it as an administrator.
39
39
40
-
* If you're using a managed portal, you can set the script to auto-publish the destination portal to make the migrated version automatically available to the visitors.
41
-
* If you're using a self-hosted portal, you need to publish the destination portal manually. Follow the publishing and hosting instructions in the tutorial to [set up a self-hosted developer portal](developer-portal-self-host.md).
40
+
* If you're using a managed portal, you can set the script to autopublish the destination portal to make the migrated version automatically available to visitors.
41
+
* If you're using a self-hosted portal, you need to publish the destination portal manually. Follow the publishing and hosting instructions in the tutorial to set up a [self-hosted developer portal](developer-portal-self-host.md).
42
42
43
43
## Related content
44
44
45
-
Learn more about the developer portal:
46
-
47
-
-[Azure API Management developer portal overview](api-management-howto-developer-portal.md)
48
-
-[Self-host the developer portal](developer-portal-self-host.md)
45
+
-[Overview of the developer portal](api-management-howto-developer-portal.md)
46
+
-[Self-host the API Management developer portal](developer-portal-self-host.md)
0 commit comments