Skip to content

Commit fb4a4f6

Browse files
committed
made changes in accordance with the Azure CLI article and editor's guidelines documentation
1 parent bf6aab0 commit fb4a4f6

File tree

4 files changed

+16
-21
lines changed

4 files changed

+16
-21
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ ms.author: lianwei
99
> [!INPORTANT]
1010
> 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.
1111
12-
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>` with the name of your Azure Web PubSub instance.
12+
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.
1313

1414
```azurecli
15-
az webpubsub key show --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --query primaryConnectionString --output tsv
15+
az webpubsub key show --resource-group myResourceGroup --name <your-unique-resource-name> --query primaryConnectionString --output tsv
1616
```
1717

1818
Copy the connection string to use later.

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

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ ms.custom: devx-track-azurecli
99

1010
## Azure CLI setup for local development
1111

12-
Follow these steps to set up the Azure CLI and your project environment.
12+
Follow these steps to set up Azure CLI and your project environment.
13+
14+
1. Open a command shell.
1315

1416
1. Upgrade to the latest version of the Azure CLI.
1517

@@ -23,14 +25,9 @@ Follow these steps to set up the Azure CLI and your project environment.
2325
az extension add --name webpubsub
2426
```
2527
26-
1. Sign in to the Azure CLI. Following the prompts, enter your Azure credentials.
28+
1. Sign in to Azure CLI. Following the prompts, enter your Azure credentials.
2729
2830
```azurecli
2931
az login
3032
```
3133
32-
1. Create a resource group.
33-
34-
```azurecli
35-
az group create --name myResourceGroup --location eastus
36-
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ ms.date: 08/06/2021
66
ms.author: lianwei
77
---
88

9-
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.
9+
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.
1010

1111
```azurecli
12-
az group create --name "myResourceGroup" -l "EastUS"
12+
az group create --name myResourceGroup --location EastUS
1313
```

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ In this tutorial, you learn how to:
2222
2323
[!INCLUDE [azure-web-pubsub-tutorial-prerequisites](includes/cli-awps-prerequisites.md)]
2424

25-
>[!NOTE]
26-
> You can use the Windows cmd.exe command shell instead of a bash shell to run the commands in this tutorial.
25+
You can use the Windows cmd.exe command shell instead of a Bash shell to run the commands in this tutorial.
2726

2827
If creating the project on a local machine, you'll need to install the dependencies for the language you're using:
2928

@@ -46,7 +45,7 @@ If creating the project on a local machine, you'll need to install the dependenc
4645

4746
---
4847

49-
## Setup
48+
## Prepare your environment
5049

5150
# [Local Azure CLI](#tab/LocalBash)
5251

@@ -58,7 +57,7 @@ If creating the project on a local machine, you'll need to install the dependenc
5857

5958
---
6059

61-
### Create a resource group
60+
## Create a resource group
6261

6362
[!INCLUDE [Create a resource group](includes/cli-rg-creation.md)]
6463

@@ -69,18 +68,17 @@ If creating the project on a local machine, you'll need to install the dependenc
6968

7069
### Create a Web PubSub instance
7170

72-
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*:
71+
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`:
7372

74-
> [!Important]
75-
> Each Web PubSub resource must have a unique name. Replace &lt;your-unique-resource-name&gt; with the name of your Web PubSub instance in the following command.
73+
Each Web PubSub resource must have a unique name. Replace &lt;your-unique-resource-name&gt; with the name of your Web PubSub instance in the following command.
7674

7775
```azurecli
78-
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
76+
az webpubsub create --resource-group myResourceGroup --name <your-unique-resource-name> --location EastUS --sku Free_F1
7977
```
8078

8179
The output of this command shows properties of the newly created resource. Take note of the two properties listed below:
8280

83-
* **Resource Name**: The name you provided to the `--name` parameter above.
81+
* **name**: The Web PubSub name you provided in the `--name` parameter above.
8482
* **hostName**: In the example, the host name is `<your-unique-resource-name>.webpubsub.azure.com/`.
8583

8684
At this point, your Azure account is the only one authorized to perform any operations on this new resource.
@@ -97,7 +95,7 @@ Clients connect to the Azure Web PubSub service through the standard WebSocket p
9795

9896
1. First, create a project directory named `subscriber` for this project and install required dependencies:
9997

100-
* 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.
98+
* 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.
10199
* The SDK package `Azure.Messaging.WebPubSub` helps to generate the JWT token.
102100

103101
```console

0 commit comments

Comments
 (0)