Membuat sumber daya Service Bus menggunakan templat Azure Resource Manager

Artikel
05/11/2023

Artikel ini menjelaskan cara membuat dan menyebarkan sumber daya Service Bus menggunakan templat Azure Resource Manager, PowerShell, dan penyedia sumber daya Service Bus.

Templat Azure Resource Manager membantu Anda menentukan sumber daya untuk disebarkan untuk solusi, dan menentukan parameter dan variabel yang memungkinkan Anda memasukkan nilai untuk lingkungan yang berbeda. Templat ditulis di JSON dan terdiri dari ekspresi yang dapat Anda gunakan untuk membangun nilai untuk penyebaran Anda. Untuk informasi detail tentang menulis templat Azure Resource Manager, dan pembahasan tentang format templat, lihat struktur dan sintaks templat Azure Resource Manager.

Catatan

Contoh dalam artikel ini memperlihatkan cara menggunakan Azure Resource Manager untuk membuat namespace Bus Layanan dan entitas pesan (antrean). Untuk contoh templat lainnya, kunjungi galeri Templat Mulai Cepat Azure dan cari Service Bus.

Catatan

Sebaiknya Anda menggunakan modul Azure Az PowerShell untuk berinteraksi dengan Azure. Untuk memulai, lihat Menginstal Azure PowerShell. Untuk mempelajari cara bermigrasi ke modul Az PowerShell, lihat Memigrasikan Azure PowerShell dari AzureRM ke Az.

Templat Resource Manager Azure Service Bus

Templat Service Bus Azure Resource Manager ini tersedia untuk diunduh dan disebarkan. Klik tautan berikut untuk detail tentang masing-masing tautan, dengan tautan ke templat di GitHub:

Menyebarkan dengan PowerShell

Prosedur berikut ini menjelaskan cara menggunakan PowerShell untuk menyebarkan templat Azure Resource Manager yang membuat namespace Service Bus tingkat Standar, dan antrean di dalam namespace tersebut. Contoh ini didasarkan pada templat Membuat namespace Azure Service Bus dengan antrean. Perkiraan alur kerjanya adalah sebagai berikut:

Instal PowerShell.
Buat templat dan (opsional) file parameter.
Di PowerShell, masuk ke akun Azure Anda.
Buat grup sumber daya baru jika grup sumber daya tidak ada.
Uji penyebaran.
Jika diinginkan, atur mode penyebaran.
Menyebarkan templat .

Untuk informasi lengkap tentang menyebarkan templat Azure Resource Manager, lihat Menggunakan sumber daya dengan templat Azure Resource Manager.

Instal PowerShell

Pasang Azure PowerShell dengan mengikuti instruksi di Memulai menggunakan Azure PowerShell.

Membuat templat

Kloning repositori atau salin template servicebus-create-queue dari GitHub:

{
  "$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]"
    }
  }
}

Membuat file parameter (opsional)

Untuk menggunakan file parameter opsional, salin file servicebus-create-queue. Ganti nilai serviceBusNamespaceName dengan nama namespace Azure Service Bus yang ingin Anda buat dalam penyebaran ini, dan ganti nilai serviceBusQueueName dengan nama antrean yang ingin Anda buat.

{
    "$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"
        }
    }
}

Untuk informasi selengkapnya, lihat artikel Parameter.

Masuk ke Azure dan mengatur langganan Azure

Dari prompt PowerShell, jalankan perintah berikut ini:

Connect-AzAccount

Anda diminta untuk masuk ke akun Azure Anda. Setelah masuk, jalankan perintah berikut ini untuk menampilkan langganan yang tersedia:

Get-AzSubscription

Perintah ini mengembalikan daftar langganan Azure yang tersedia. Pilih langganan untuk sesi saat ini dengan menjalankan perintah berikut ini. Ganti <YourSubscriptionId> dengan GUID untuk langganan Azure yang ingin Anda gunakan:

Set-AzContext -SubscriptionID <YourSubscriptionId>

Mengatur grup sumber daya

Jika Anda tidak memiliki grup sumber daya yang ada, buat grup sumber daya baru dengan perintah New-AzResourceGroup. Sediakan nama grup sumber daya dan lokasi yang ingin Anda gunakan. Contohnya:

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

Jika berhasil, ringkasan grup sumber daya baru akan ditampilkan.

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

Menguji penyebarannya

Validasi penyebaran Anda dengan menjalankan cmdlet Test-AzResourceGroupDeployment. Saat menguji penyebaran, berikan parameter persis seperti yang Anda lakukan saat menjalankan penyebaran.

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

Membuat penyebaran

Untuk membuat penyebaran baru, jalankan cmdlet New-AzResourceGroupDeployment, dan berikan parameter yang diperlukan saat diminta. Parameter termasuk nama untuk penyebaran Anda, nama grup sumber daya Anda, dan jalur atau URL ke file templat. Jika parameter Mode tidak ditentukan, nilai default Bertahap akan digunakan. Untuk informasi selengkapnya, lihat Penyebaran bertahap dan lengkap.

Perintah berikut ini meminta Anda memasukkan tiga parameter di jendela PowerShell:

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

Untuk menentukan file parameter sebagai gantinya, gunakan perintah berikut:

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

Anda juga dapat menggunakan parameter sebaris saat menjalankan cmdlet penyebaran. Perintahnya adalah sebagai berikut:

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

Untuk menjalankan penyebaran lengkap, atur parameter Mode ke Selesai:

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

Verifikasi penyebaran

Jika sumber daya berhasil digunakan, ringkasan penyebaran ditampilkan di jendela 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

Langkah berikutnya

Sekarang Anda telah melihat alur kerja dan perintah dasar untuk menyebarkan templat Azure Resource Manager. Untuk informasi selengkapnya, kunjungi tautan berikut:

Bagikan melalui