Updating quickstarts to include AzureKeyCredential

natekimball-msft · natekimball-msft · commit b1440a4f31b6 · 2023-03-17T11:19:00.000-07:00
diff --git a/articles/communication-services/quickstarts/email/includes/send-email-java.md b/articles/communication-services/quickstarts/email/includes/send-email-java.md
@@ -47,7 +47,7 @@ EmailSendResult returns the following status on the email operation performed.
 
 Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.
 
-> [!Note]
+> [!NOTE]
 > We can also send an email from our own verified domain [Add custom verified domains to Email Communication Service](../add-custom-verified-domains.md).
 
 ### Prerequisite check
@@ -117,35 +117,34 @@ EmailClient emailClient = new EmailClientBuilder()
     .buildClient();
 ```
 
-### Option 2: Authenticate using an AzureKeyCredential
+### Option 2: Authenticate using Azure Active Directory
 
-Email clients can also be created and authenticated using the endpoint and Azure Key Credential acquired from an Azure Communication Resource in the [Azure portal](https://portal.azure.com/).
+A `DefaultAzureCredential` object must be passed to the `EmailClientBuilder` via the `credential()` method. An endpoint must also be set via the `endpoint()` method.
+
+The `AZURE_CLIENT_SECRET`, `AZURE_CLIENT_ID`, and `AZURE_TENANT_ID` environment variables are needed to create a `DefaultAzureCredential` object.
 
 ```java
-String endpoint = "https://<resource-name>.communication.azure.com";
-AzureKeyCredential azureKeyCredential = new AzureKeyCredential("<access-key>");
+// You can find your endpoint and access key from your resource in the Azure portal
+String endpoint = "https://<resource-name>.communication.azure.com/";
 EmailClient emailClient = new EmailClientBuilder()
     .endpoint(endpoint)
-    .credential(azureKeyCredential)
+    .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();
 ```
 
-### Option 3: Authenticate using Azure Active Directory
+### Option 3: Authenticate using AzureKeyCredential
 
-A `DefaultAzureCredential` object must be passed to the `EmailClientBuilder` via the `credential()` method. An endpoint must also be set via the `endpoint()` method.
-
-The `AZURE_CLIENT_SECRET`, `AZURE_CLIENT_ID`, and `AZURE_TENANT_ID` environment variables are needed to create a `DefaultAzureCredential` object.
+Email clients can also be created and authenticated using the endpoint and Azure Key Credential acquired from an Azure Communication Resource in the [Azure portal](https://portal.azure.com/).
 
 ```java
-// You can find your endpoint and access key from your resource in the Azure portal
-String endpoint = "https://<resource-name>.communication.azure.com/";
+String endpoint = "https://<resource-name>.communication.azure.com";
+AzureKeyCredential azureKeyCredential = new AzureKeyCredential("<access-key>");
 EmailClient emailClient = new EmailClientBuilder()
     .endpoint(endpoint)
-    .credential(new DefaultAzureCredentialBuilder().build())
+    .credential(azureKeyCredential)
     .buildClient();
 ```
 
-
 For simplicity, this quickstart uses connection strings, but in production environments, we recommend using [service principals](../../../quickstarts/identity/service-principal.md).
 
 ## Basic email sending 
diff --git a/articles/communication-services/quickstarts/email/includes/send-email-js.md b/articles/communication-services/quickstarts/email/includes/send-email-js.md
@@ -49,7 +49,7 @@ EmailSendResult returns the following status on the email operation performed.
 
 Completing this quick start incurs a small cost of a few USD cents or less in your Azure account.
 
-> [!Note]
+> [!NOTE]
 > We can also send an email from our own verified domain. [Add custom verified domains to Email Communication Service](../add-azure-managed-domains.md).
 
 ### Prerequisite check
@@ -109,21 +109,38 @@ const emailClient = new EmailClient(connectionString);
 
 ### Option 2: Authenticate using Azure Active Directory
 
-You can also authenticate with Azure Active Directory using the [Azure Identity library](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity). To use the [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential) provider shown below, or other credential providers provided with the Azure SDK, please install the [`@azure/identity`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity) package:
+You can also authenticate with Azure Active Directory using the [Azure Identity library](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity). To use the [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential) provider in the following snippet, or other credential providers provided with the Azure SDK, install the [`@azure/identity`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity) package:
 
 ```bash
 npm install @azure/identity
 ```
 
-The [`@azure/identity`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity) package provides a variety of credential types that your application can use to do this. The README for `@azure/identity` provides more details and samples to get you started.
+The [`@azure/identity`](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity) package provides various credential types that your application can use to authenticate. The README for `@azure/identity` provides more details and samples to get you started.
 `AZURE_CLIENT_SECRET`, `AZURE_CLIENT_ID` and `AZURE_TENANT_ID` environment variables are needed to create a `DefaultAzureCredential` object.
 
 ```typescript
 import { DefaultAzureCredential } from "@azure/identity";
 import { EmailClient } from "@azure/communication-email";
+
 const endpoint = "https://<resource-name>.communication.azure.com";
 let credential = new DefaultAzureCredential();
-const client = new EmailClient(endpoint, credential);
+
+const emailClient = new EmailClient(endpoint, credential);
+```
+
+### Option 3: Authenticate using AzureKeyCredential
+
+Email clients can also be authenticated using an [AzureKeyCredential](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html#azure.core.credentials.AzureKeyCredential). Both the `key` and the `endpoint` can be founded on the "Keys" pane under "Settings" in your Communication Services Resource.
+
+```javascript
+const { EmailClient } = require("@azure/communication-email");
+const { AzureKeyCredential } = require("@azure/core-auth");
+require("dotenv").config();
+
+var key = new AzureKeyCredential("<your-key-credential>");
+var endpoint = "<your-endpoint-uri>";
+
+const emailClient = new EmailClient(endpoint, key);
 ```
 
 For simplicity, this quickstart uses connection strings, but in production environments, we recommend using [service principals](../../../quickstarts/identity/service-principal.md).
diff --git a/articles/communication-services/quickstarts/email/includes/send-email-net.md b/articles/communication-services/quickstarts/email/includes/send-email-net.md
@@ -12,7 +12,7 @@ ms.service: azure-communication-services
 
 Get started with Azure Communication Services by using the Communication Services C# Email client library to send Email messages.
 
-## Understanding Email Object model
+## Understanding the Email Object model
 
 The following classes and interfaces handle some of the major features of the Azure Communication Services Email Client library for C#.
 
@@ -39,8 +39,8 @@ EmailSendResult returns the following status on the email operation performed.
 | NotStarted | We're not sending this status from our service at this time. |
 | Running | The email send operation is currently in progress and being processed. |
 | Succeeded | The email send operation has completed without error and the email is out for delivery. Any detailed status about the email delivery beyond this stage can be obtained either through Azure Monitor or through Azure Event Grid. [Learn how to subscribe to email events](../handle-email-events.md) |
-| Failed | The email send operation was not successful and encountered an error. The email was not sent. The result will contain an error object with more details on the reason for failure or cancellation. |
-| Canceled | The email send operation was canceled before it could complete. The email was not sent. The result will contain an error object with more details on the reason for failure or cancellation.|
+| Failed | The email send operation wasn't successful and encountered an error. The email wasn't sent. The result contains an error object with more details on the reason for failure or cancellation. |
+| Canceled | The email send operation was canceled before it could complete. The email wasn't sent. The result contains an error object with more details on the reason for failure or cancellation.|
 
 ## Prerequisites
 
@@ -49,13 +49,16 @@ EmailSendResult returns the following status on the email operation performed.
 - An Azure Email Communication Services Resource created and ready with a provisioned domain [Get started with Creating Email Communication Resource](../create-email-communication-resource.md)
 - An active 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)
 
+Completing this quick start incurs a small cost of a few USD cents or less in your Azure account.
+
+> [!NOTE]
+> We can also send an email from our own verified domain. [Add custom verified domains to Email Communication Service](../add-azure-managed-domains.md).
+
 ### Prerequisite check
 
 - In a terminal or command window, run the `dotnet` command to check that the .NET client library is installed.
 - To view the subdomains associated with your Email Communication Services resource, sign in to the [Azure portal](https://portal.azure.com/), locate your Email Communication Services resource and open the **Provision domains** tab from the left navigation pane.
 
-Completing this quick start incurs a small cost of a few USD cents or less in your Azure account.
-
 ### Create a new C# application
 In a console window (such as cmd, PowerShell, or Bash), use the `dotnet new` command to create a new console app with the name `EmailQuickstart`. This command creates a simple "Hello World" C# project with a single source file: **Program.cs**.
 
@@ -108,7 +111,7 @@ namespace SendEmail
 
 ### Option 1: Authenticate using a connection string
 
- Open **Program.cs** in a text editor and replace the body of the `Main` method with code to initialize an `EmailClient` with your connection string. The code below retrieves the connection string for the resource from an environment variable named `COMMUNICATION_SERVICES_CONNECTION_STRING`. Learn how to [manage your resource's connection string](../../create-communication-resource.md#store-your-connection-string).
+ Open **Program.cs** in a text editor and replace the body of the `Main` method with code to initialize an `EmailClient` with your connection string. The following code retrieves the connection string for the resource from an environment variable named `COMMUNICATION_SERVICES_CONNECTION_STRING`. Learn how to [manage your resource's connection string](../../create-communication-resource.md#store-your-connection-string).
 
 
 
@@ -121,7 +124,7 @@ EmailClient emailClient = new EmailClient(connectionString);
 
 ### Option 2: Authenticate using Azure Active Directory
 
-To authenticate using Azure Active Directory, install the Azure.Identity library package for .NET by using the `dotnet add package` command.
+To authenticate using Azure Active Directory, install the `Azure.Identity` library package for .NET by using the `dotnet add package` command.
 
 ```console
 dotnet add package Azure.Identity
@@ -136,6 +139,17 @@ string resourceEndpoint = "<ACS_RESOURCE_ENDPOINT>";
 EmailClient emailClient = new EmailClient(new Uri(resourceEndpoint), new DefaultAzureCredential());
 ```
 
+### Option 3: Authenticate using AzureKeyCredential
+
+Email clients can also be authenticated using an [AzureKeyCredential](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html#azure.core.credentials.AzureKeyCredential). Both the `key` and the `endpoint` can be founded on the "Keys" pane under "Settings" in your Communication Services Resource.
+
+```csharp
+var key = new AzureKeyCredential("<your-key-credential>");
+var endpoint = new Uri("<your-endpoint-uri>");
+
+var emailClient = new EmailClient(endpoint, key);
+```
+
 ## Basic Email Sending 
 
 ### Construct your email message
@@ -160,8 +174,8 @@ var recipient = "emailalias@contoso.com";
 ### Send and get the email send status
 
 To send an email message, you need to:
-- Call SendSync method which sends the email request as an asynchronous operation. Call with Azure.WaitUntil.Completed if your method should wait to return until the long-running operation has completed on the service; Call with Azure.WaitUntil.Started if your method should return after starting the operation. 
-- SendAsync method returns EmailSendOperation which returns "Succeeded" EmailSendStatus if email is out for delivery. Add this code to the end of `Main` method in **Program.cs**:
+- Call SendSync method that sends the email request as an asynchronous operation. Call with Azure.WaitUntil.Completed if your method should wait to return until the long-running operation has completed on the service. Call with Azure.WaitUntil.Started if your method should return after starting the operation. 
+- SendAsync method returns EmailSendOperation that returns "Succeeded" EmailSendStatus if email is out for delivery. Add this code to the end of `Main` method in **Program.cs**:
 
 ```csharp
 try
@@ -193,20 +207,20 @@ catch (Exception ex)
 
 ### Getting email delivery status
 
-EmailSendOperation only returns email operation status. To get the actual email delivery status you can subscribe to "EmailDeliveryReportReceived" event which is generated when the email delivery is completed and the event returns the following delivery state :
+EmailSendOperation only returns email operation status. To get the actual email delivery status, you can subscribe to "EmailDeliveryReportReceived" event that is generated when the email delivery is completed. The event returns the following delivery state:
 
 - Delivered. 
 - Failed. 
 - Quarantined.
 
 See [Handle Email Events](../handle-email-events.md) for details.
 
-You can also now subscribe to Email Operational logs which provides information related to delivery metrics for messages sent from the Email service.
+You can also now subscribe to Email Operational logs that provide information related to delivery metrics for messages sent from the Email service.
 
 - Email Send Mail operational logs - provides detailed information related to the Email service send mail requests.
 - Email Status Update operational logs - provides message and recipient level delivery status updates related to the Email service send mail requests.
 
-Please see how to [Get started with log analytics in Azure Communication Service](../../../concepts/logging-and-diagnostics.md)
+See how to [Get started with log analytics in Azure Communication Service](../../../concepts/logging-and-diagnostics.md)
 
 ### Run the code
 
@@ -226,8 +240,8 @@ You can download the sample app from [GitHub](https://github.com/Azure-Samples/c
 
 When you call SendAsync with Azure.WaitUntil.Started, your method returns back after starting the operation. The method returns EmailSendOperation object. You can call UpdateStatusAsync method to refresh the email operation status. 
 
-The returned EmailSendOperation object contains an EmailSendStatus object which contains: 
-- Current status of the email send operation.
+The returned EmailSendOperation object contains an EmailSendStatus object that contains: 
+- Current status of the Email Send operation.
 - An error object with failure details if the current status is in a failed state.
 
 ```csharp
@@ -358,7 +372,7 @@ catch (Exception ex)
 
 ### Send an email message to multiple recipients
 
-We can define multiple recipients by adding additional EmailAddresses to the EmailRecipients object. These addresses can be added as `To`, `CC`, or `BCC` recipients.
+We can define multiple recipients by adding more EmailAddresses to the EmailRecipients object. These addresses can be added as `To`, `CC`, or `BCC` recipients.
 
 ```csharp
 var toRecipients = new List<EmailAddress>
@@ -380,7 +394,7 @@ var bccRecipients = new List<EmailAddress>
 EmailRecipients emailRecipients = new EmailRecipients(toRecipients, ccRecipients, bccRecipients);
 ```
 
-You can download the sample app demonstrating this from [GitHub](https://github.com/Azure-Samples/communication-services-dotnet-quickstarts/tree/main/SendEmailAdvanced/SendEmailToMultipleRecipients)
+You can download the sample app demonstrating this action from [GitHub](https://github.com/Azure-Samples/communication-services-dotnet-quickstarts/tree/main/SendEmailAdvanced/SendEmailToMultipleRecipients)
 
 
 ### Send an email message with attachments
@@ -397,6 +411,6 @@ emailMessage.Attachments.Add(emailAttachment);
 
 ```
 
-You can download the sample app demonstrating this from [GitHub](https://github.com/Azure-Samples/communication-services-dotnet-quickstarts/tree/main/SendEmailAdvanced/SendEmailWithAttachments)
+You can download the sample app demonstrating this action from [GitHub](https://github.com/Azure-Samples/communication-services-dotnet-quickstarts/tree/main/SendEmailAdvanced/SendEmailWithAttachments)
 
 
diff --git a/articles/communication-services/quickstarts/email/includes/send-email-python.md b/articles/communication-services/quickstarts/email/includes/send-email-python.md
@@ -104,6 +104,9 @@ The `response.status` values are explained further in the following table.
 
 Completing this quick start incurs a small cost of a few USD cents or less in your Azure account.
 
+> [!NOTE]
+> We can also send an email from our own verified domain. [Add custom verified domains to Email Communication Service](../add-azure-managed-domains.md).
+
 ### Prerequisite check
 - In a terminal or command window, run the `python --version` command to check that Python is installed.
 - To view the domains verified with your Email Communication Services resource, sign in to the [Azure portal](https://portal.azure.com/). Locate your Email Communication Services resource and open the **Provision domains** tab from the left navigation pane.
@@ -170,18 +173,21 @@ from azure.identity import DefaultAzureCredential
 
 # To use Azure Active Directory Authentication (DefaultAzureCredential) make sure to have AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET as env variables.
 endpoint = "https://<resource-name>.communication.azure.com"
-client = EmailClient(endpoint, DefaultAzureCredential())
+email_client = EmailClient(endpoint, DefaultAzureCredential())
 ```
 
 ### Option 3: Authenticate using AzureKeyCredential
-Email clients can also be authenticated using an [AzureKeyCredential](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html#azure.core.credentials.AzureKeyCredential).
+
+Email clients can also be authenticated using an [AzureKeyCredential](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html#azure.core.credentials.AzureKeyCredential). Both the `key` and the `endpoint` can be founded on the "Keys" pane under "Settings" in your Communication Services Resource.
 
 ```python
 from azure.communication.email import EmailClient
 from azure.core.credentials import AzureKeyCredential
-credential = AzureKeyCredential("<api_key>")
-endpoint = "https://<resource-name>.communication.azure.com/"
-client = EmailClient(endpoint, credential);
+
+key = AzureKeyCredential("<your-key-credential>");
+endpoint = "<your-endpoint-uri>";
+
+email_client = EmailClient(endpoint, key);
 ```
 
 For simplicity, this quickstart uses connection strings, but in production environments, we recommend using [service principals](../../../quickstarts/identity/service-principal.md).
