Skip to content

Commit ddafc70

Browse files
author
Jill Grant
authored
Merge pull request #286727 from ddouglas-msft/ddouglas-msft/smtp-auth-update-permissions
Update custom role permissions for smtp auth
2 parents a12c2c9 + 3b34eb2 commit ddafc70

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed
19.8 KB
Loading
56.8 KB
Loading

articles/communication-services/quickstarts/email/send-email-smtp/send-email-smtp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: How to use SMTP to send an email with Azure Communication Services.
33
titleSuffix: An Azure Communication Services quick start guide.
44
description: Learn about how to use SMTP to send emails to Email Communication Services.
5-
author: ddouglas
5+
author: ddouglas-msft
66
services: azure-communication-services
77
ms.author: ddouglas
88
ms.date: 10/18/2023

articles/communication-services/quickstarts/email/send-email-smtp/smtp-authentication.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: How to create authentication credentials for sending emails using SMTP
33
titleSuffix: An Azure Communication Services Quickstart
44
description: Learn about how to use a service principal to create authentication credentials for sending emails using SMTP.
5-
author: ddouglas
5+
author: ddouglas-msft
66
services: azure-communication-services
77
ms.author: ddouglas
88
ms.date: 10/18/2023
@@ -19,16 +19,16 @@ In this quick start, you learn about how to use an Entra application to create t
1919
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
2020
- An Azure Communication Email Resource created and ready with a provisioned domain [Get started with Creating Email Communication Resource](../create-email-communication-resource.md)
2121
- An active Azure Communication Services Resource connected with Email Domain and a Connection String. [Get started by Connecting Email Resource with a Communication Resource](../connect-email-communication-resource.md)
22-
- An Entra application with access to the Azure Communication Services Resource. [Register an application with Microsoft Entra ID and create a service principal](/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-microsoft-entra-id-and-create-a-service-principal)
23-
- A client secret for the Entra application with access to the Azure Communication Service Resource. [Create a new client secret](/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret)
22+
- A Microsoft Entra application with access to the Azure Communication Services Resource. [Register an application with Microsoft Entra ID and create a service principal](/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-microsoft-entra-id-and-create-a-service-principal)
23+
- A client secret for the Microsoft Entra application with access to the Azure Communication Service Resource. [Create a new client secret](/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret)
2424

2525
## Using a Microsoft Entra application with access to the Azure Communication Services Resource for SMTP
2626

27-
Application developers who build apps that send email using the SMTP protocol need to implement secure, modern authentication. Azure Communication Services does this by leveraging Entra application service principals. Combining the Azure Communication Services Resource and the Entra application service principal's information, the SMTP services undertakes authentication with Entra on the user's behalf to ensure a secure and seamless email transmission.
27+
Application developers who build apps that send email using the SMTP protocol need to implement secure, modern authentication. Azure Communication Services does this by leveraging Microsoft Entra application service principals. Combining the Azure Communication Services Resource and the Microsoft Entra application service principal's information, the SMTP services undertakes authentication with Microsoft Entra on the user's behalf to ensure a secure and seamless email transmission.
2828

29-
### Creating a custom email role for the Entra application
29+
### Creating a custom email role for the Microsoft Entra application
3030

31-
The Entra application must be assigned a role with both the **Microsoft.Communication/CommunicationServices/Read** and the **Microsoft.Communication/EmailServices/write** permissions on the Azure Communication Service Resource. This can be done either by using the **Contributor** role, or by creating a **custom role**. Follow these steps to create a custom role by cloning an existing role.
31+
The Microsoft Entra application must be assigned a role with both the **Microsoft.Communication/CommunicationServices/Read**, **Microsoft.Communication/CommunicationServices/Write**, and the **Microsoft.Communication/EmailServices/write** permissions on the Azure Communication Service Resource. This can be done either by using the **Contributor** role, or by creating a **custom role**. Follow these steps to create a custom role by cloning an existing role.
3232

3333
1. In the portal, a custom role can be created by first navigating to the subscription, resource group, or Azure Communication Service Resource where you want the custom role to be assignable and then open **Access control (IAM)**.
3434
:::image type="content" source="../media/smtp-custom-role-iam.png" alt-text="Screenshot that shows Access control.":::
@@ -40,14 +40,14 @@ The Entra application must be assigned a role with both the **Microsoft.Communic
4040
:::image type="content" source="../media/smtp-custom-role-basics.png" alt-text="Screenshot that shows creating a name for a new custom role.":::
4141
1. Click the **Permissions** tab and click **Add permissions**. Search for **Microsoft.Communication** and select **Azure Communication Services**
4242
:::image type="content" source="../media/smtp-custom-role-permissions.png" alt-text="Screenshot that shows adding permissions for a new custom role.":::
43-
1. Select the **Microsoft.Communication/CommunicationServices** **Read** and the **Microsoft.Communication/EmailServices** **Write*** permissions. Click **Add**.
43+
1. Select the **Microsoft.Communication/CommunicationServices** **Read**, **Microsoft.Communication/CommunicationServices** **Write**, and the **Microsoft.Communication/EmailServices** **Write** permissions. Click **Add**.
4444
:::image type="content" source="../media/smtp-custom-role-add-permissions.png" alt-text="Screenshot that shows adding Azure Communication Services' permissions.":::
4545
1. Review the permissions for the new role. Click **Review + create** and then **Create** on the next page.
4646
:::image type="content" source="../media/smtp-custom-role-review.png" alt-text="Screenshot that shows reviewing the new custom role.":::
4747

48-
When assigning the Entra application a role for the Azure Communication Services Resource, the new custom role will be available. For more information on creating custom roles, see [Create or update Azure custom roles using the Azure portal](../../../../role-based-access-control/custom-roles-portal.md)
48+
When assigning the Microsoft Entra application a role for the Azure Communication Services Resource, the new custom role will be available. For more information on creating custom roles, see [Create or update Azure custom roles using the Azure portal](../../../../role-based-access-control/custom-roles-portal.md)
4949

50-
### Assigning the custom email role to the Entra application
50+
### Assigning the custom email role to the Microsoft Entra application
5151
1. In the portal, navigate to the subscription, resource group, or Azure Communication Service Resource where you want the custom role to be assignable and then open **Access control (IAM)**.
5252
:::image type="content" source="../media/smtp-custom-role-iam.png" alt-text="Screenshot that shows Access control.":::
5353
1. Click **+Add** and then select **Add role assignment**.
@@ -56,39 +56,39 @@ When assigning the Entra application a role for the Azure Communication Services
5656
:::image type="content" source="../media/email-smtp-select-custom-role.png" alt-text="Screenshot that shows selecting the custom role.":::
5757
1. On the **Members** tab, choose **User, group, or service principal** and then click **+Select members**.
5858
:::image type="content" source="../media/email-smtp-select-members.png" alt-text="Screenshot that shows choosing select members.":::
59-
1. Use the search box to find the **Entra** application that you'll use for authentication and select it. Then click **Select**.
60-
:::image type="content" source="../media/email-smtp-select-entra.png" alt-text="Screenshot that shows selecting the Entra application.":::
59+
1. Use the search box to find the **Microsoft Entra** application that you'll use for authentication and select it. Then click **Select**.
60+
:::image type="content" source="../media/email-smtp-select-entra.png" alt-text="Screenshot that shows selecting the Microsoft Entra application.":::
6161
1. After confirming the selection, click **Next**.
6262
:::image type="content" source="../media/email-smtp-select-review.png" alt-text="Screenshot that shows reviewing the assignment.":::
6363
1. After confirming the scope and members, click **Review + assign**.
6464
:::image type="content" source="../media/email-smtp-select-assign.png" alt-text="Screenshot that shows assigning the custom role.":::
6565

66-
### Creating the SMTP credentials from the Entra application information.
66+
### Creating the SMTP credentials from the Microsoft Entra application information.
6767
#### SMTP Authentication Username
68-
Azure Communication Services allows the credentials for an Entra application to be used as the SMTP username and password. The username consists of the following three parts and can be pipe or dot delimited.
68+
Azure Communication Services allows the credentials for a Microsoft Entra application to be used as the SMTP username and password. The username consists of the following three parts and can be pipe or dot delimited.
6969
1. The Azure Communication Service Resource name.
7070
:::image type="content" source="../media/email-smtp-resource-name.png" alt-text="Screenshot that shows finding the resource name.":::
71-
1. The Entra Application ID.
72-
:::image type="content" source="../media/email-smtp-entra-details.png" alt-text="Screenshot that shows finding the Entra Application ID.":::
73-
1. The Entra Tenant ID.
74-
:::image type="content" source="../media/email-smtp-entra-tenant.png" alt-text="Screenshot that shows finding the Entra Tenant ID.":::
71+
1. The Microsoft Entra Application ID.
72+
:::image type="content" source="../media/email-smtp-entra-details.png" alt-text="Screenshot that shows finding the Microsoft Entra Application ID.":::
73+
1. The Microsoft Entra Tenant ID.
74+
:::image type="content" source="../media/email-smtp-entra-tenant.png" alt-text="Screenshot that shows finding the Microsoft Entra Tenant ID.":::
7575

7676
**Dot-delimited Format:**
7777
```
78-
username: <Azure Communication Services Resource name>.<Entra Application ID>.<Entra Tenant ID>
78+
username: <Azure Communication Services Resource name>.<Microsoft Entra Application ID>.<Microsoft Entra Tenant ID>
7979
```
8080
**Pipe-delimited Format:**
8181
```
82-
username: <Azure Communication Services Resource name>|<Entra Application ID>|<Entra Tenant ID>
82+
username: <Azure Communication Services Resource name>|<Microsoft Entra Application ID>|<Microsoft Entra Tenant ID>
8383
```
8484

8585
#### SMTP Authentication Password
86-
The password is one of the Entra application's client secrets.
87-
:::image type="content" source="../media/email-smtp-entra-secret.png" alt-text="Screenshot that shows finding the Entra client secret.":::
86+
The password is one of the Microsoft Entra application's client secrets.
87+
:::image type="content" source="../media/email-smtp-entra-secret.png" alt-text="Screenshot that shows finding the Microsoft Entra client secret.":::
8888

8989
### Requirements for SMTP AUTH client submission
9090

91-
- **Authentication**: Username and password authentication is supported using Entra application details as the credentials. The Azure Communication Services SMTP service will use the Entra application details to get an access token on behalf of the user and use that to submit the email. Because the Entra token isn't cached, access can be revoked immediately by either changing the Entra application client secret or by changing the access controls for the Azure Communication Services Resource.
91+
- **Authentication**: Username and password authentication is supported using the Microsoft Entra application details as the credentials. The Azure Communication Services SMTP service will use the Microsoft Entra application details to get an access token on behalf of the user and use that to submit the email. Because the Microsoft Entra token isn't cached, access can be revoked immediately by either changing the Microsoft Entra application client secret or by changing the access controls for the Azure Communication Services Resource.
9292
- **Azure Communication Service**: An Azure Communication Services Resource with a connected Azure Communication Email Resource and domain is required.
9393
- **Transport Layer Security (TLS)**: Your device must be able to use TLS version 1.2 and above.
9494
- **Port**: Port 587 is required and must be unblocked on your network. Some network firewalls or ISPs block ports because that's the port that email servers use to send mail.
@@ -103,4 +103,4 @@ Enter the following settings directly on your device or in the application as th
103103
|Server / smart host | smtp.azurecomm.net |
104104
|Port |Port 587|
105105
|TLS / StartTLS | Enabled|
106-
|Username and password | Enter the Entra application credentials from an application with access to the Azure Communication Services Resource |
106+
|Username and password | Enter the Microsoft Entra application credentials from an application with access to the Azure Communication Services Resource |

0 commit comments

Comments
 (0)