Merge pull request #230180 from cebundy/wps-fix-msgs-tutorial2

[Web-PubSub]: Change code labels and replace variable with placeholders

Author: ttorble

articles/azure-web-pubsub/includes/cli-awps-connstr.md

@@ -6,11 +6,13 @@ ms.date: 08/06/2021
 ms.author: lianwei
 ---
 
-> [!Important]
+> [!IMPORTANT]
 > A connection string includes the authorization information required for your application to access Azure Web PubSub service. The access key inside the connection string is similar to a root password for your service. In production environments, always be careful to protect your access keys. Use Azure Key Vault to manage and rotate your keys securely. Avoid distributing access keys to other users, hard-coding them, or saving them anywhere in plain text that is accessible to others. Rotate your keys if you believe they may have been compromised.
 
-Use the Azure CLI [az webpubsub key](/cli/azure/webpubsub#az-webpubsub-key) command to get the **ConnectionString** of the service.
+Use the Azure CLI [az webpubsub key](/cli/azure/webpubsub#az-webpubsub-key) command to get the **ConnectionString** of the service.  Replace the `<your-unique-resource-name>` placeholder with the name of your Azure Web PubSub instance.
 
-```azurecli-interactive
-$connection-string=(az webpubsub key show --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --query primaryConnectionString)
+```azurecli
+az webpubsub key show --resource-group myResourceGroup --name <your-unique-resource-name> --query primaryConnectionString --output tsv
 ```
+
+Copy the connection string to use later.

articles/azure-web-pubsub/includes/cli-awps-creation.md

@@ -17,7 +17,7 @@ Use the Azure CLI [az webpubsub create](/cli/azure/webpubsub#az-webpubsub-create
   > [!Important]
   > Each Web PubSub resource must have a unique name. Replace <your-unique-resource-name> with the name of your Web PubSub in the following examples.
 
-```azurecli-interactive
+```azurecli
 az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
 ```
 

articles/azure-web-pubsub/includes/cli-awps-setup.md

@@ -9,28 +9,25 @@ ms.custom: devx-track-azurecli
 
 ## Azure CLI setup for local development
 
-Follow these steps to set up the Azure CLI and your project environment.
+Follow these steps to set up Azure CLI and your project environment.
+
+1. Open a command shell.
 
 1. Upgrade to the latest version of the Azure CLI.
 
-    ```bash
+    ```azurecli
     az upgrade
     ```
 
 1. Install the Azure CLI extension for Web PubSub. 
 
-    ```bash
+    ```azurecli
     az extension add --name webpubsub
     ```
 
-1. Sign in to the Azure CLI.  Following the prompts, enter your Azure credentials.
+1. Sign in to Azure CLI.  Following the prompts, enter your Azure credentials.
 
-    ```bash
+    ```azurecli
     az login
     ```
 
-1. Create a resource group.
-
-    ```bash
-    az group create --name myResourceGroup --location eastus
-    ```

articles/azure-web-pubsub/includes/cli-rg-creation.md

@@ -6,8 +6,8 @@ ms.date: 08/06/2021
 ms.author: lianwei
 ---
 
-A resource group is a logical container into which Azure resources are deployed and managed. Use the [az group create](/cli/azure/group#az-group-create) command to create a resource group named *myResourceGroup* in the *eastus* location.
+A resource group is a logical container into which Azure resources are deployed and managed. Use the [az group create](/cli/azure/group#az-group-create) command to create a resource group named `myResourceGroup` in the `eastus` location.
 
-```azurecli-interactive
-az group create --name "myResourceGroup" -l "EastUS"
+```azurecli
+az group create --name myResourceGroup --location EastUS
 ```

articles/azure-web-pubsub/tutorial-pub-sub-messages.md

@@ -5,7 +5,7 @@ author: vicancy
 ms.author: lianwei
 ms.service: azure-web-pubsub
 ms.topic: tutorial 
-ms.date: 01/17/2023
+ms.date: 03/09/2023
 ---
 
 # Tutorial: Publish and subscribe messages using WebSocket API and Azure Web PubSub service SDK
@@ -22,6 +22,8 @@ In this tutorial, you learn how to:
 
 [!INCLUDE [azure-web-pubsub-tutorial-prerequisites](includes/cli-awps-prerequisites.md)]
 
+You can use the Windows cmd.exe command shell instead of a Bash shell to run the commands in this tutorial.
+
 If creating the project on a local machine, you'll need to install the dependencies for the language you're using:
 
 # [C#](#tab/csharp)
@@ -43,7 +45,7 @@ If creating the project on a local machine, you'll need to install the dependenc
 
 ---
 
-## Setup 
+## Prepare your environment
 
 # [Local Azure CLI](#tab/LocalBash)
 
@@ -55,7 +57,7 @@ If creating the project on a local machine, you'll need to install the dependenc
 
 ---
 
-### Create a resource group
+## Create a resource group
 
 [!INCLUDE [Create a resource group](includes/cli-rg-creation.md)]
 
@@ -66,7 +68,20 @@ If creating the project on a local machine, you'll need to install the dependenc
 
 ### Create a Web PubSub instance
 
-[!INCLUDE [Create a Web PubSub instance](includes/cli-awps-creation.md)]
+Use the Azure CLI [az webpubsub create](/cli/azure/webpubsub#az-webpubsub-create) command to create a Web PubSub in the resource group you've created. The following command creates a _Free_ Web PubSub resource under resource group `myResourceGroup` in `EastUS`:
+
+Each Web PubSub resource must have a unique name. Replace <your-unique-resource-name> with the name of your Web PubSub instance in the following command.
+
+```azurecli
+az webpubsub create --resource-group myResourceGroup --name <your-unique-resource-name> --location EastUS --sku Free_F1
+```
+
+The output of this command shows properties of the newly created resource. Take note of the two properties listed below:
+
+* **name**: The Web PubSub name you provided in the `--name` parameter above.
+* **hostName**: In the example, the host name is `<your-unique-resource-name>.webpubsub.azure.com/`.
+
+At this point, your Azure account is the only one authorized to perform any operations on this new resource.
 
 ### Get the connection string
 
@@ -80,7 +95,7 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
 
 1. First, create a project directory named `subscriber` for this project and install required dependencies:
 
-    * The package [Websocket.Client](https://github.com/Marfusios/websocket-client) is a third-party package supporting WebSocket connection. You can use any API/library that supports WebSocket to do so.
+    * The package [Websocket.Client](https://github.com/Marfusios/websocket-client) is a third-party package supporting WebSocket connections. You can use any API/library that supports WebSocket.
     * The SDK package `Azure.Messaging.WebPubSub` helps to generate the JWT token. 
 
     ```bash
@@ -140,10 +155,10 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
 
      After the connection is established, your client receives messages through the WebSocket connection. The client uses `client.MessageReceived.Subscribe(msg => ...));` to listen for incoming messages.
 
-1. Run the following command:
+1. To start the subscriber, run the following command replacing `<Web-PubSub-connection-string>` with the connection string you copied earlier:
 
     ```bash
-    dotnet run $connection_string "myHub1"
+    dotnet run <Web-PubSub-connection-string> "myHub1"
     ```
 
 # [JavaScript](#tab/javascript)
@@ -183,11 +198,11 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
 
      After the connection is established, your client receives messages through the WebSocket connection. The client uses `client.MessageReceived.Subscribe(msg => ...));` to listen for incoming messages.
 
-1. Run the following command:
+1. Run the following command replacing `<Web-PubSub-connection-string>` with the connection string you copied earlier. If you are using Windows command shell, you can use `set` instead of `export`.
 
     ```bash
-    export WebPubSubConnectionString=$connection_string
-    node subscribe
+    export WebPubSubConnectionString=<Web-PubSub-connection-string>
+    node subscribe.js
     ```
 
 # [Python](#tab/python)
@@ -248,10 +263,10 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
 
     After the connection is established, your client will receive messages through the WebSocket connection. Use `await ws.recv()` to listen for incoming messages.
 
-1. Run the following command:
+1. Run the following command replacing `<Web-PubSub-connection-string>` with the connection string you copied earlier:
 
     ```bash
-    python subscribe.py $connection_string "myHub1"
+    python subscribe.py <Web-PubSub-connection-string> "myHub1"
     ```
 
 # [Java](#tab/java)
@@ -265,7 +280,7 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
 
 1. Inside the `pubsub` directory, use Maven to create a new console app called `webpubsub-quickstart-subscriber`, then go to the *webpubsub-quickstart-subscriber* directory:
 
-    ```console
+    ```bash
     mvn archetype:generate --define interactiveMode=n --define groupId=com.webpubsub.quickstart --define artifactId=webpubsub-quickstart-subscriber --define archetypeArtifactId=maven-archetype-quickstart --define archetypeVersion=1.4
     cd webpubsub-quickstart-subscriber
     ```
@@ -363,10 +378,10 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
 
     After connection is established, your client will receive messages through the WebSocket connection. Use `onMessage(String message)` to listen for incoming messages.
 
-1. Navigate to the *webpubsub-quickstart-subscriber* directory and run the app with following command:
+1.  To start the subscriber app, go to the *webpubsub-quickstart-subscriber* directory and run the  following command. Replace `<Web-PubSub-connection-string>` with the connection string you copied earlier.
 
-    ```console
-    mvn compile & mvn package & mvn exec:java -Dexec.mainClass="com.webpubsub.quickstart.App" -Dexec.cleanupDaemonThreads=false -Dexec.args="$connection_string 'myHub1'"
+    ```bash
+    mvn compile & mvn package & mvn exec:java -Dexec.mainClass="com.webpubsub.quickstart.App" -Dexec.cleanupDaemonThreads=false -Dexec.args="<Web-PubSub-connection-string> 'myHub1'"
     ```
 
 ---
@@ -418,15 +433,15 @@ Create a publisher using the Azure Web PubSub SDK to publish a message to the co
 
     The `SendToAllAsync()` call simply sends a message to all connected clients in the hub.
 
-1. Send a message by running the command:
+1. Send a message by running the following command. Replace `<Web-PubSub-connection-string>` with the connection string you copied earlier.
 
     ```bash
-    dotnet run $connection_string "myHub1" "Hello World"
+    dotnet run <Web-PubSub-connection-string> "myHub1" "Hello World"
     ```
 
-1. Check the command shell of the previous subscriber to see that it received the message:
+1. Check the command shell of the subscriber to see that it received the message:
 
-    ```text
+    ```console
     Message received: Hello World
     ```
 
@@ -456,16 +471,16 @@ Create a publisher using the Azure Web PubSub SDK to publish a message to the co
 
     The `service.sendToAll()` call simply sends a message to all connected clients in a hub.
 
-1. Send a message by running the command:
+1. To send a message, run the following command replacing `<Web-PubSub-connection-string>` with the connection string you copied earlier. If you are using Windows command shell, you can use `set` instead of `export`.
 
     ```bash
-    export WebPubSubConnectionString=$connection_string 
+    export WebPubSubConnectionString=<Web-PubSub-connection-string>
     node publish "Hello World"
     ```
 
-1. You can see that the previous subscriber received the message:
+1. You can see that the subscriber received the message:
 
-    ```text
+    ```console
     Message received: Hello World
     ```
 
@@ -508,23 +523,23 @@ Create a publisher using the Azure Web PubSub SDK to publish a message to the co
 
     The `send_to_all()` send the message to all connected clients in a hub.
 
-1. Run the following command:
+1. To send a message, run the following command replacing `<Web-PubSub-connection-string>` with the connection string you copied earlier.
 
     ```bash
-    python publish.py $connection_string "myHub1" "Hello World"
+    python publish.py <Web-PubSub-connection-string> "myHub1" "Hello World"
     ```
 
 1. Check the previous command shell to that the subscriber received the message:
 
-    ```text
+    ```console
     Received message: Hello World
     ```
 
 # [Java](#tab/java)
 
 1. Go to the `pubsub` directory.  Use Maven to create a publisher console app `webpubsub-quickstart-publisher` and go to the *webpubsub-quickstart-publisher* directory:
 
-    ```console
+    ```bash
     mvn archetype:generate --define interactiveMode=n --define groupId=com.webpubsub.quickstart --define artifactId=webpubsub-quickstart-publisher --define archetypeArtifactId=maven-archetype-quickstart --define archetypeVersion=1.4
     cd webpubsub-quickstart-publisher
     ```
@@ -573,15 +588,15 @@ Create a publisher using the Azure Web PubSub SDK to publish a message to the co
 
     The `sendToAll()` call sends a message to all connected clients in a hub.
 
-1. Go to the *webpubsub-quickstart-publisher* directory and run the project using the following command:
+1. To send a message, go to the *webpubsub-quickstart-publisher* directory and run the project using the following command.  Replace the  `<Web-PubSub-connection-string>` with the connection string you copied earlier.
 
-    ```console
-    mvn compile & mvn package & mvn exec:java -Dexec.mainClass="com.webpubsub.quickstart.App" -Dexec.cleanupDaemonThreads=false -Dexec.args="$connection_string 'myHub1' 'Hello World'"
+    ```bash
+    mvn compile & mvn package & mvn exec:java -Dexec.mainClass="com.webpubsub.quickstart.App" -Dexec.cleanupDaemonThreads=false -Dexec.args="<Web-PubSub-connection-string> 'myHub1' 'Hello World'"
     ```
 
-1. You can see that the previous subscriber received the message:
+1. You can see that the subscriber received the message:
 
-    ```text
+    ```console
     Message received: Hello World
     ```
 
@@ -608,7 +623,7 @@ az group delete --name <CloudShellResourceGroup> --yes
 
 ## Next steps
 
-This tutorial provides you a basic idea of how to connect to the Web PubSub service and publish messages to the connected clients.
+This tutorial provides you with a basic idea of how to connect to the Web PubSub service and publish messages to the connected clients.
 
 Check other tutorials to dive further into how to use the service.