Azure Resource Manager テンプレートを使用して Service Bus リソースを作成する

[アーティクル]
05/11/2023

この記事では、Azure Resource Manager テンプレート、PowerShell、Service Bus リソースプロバイダーを使用して Service Bus リソースを作成し、デプロイする方法について説明します。

Azure Resource Manager テンプレートを使用すると、ソリューションでデプロイするリソースを定義し、さまざまな環境用の値を入力できるパラメーターと変数を指定できます。テンプレートは JSON で記述され、デプロイの値の構築に使用できる式で構成されます。 Azure Resource Manager テンプレートの作成の詳細と、テンプレート形式の説明については、「structure and syntax of Azure Resource Manager templates」を参照してください。

Note

この記事の例では、Azure Resource Manager を使用して Service Bus の名前空間とメッセージングエンティティ (キュー) を作成する方法について説明します。他のテンプレート例については、「Azure クイックスタートテンプレート」ギャラリーで Service Bus を検索してください。

Note

Azure を操作するには、Azure Az PowerShell モジュールを使用することをお勧めします。作業を開始するには、Azure PowerShell のインストールに関する記事を参照してください。 Az PowerShell モジュールに移行する方法については、「AzureRM から Az への Azure PowerShell の移行」を参照してください。

Service Bus Resource Manager テンプレート

これらの Service Bus Azure Resource Manager テンプレートは、ダウンロードしてデプロイすることができます。次のリンクをクリックすると、それぞれの詳細情報と、GitHub のテンプレートを参照できます。

PowerShell でデプロイする

次の手順では、PowerShell を使用して、Azure Resource Manager テンプレートをデプロイします。標準レベルの Service Bus 名前空間と、名前空間内にキューが作成されます。この例は、キューを使用した Service Bus 名前空間の作成テンプレートに基づいています。ワークフローの概要は次のとおりです。

PowerShell をインストールします。
テンプレートと (必要に応じて) パラメーターファイルを作成します。
PowerShell で Azure アカウントにログインします。
リソースグループが存在しない場合は、新しいリソースグループを作成します。
デプロイをテストします。
必要に応じて、デプロイモードを設定します。
テンプレートをデプロイします。

Azure Resource Manager テンプレートのデプロイの詳細については、Azure Resource Manager テンプレートを使用したリソースのデプロイに関する記事をご覧ください。

PowerShell をインストールする

「Getting started with Azure PowerShell」の手順に従って、Azure PowerShell をインストールします。

テンプレートの作成

GitHub からリポジトリをクローンするか、servicebus-create-queue テンプレートをコピーします。

{
  "$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "serviceBusNamespaceName": {
      "type": "string",
      "metadata": {
        "description": "Name of the Service Bus namespace"
      }
    },
    "serviceBusQueueName": {
      "type": "string",
      "metadata": {
        "description": "Name of the Queue"
      }
    }
  },
  "variables": {
    "defaultSASKeyName": "RootManageSharedAccessKey",
    "authRuleResourceId": "[resourceId('Microsoft.ServiceBus/namespaces/authorizationRules', parameters('serviceBusNamespaceName'), variables('defaultSASKeyName'))]",
  "sbVersion": "2017-04-01"
  },
  "resources": [
    {
      "apiVersion": "2017-04-01",
      "name": "[parameters('serviceBusNamespaceName')]",
      "type": "Microsoft.ServiceBus/Namespaces",
      "location": "[resourceGroup().location]",
      "sku": {
        "name": "Standard"
      },
      "properties": {},
      "resources": [
        {
          "apiVersion": "2017-04-01",
          "name": "[parameters('serviceBusQueueName')]",
          "type": "Queues",
          "dependsOn": [
            "[concat('Microsoft.ServiceBus/namespaces/', parameters('serviceBusNamespaceName'))]"
          ],
          "properties": {
            "lockDuration": "PT5M",
            "maxSizeInMegabytes": "1024",
            "requiresDuplicateDetection": "false",
            "requiresSession": "false",
            "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
            "deadLetteringOnMessageExpiration": "false",
            "duplicateDetectionHistoryTimeWindow": "PT10M",
            "maxDeliveryCount": "10",
            "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
            "enablePartitioning": "false",
            "enableExpress": "false"
          }
        }
      ]
    }
  ],
  "outputs": {
    "NamespaceConnectionString": {
      "type": "string",
      "value": "[listkeys(variables('authRuleResourceId'), variables('sbVersion')).primaryConnectionString]"
    },
    "SharedAccessPolicyPrimaryKey": {
      "type": "string",
      "value": "[listkeys(variables('authRuleResourceId'), variables('sbVersion')).primaryKey]"
    }
  }
}

パラメーターファイルを作成する (省略可能)

省略可能なパラメーターファイルを使用するには、servicebus-create-queue ファイルをコピーします。 serviceBusNamespaceName の値を、このデプロイで作成する Service Bus 名前空間の名前で置き換えます。また、serviceBusQueueName の値を、作成するキューの名前で置き換えます。

{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "serviceBusNamespaceName": {
            "value": "<myNamespaceName>"
        },
        "serviceBusQueueName": {
            "value": "<myQueueName>"
        },
        "serviceBusApiVersion": {
            "value": "2017-04-01"
        }
    }
}

詳細については、「パラメーター」の記事を参照してください。

Azure にログインして Azure サブスクリプションを設定する

PowerShell プロンプトから、次のコマンドを実行します。

Connect-AzAccount

Azure アカウントにログオンするように求められます。ログオンしたら、次のコマンドを実行して、使用できるサブスクリプションを確認します。

Get-AzSubscription

このコマンドを実行すると、使用できる Azure サブスクリプションの一覧が返されます。現在のセッションのサブスクリプションを選択するには、次のコマンドを実行します。 <YourSubscriptionId> は、使用する Azure サブスクリプションの GUID に置き換えてください。

Set-AzContext -SubscriptionID <YourSubscriptionId>

リソースグループを設定する

既存のリソースグループがない場合は、New-AzResourceGroup コマンドで新しいリソースグループを作成します。使用するリソースグループの名前と場所を指定します。次に例を示します。

New-AzResourceGroup -Name MyDemoRG -Location "West US"

成功した場合、新しいリソースグループの概要が表示されます。

ResourceGroupName : MyDemoRG
Location          : westus
ProvisioningState : Succeeded
Tags              :
ResourceId        : /subscriptions/<GUID>/resourceGroups/MyDemoRG

展開をテスト

デプロイを検証するには、Test-AzResourceGroupDeployment コマンドレットを実行します。デプロイをテストする場合、デプロイの実行時と同様に、必要なパラメーターを正確に指定します。

Test-AzResourceGroupDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json

配置を作成する

新しいデプロイを作成するには、New-AzResourceGroupDeployment コマンドレットを実行し、プロンプトに従って必要なパラメーターを指定します。パラメーターには、デプロイの名前、リソースグループの名前、テンプレートファイルのパスまたは URL が含まれます。 Mode パラメーターを指定しない場合、Incremental の既定値が使用されます。詳細については、「増分デプロイと完全デプロイ」を参照してください。

次のコマンドを実行すると、PowerShell ウィンドウに 3 つのパラメーターを指定するように求められます。

New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json

代わりにパラメーターファイルを使用するには、次のコマンドを使用します。

New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -TemplateParameterFile <path to parameters file>\azuredeploy.parameters.json

また、デプロイコマンドレットを実行するときに、インラインパラメーターを使用することもできます。コマンドは次のとおりです。

New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -parameterName "parameterValue"

完全デプロイを実行するには、Mode パラメーターを Complete に設定します。

New-AzResourceGroupDeployment -Name MyDemoDeployment -Mode Complete -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json

デプロイを検証する

リソースが正常にデプロイされると、デプロイの概要が PowerShell ウィンドウに表示されます。

DeploymentName    : MyDemoDeployment
ResourceGroupName : MyDemoRG
ProvisioningState : Succeeded
Timestamp         : 4/19/2017 10:38:30 PM
Mode              : Incremental
TemplateLink      :
Parameters        :
                    Name             Type                       Value
                    ===============  =========================  ==========
                    serviceBusNamespaceName  String             <namespaceName>
                    serviceBusQueueName  String                 <queueName>
                    serviceBusApiVersion  String                2017-04-01

次のステップ

Azure Resource Manager テンプレートをデプロイする基本のワークフローとコマンドが表示されました。詳細については、次のリンクを参照してください。