建立 Web PubSub 資源

發行項
04/11/2024

必要條件

具有有效訂用帳戶的 Azure 帳戶。建立免費 Azure 帳戶 (如果沒有的話)。

提示

Web PubSub 包含慷慨的免費層，可用於測試和生產用途。

從 Azure 入口網站建立資源

選取 Azure 入口網站左上角的 [新增] 按鈕。在 [新增] 畫面的搜尋方塊中輸入 Web PubSub 然後按 Enter。
從搜尋結果中選取 [Web PubSub]，然後選取 [建立]。

輸入下列設定。

設定	建議的值	描述
資源名稱	全域唯一的名稱	識別新 Web PubSub 服務執行個體的全域唯一名稱。有效字元：`a-z`、`A-Z`、`0-9` 和 `-`。
訂用帳戶	您的訂用帳戶	將在其下建立這個新 Web PubSub 服務執行個體的 Azure 訂用帳戶。
[資源群組]	myResourceGroup	要在其中建立 Web PubSub 服務執行個體之新資源群組的名稱。
地點	美國西部	選擇您附近的區域。
定價層	免費	您可以先免費試用 Azure Web PubSub 服務。深入了解 Azure Web PubSub 服務定價層
單位計數	-	單位計數會指出您的 Web PubSub 服務執行個體可接受的連線數目。每個單位支援最多 1,000 個同時連線。它只能在標準層中設定。

在入口網站中建立 Azure Web PubSub 實例的螢幕快照。

選取 [建立]，以佈建您的 Web PubSub 資源。

使用 Azure CLI 建立資源

Azure CLI 是一組用來建立和管理 Azure 資源的文字型命令。 Azure CLI 適用於 Azure 服務，其設計目的是為了讓您能夠快速使用 Azure，並強調自動化。

重要

本快速入門需要 2.22.0 版或更高版本的 Azure CLI。

建立資源群組

資源群組是在其中部署與管理 Azure 資源的邏輯容器。使用 az group create 命令，在 eastus 位置建立名為 myResourceGroup 的資源群組。

az group create --name myResourceGroup --location EastUS

建立資源

執行 az extension add 以將 webpubsub 延伸模組安裝或升級至目前版本。

az extension add --upgrade --name webpubsub

使用 Azure CLI az webpubsub create 命令，在您已建立的資源群組中建立 Web PubSub。下列命令會在 EastUS 的資源群組 myResourceGroup 下建立免費 Web PubSub 資源：

重要

每個 Web PubSub 資源都必須有唯一的名稱。使用下列範例中的 Web PubSub 名稱取代 <your-unique-resource-name>。

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 帳戶是唯一獲得授權在此新資源上執行任何作業的帳戶。

使用 Bicep 範本建立資源

Bicep 是使用宣告式語法來部署 Azure 資源的特定領域語言 (DSL)。其提供簡潔的語法、可靠的類型安全，並支援程式碼重複使用。 Bicep 能夠為您在 Azure 中的基礎結構即程式碼解決方案，提供最佳的製作體驗。

檢閱 Bicep 檔案

本快速入門中使用的範本是來自 Azure 快速入門範本。

/* This Bicep file deploys a new instance of Azure Web PubSub service. */

// Parameters

@description('The name for your new Web PubSub instance.')
@maxLength(63)
@minLength(3)
param wpsName string = uniqueString(resourceGroup().id)

@description('The region in which to create the new instance, defaults to the same location as the resource group.')
param location string = resourceGroup().location

@description('Unit count')
@allowed([
  1
  2
  5
  10
  20
  50
  100
])
param unitCount int = 1

@description('SKU name')
@allowed([
  'Standard_S1'
  'Free_F1'
])
param sku string = 'Free_F1'

@description('Pricing tier')
@allowed([
  'Free'
  'Standard'
])
param pricingTier string = 'Free'

// Resource definition
resource webpubsub 'Microsoft.SignalRService/webPubSub@2021-10-01' = {
  name: wpsName
  location: location
  sku: {
    capacity: unitCount
    name: sku
    tier: pricingTier
  }
  identity: {
    type: 'None'
  }
  properties: {
    disableAadAuth: false
    disableLocalAuth: false
    liveTraceConfiguration: {
      categories: [
        {
          enabled: 'false'
          name: 'ConnectivityLogs'
        }
        {
          enabled: 'false'
          name: 'MessagingLogs'
        }
      ]
      enabled: 'false'
    }
    networkACLs: {
      defaultAction: 'Deny'     
      publicNetwork: {
        allow: [
          'ServerConnection'
          'ClientConnection'
          'RESTAPI'
          'Trace'
        ]
      }
    }
    publicNetworkAccess: 'Enabled'
    resourceLogConfiguration: {
      categories: [
        {
          enabled: 'true'
          name: 'ConnectivityLogs'
        }
        {
          enabled: 'true'
          name: 'MessagingLogs'
        }
      ]
    }
    tls: {
      clientCertEnabled: false
    }
  }
}

部署 Bicep 檔案

將 Bicep 檔案以 main.bicep 儲存至本機電腦。

使用 Azure CLI 或 Azure PowerShell 部署 Bicep 檔案。

CLI
PowerShell

az group create --name exampleRG --location eastus
az deployment group create --resource-group exampleRG --template-file main.bicep

New-AzResourceGroup -Name exampleRG -Location eastus
New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./main.bicep

當部署完成時，您應該會看到指出部署成功的訊息。

檢閱已部署的資源

使用 Azure 入口網站、Azure CLI 或 Azure PowerShell 來列出資源群組中已部署的資源。

CLI
PowerShell

az resource list --resource-group exampleRG

Get-AzResource -ResourceGroupName exampleRG

清除資源

不再需要時，請使用 Azure 入口網站、Azure CLI 或 Azure PowerShell 來刪除資源群組及其資源。

CLI
PowerShell

az group delete --name exampleRG

Remove-AzResourceGroup -Name exampleRG

後續步驟

既然您已建立資源，您就可以開始使用它。接下來，您將了解如何在用戶端之間訂閱和發佈訊息。

在用戶端之間 PubSub

共用方式為