クイックスタート: ARM テンプレートを使用して Azure SignalR Service をデプロイする

[アーティクル]
02/11/2024

このクイックスタートでは、Azure Resource Manager (ARM) テンプレートを使用して Azure SignalR Service を作成するプロセスについて説明します。 Azure SignalR Service は、Azure portal、PowerShell、CLI のいずれかを使用してデプロイできます。

Azure Resource Manager テンプレートは JavaScript Object Notation (JSON) ファイルであり、プロジェクトのインフラストラクチャと構成が定義されています。このテンプレートでは、宣言型の構文が使用されています。デプロイしようとしているものを、デプロイを作成する一連のプログラミングコマンドを記述しなくても記述できます。

環境が前提条件を満たしていて、ARM テンプレートの使用に慣れている場合は、 [Azure へのデプロイ] ボタンを選択します。サインインすると、Azure portal でテンプレートが開きます。

前提条件

アクティブなサブスクリプションが含まれる Azure アカウント。無料で作成できます。

テンプレートを確認する

このクイックスタートで使用されるテンプレートは Azure クイックスタートテンプレートからのものです。

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "metadata": {
    "_generator": {
      "name": "bicep",
      "version": "0.9.1.41621",
      "templateHash": "7185938028783900711"
    }
  },
  "parameters": {
    "name": {
      "type": "string",
      "defaultValue": "[uniqueString(resourceGroup().id)]",
      "metadata": {
        "description": "The globally unique name of the SignalR resource to create."
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for the SignalR resource."
      }
    },
    "pricingTier": {
      "type": "string",
      "defaultValue": "Standard_S1",
      "allowedValues": [
        "Free_F1",
        "Standard_S1",
        "Premium_P1"
      ],
      "metadata": {
        "description": "The pricing tier of the SignalR resource."
      }
    },
    "capacity": {
      "type": "int",
      "defaultValue": 1,
      "allowedValues": [
        1,
        2,
        5,
        10,
        20,
        50,
        100
      ],
      "metadata": {
        "description": "The number of SignalR Unit."
      }
    },
    "serviceMode": {
      "type": "string",
      "defaultValue": "Default",
      "allowedValues": [
        "Default",
        "Serverless",
        "Classic"
      ],
      "metadata": {
        "description": "Visit https://github.com/Azure/azure-signalr/blob/dev/docs/faq.md#service-mode to understand SignalR Service Mode."
      }
    },
    "enableConnectivityLogs": {
      "type": "bool",
      "defaultValue": true
    },
    "enableMessagingLogs": {
      "type": "bool",
      "defaultValue": true
    },
    "enableLiveTrace": {
      "type": "bool",
      "defaultValue": true
    },
    "allowedOrigins": {
      "type": "array",
      "defaultValue": [
        "*"
      ],
      "metadata": {
        "description": "Set the list of origins that should be allowed to make cross-origin calls."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.SignalRService/signalR",
      "apiVersion": "2022-02-01",
      "name": "[parameters('name')]",
      "location": "[parameters('location')]",
      "sku": {
        "capacity": "[parameters('capacity')]",
        "name": "[parameters('pricingTier')]"
      },
      "kind": "SignalR",
      "identity": {
        "type": "SystemAssigned"
      },
      "properties": {
        "tls": {
          "clientCertEnabled": false
        },
        "features": [
          {
            "flag": "ServiceMode",
            "value": "[parameters('serviceMode')]"
          },
          {
            "flag": "EnableConnectivityLogs",
            "value": "[string(parameters('enableConnectivityLogs'))]"
          },
          {
            "flag": "EnableMessagingLogs",
            "value": "[string(parameters('enableMessagingLogs'))]"
          },
          {
            "flag": "EnableLiveTrace",
            "value": "[string(parameters('enableLiveTrace'))]"
          }
        ],
        "cors": {
          "allowedOrigins": "[parameters('allowedOrigins')]"
        },
        "networkACLs": {
          "defaultAction": "Deny",
          "publicNetwork": {
            "allow": [
              "ClientConnection"
            ]
          },
          "privateEndpoints": [
            {
              "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e",
              "allow": [
                "ServerConnection"
              ]
            }
          ]
        },
        "upstream": {
          "templates": [
            {
              "categoryPattern": "*",
              "eventPattern": "connect,disconnect",
              "hubPattern": "*",
              "urlTemplate": "https://example.com/chat/api/connect"
            }
          ]
        }
      }
    }
  ]
}

このテンプレートには、次の Azure リソースが 1 つ定義されています。

Microsoft.SignalRService/SignalR

テンプレートのデプロイ

ARM テンプレートを使用して Azure SignalR Service をデプロイするには、Azure portal で次のリンクを選択します。

[Deploy an Azure SignalR service](Azure SignalR Service のデプロイ) ページで、次の手順を実行します。

[サブスクリプション] が既定値になっているので、必要に応じて変更します。
[リソースグループ] の [新規作成] を選択し、新しいリソースグループの名前を入力し、 [OK] を選択します。
新しいリソースグループを作成した場合は、リソースグループのリージョンを選択します。
必要に応じて、Azure SignalR Service の新しい [名前] と [場所] (例: eastus2) を入力します。 [名前] を指定しない場合は、自動的に生成されます。 [場所] は、リソースグループのリージョンと同じでも異なっていてもかまいません。 [場所] を指定しない場合、既定では、リソースグループと同じリージョンになります。
[価格レベル] ( [Free_F1] または [Standard_S1] ) を選択し、 [Capacity](キャパシティ) (SignalR ユニットの数) を入力します。 [サービスモード] として、 [既定] (ハブサーバーが必要)、 [サーバーレス] (サーバー接続を許可しない)、 [クラシック] (ハブにサーバー接続がある場合にのみハブサーバーにルーティング) のいずれかを選択してください。次に、[接続ログを有効にする] または [メッセージングログを有効にする] を選択します。

Note

[Free_F1] 価格レベルの場合、容量は 1 ユニットに制限されます。
[Review + create](レビュー + 作成) を選択します。
利用規約を読んで、 [作成] を選択します。

Note

PowerShell スクリプトをローカルで実行したい場合は、まず「Connect-AzAccount」と入力して Azure の資格情報を設定してください。

ARM テンプレートを使用して Azure SignalR Service をデプロイするには、以下のコードを使用します。次の項目を入力するよう求められます。

新しい Azure SignalR Service の名前とリージョン
新しいリソースグループの名前とリージョン
Azure の価格レベル (Free_F1 または Standard_S1)
SignalR ユニット容量 (1、2、5、10、20、50、100)

Note

[Free_F1] 価格レベルの場合、容量は 1 ユニットに制限されます。
サービスモード: ハブサーバーを必要とする場合は Default、サーバー接続を一切許可しない場合は Serverless、ハブにサーバー接続がある場合にのみハブサーバーにルーティングする場合は Classic
接続またはメッセージングのログを有効にするかどうか (true または false)

$serviceName = Read-Host -Prompt "Enter a name for the new Azure SignalR Service"
$serviceLocation = Read-Host -Prompt "Enter an Azure region (for example, westus2) for the service"
$resourceGroupName = Read-Host -Prompt "Enter a name for the new resource group to contain the service"
$resourceGroupRegion = Read-Host -Prompt "Enter an Azure region (for example, centralus) for the resource group"

$priceTier = Read-Host -Prompt "Enter the pricing tier (Free_F1 or Standard_S1)"
$unitCapacity = Read-Host -Prompt "Enter the number of SignalR units (1, 2, 5, 10, 20, 50, or 100)"
$servicingMode = Read-Host -Prompt "Enter the service mode (Default, Serverless, or Classic)"
$enableConnectionLogs = Read-Host -Prompt "Specify whether to enable connectivity logs (true or false)"
$enableMessageLogs = Read-Host -Prompt "Specify whether to enable messaging logs (true or false)"

Write-Verbose "New-AzResourceGroup -Name $resourceGroupName -Location $resourceGroupRegion" -Verbose
New-AzResourceGroup -Name $resourceGroupName -Location $resourceGroupRegion

$paramObjHashTable = @{
    name = $serviceName
    location = $serviceLocation
    pricingTier = $priceTier
    capacity = [int]$unitCapacity
    serviceMode = $servicingMode
    enableConnectivityLogs = $enableConnectionLogs
    enableMessagingLogs = $enableMessageLogs
}

Write-Verbose "Run New-AzResourceGroupDeployment to create an Azure SignalR Service using an ARM template" -Verbose
New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName `
    -TemplateParameterObject $paramObjHashTable `
    -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.signalrservice/signalr/azuredeploy.json
Read-Host "Press [ENTER] to continue"

ARM テンプレートを使用して Azure SignalR Service をデプロイするには、以下のコードを使用します。次の項目を入力するよう求められます。

新しい Azure SignalR Service の名前とリージョン
新しいリソースグループの名前とリージョン
Azure の価格レベル (Free_F1 または Standard_S1)
SignalR ユニット容量 (1、2、5、10、20、50、100)

Note

[Free_F1] 価格レベルの場合、容量は 1 ユニットに制限されます。
サービスモード: ハブサーバーを必要とする場合は Default、サーバー接続を一切許可しない場合は Serverless、ハブにサーバー接続がある場合にのみハブサーバーにルーティングする場合は Classic
接続またはメッセージングのログを有効にするかどうか (true または false)

read -p "Enter a name for the new Azure SignalR Service: " serviceName &&
read -p "Enter an Azure region (for example, westus2) for the service: " serviceLocation &&
read -p "Enter a name for the new resource group to contain the service: " resourceGroupName &&
read -p "Enter an Azure region (for example, centralus) for the resource group: " resourceGroupRegion &&
read -p "Enter the pricing tier (Free_F1 or Standard_S1): " priceTier &&
read -p "Enter the number of SignalR units (1, 2, 5, 10, 20, 50, or 100): " unitCapacity &&
read -p "Enter the service mode (Default, Serverless, or Classic): " servicingMode &&
read -p "Specify whether to enable connectivity logs (true or false): " enableConnectionLogs &&
read -p "Specify whether to enable messaging logs (true or false): " enableMessageLogs &&
params='name='$serviceName' location='$serviceLocation' pricingTier='$priceTier' capacity='$unitCapacity' serviceMode='$servicingMode' enableConnectivityLogs='$enableConnectionLogs' enableMessagingLogs='$enableMessageLogs &&
echo "CREATE RESOURCE GROUP:  az group create --name $resourceGroupName --location $resourceGroupRegion" &&
az group create --name $resourceGroupName --location $resourceGroupRegion &&
echo "RUN az deployment group create, which creates an Azure SignalR Service using an ARM template" &&
az deployment group create --resource-group $resourceGroupName --parameters $params --template-uri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.signalrservice/signalr/azuredeploy.json &&
read -p "Press [ENTER] to continue: "

Note

デプロイが完了するまでに数分かかる場合があります。 Azure SignalR Service の名前とリソースグループの名前は書き留めておいてください。デプロイしたリソースを後で確認する際に使用します。

デプロイされているリソースを確認する

新しい Azure SignalR Service の概要を確認するには、次の手順に従います。

Azure portal で、SignalR を検索して選択します。
SignalR の一覧から新しいサービスを選択します。新しい Azure SignalR Service の [概要] ページが表示されます。

Azure SignalR Service の詳細を確認するには、以下の対話型コードを実行します。新しいサービスの名前とリソースグループを入力する必要があります。

$serviceName = Read-Host -Prompt "Enter the name of your Azure SignalR Service"
$resourceGroupName = Read-Host -Prompt "Enter the resource group name"
Write-Verbose "Get-AzSignalR -ResourceGroupName $resourceGroupName -Name $serviceName" -Verbose
Get-AzSignalR -ResourceGroupName $resourceGroupName -Name $serviceName
Read-Host "Press [ENTER] to continue"

Azure SignalR Service の詳細を確認するには、以下の対話型コードを実行します。新しいサービスの名前とリソースグループを入力する必要があります。

read -p "Enter the name of your Azure SignalR Service: " serviceName &&
read -p "Enter the resource group name: " resourceGroupName &&
echo "SHOW SERVICE DETAILS:  az signalr show --resource-group $resourceGroupName --name $serviceName" &&
az signalr show --resource-group $resourceGroupName --name $serviceName &&
read -p "Press [ENTER] to continue: "

リソースをクリーンアップする

不要になったら、リソースグループを削除してください。リソースグループを削除すれば、リソースグループ内のリソースが削除されます。

Azure portal で、 [リソースグループ] を検索して選択します。
リソースグループの一覧で、リソースグループの名前を選択します。
リソースグループの [概要] ページで、 [リソースグループの削除] を選択します。
確認のダイアログボックスでリソースグループの名前を入力し、 [削除] を選択します。

$resourceGroupName = Read-Host -Prompt "Enter the name of the resource group to delete"
Write-Verbose "Remove-AzResourceGroup -Name $resourceGroupName" -Verbose
Remove-AzResourceGroup -Name $resourceGroupName
Read-Host "Press [ENTER] to continue"

read -p "Enter the name of the resource group to delete: " resourceGroupName &&
echo "DELETE A RESOURCE GROUP (AND ITS RESOURCES):  az group delete --name $resourceGroupName" &&
az group delete --name $resourceGroupName &&
read -p "Press [ENTER] to continue: "

次のステップ

Resource Manager テンプレートの作成手順について説明したチュートリアルについては、次のページを参照してください。

初めての ARM テンプレートを作成してデプロイする[

次の方法で共有