快速入門：從 CLI 連線到 Azure Web PubSub 執行個體
本快速入門說明如何使用 Azure CLI 連線到 Azure Web PubSub 執行個體，並將訊息發佈至連線的用戶端。
如果您沒有 Azure 訂閱，請在開始之前，先建立 Azure 免費帳戶。
必要條件
在 Azure Cloud Shell 中使用 Bash 環境。 如需詳細資訊，請參閱 Azure Cloud Shell 中的 Bash 快速入門。
若要在本地執行 CLI 參考命令，請安裝 Azure CLI。 若您在 Windows 或 macOS 上執行，請考慮在 Docker 容器中執行 Azure CLI。 如需詳細資訊，請參閱〈如何在 Docker 容器中執行 Azure CLI〉。
如果您使用的是本機安裝，請使用 az login 命令，透過 Azure CLI 來登入。 請遵循您終端機上顯示的步驟，完成驗證程序。 如需其他登入選項，請參閱使用 Azure CLI 登入。
出現提示時，請在第一次使用時安裝 Azure CLI 延伸模組。 如需擴充功能詳細資訊，請參閱使用 Azure CLI 擴充功能。
執行 az version 以尋找已安裝的版本和相依程式庫。 若要升級至最新版本，請執行 az upgrade。
- 本快速入門需要 2.22.0 版或更新版本的 Azure CLI。 如果您是使用 Azure Cloud Shell，就已安裝最新版本。
建立資源群組
資源群組是在其中部署與管理 Azure 資源的邏輯容器。 使用 az group create 命令，在 eastus 位置建立名為 myResourceGroup 的資源群組。
az group create --name myResourceGroup --location EastUS
建立 Web PubSub 執行個體
執行 az extension add 以將 webpubsub 延伸模組安裝或升級至目前版本。
az extension add --upgrade --name webpubsub
使用 Azure CLI az webpubsub create 命令，在您所建立的資源群組中建立 Web PubSub。 下列命令會在 EastUS 中資源群組 myResourceGroup 下建立免費 Web PubSub 資源：
重要
每項 Web PubSub 資源都必須有唯一的名稱。 在下列範例中，將 <your-unique-resource-name> 取代為您的 Web PubSub 名稱。
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
此命令的輸出顯示新建立資源的屬性。 請記下下列兩個屬性：
- 資源名稱：您提供給上述
--name參數的名稱。 - hostName：在此範例中，主機名稱是
<your-unique-resource-name>.webpubsub.azure.com/。
此時，您的 Azure 帳戶是唯一獲得授權在此新資源上執行任何作業的帳戶。
使用執行個體
連接至服務
使用 Azure CLI az webpubsub client 命令來啟動與上一個步驟所建立服務的 WebSocket 用戶端連線，並提供下列資訊：
- 中樞名稱：1 到 127 個字元的字串。 其開頭必須是字母字元
(a-z, A-Z)，且只能包含英數(0-9, a-z, A-Z)字元或底線(_)。
中樞是連線的 WebSocket 連線邏輯集合。 如需概念的詳細資訊，請參閱關於中樞、群組和連線。
重要
將 <your-unique-resource-name> 取代為從先前步驟建立的 Web PubSub 資源名稱。
- 中樞名稱：myHub1。
- 資源群組名稱：myResourceGroup。
- 使用者識別碼：user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
您可以看到命令已建立 Web PubSub 服務的 WebSocket 連線，而且您收到 JSON 訊息，指出其現在已成功連線並獲派唯一的 connectionId：
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
加以探索並嘗試使用 joingroup <group-name> 加入群組，並使用 sendtogroup <group-name> 將訊息傳送至群組：
joingroup group1
sendtogroup group1 hello
發佈訊息及管理用戶端
Azure CLI 也提供 az webpubsub service 命令來管理用戶端連線。
開啟另一個 CLI 命令，您可以將訊息廣播給用戶端：
- 中樞名稱：myHub1。
- 資源群組名稱：myResourceGroup。
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
切換回先前的 CLI 命令，您可以看到用戶端收到訊息：
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
您也可以使用 --help 選項列出所有可用的命令，並使用所列出的命令。
az webpubsub service --help
下一步
本快速入門提供如何連線至 Web PubSub 服務，以及如何將訊息發佈至已連線用戶端的基本概念。
在真實世界的應用程式中，您可以使用各種語言的 SDK 來建置您自己的應用程式。 我們也提供函式延伸模組，讓您輕鬆地建置無伺服器應用程式。
使用這些資源開始建置您自己的應用程式：
意見反映
即將推出：我們會在 2024 年淘汰 GitHub 問題，並以全新的意見反應系統取代並作為內容意見反應的渠道。 如需更多資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交及檢視以下的意見反映：