ARM テンプレートを Azure Pipelines と統合する

2025-04-30

継続的インテグレーションと継続的デプロイ (CI/CD) のために、Azure Resource Manager テンプレート (ARM テンプレート) を Azure Pipelines と統合できます。この記事では、Azure Pipelines を使用してテンプレートをデプロイする 2 つのより高度な方法について説明します。

オプションを選択する

この記事に進む前に、パイプラインから ARM テンプレートをデプロイするためのさまざまなオプションを検討しましょう。

ARM テンプレートのデプロイタスクを使用します。このオプションが最も簡単なオプションです。この方法は、リポジトリから直接テンプレートをデプロイする場合に機能します。このオプションについては、この記事では取り上げませんが、代わりに、ARM テンプレートと Azure Pipelines の継続的インテグレーションに関するチュートリアルで説明します。 ARM テンプレートデプロイタスクを使用して GitHub リポジトリからテンプレートをデプロイする方法を示します。
Azure PowerShell スクリプトを実行するタスクを追加します。このオプションには、ローカルテストの実行時に使用したのと同じスクリプトを使用できるため、開発ライフサイクル全体で一貫性を提供できるという利点があります。スクリプトはテンプレートをデプロイしますが、パラメーターとして使用する値の取得などの他の操作を実行することもできます。このオプションは、この記事に示されています。 Azure PowerShell タスクを参照してください。

Visual Studio には、PowerShell スクリプトを含む Azure リソースグループプロジェクトが用意されています。このスクリプトは、プロジェクトから Resource Manager がアクセスできるストレージアカウントに成果物をステージングします。成果物は、リンクされたテンプレート、スクリプト、アプリケーションバイナリなどのプロジェクト内の項目です。プロジェクトのスクリプトを引き続き使用する場合は、この記事に示す PowerShell スクリプトタスクを使用します。
タスクをコピーして展開するタスクを追加します。このオプションは、プロジェクトスクリプトの代わりに便利です。パイプラインで 2 つのタスクを構成します。 1 つのタスクは、成果物をアクセシビリティ対応の場所にステージングします。もう 1 つのタスクでは、その場所からテンプレートがデプロイされます。このオプションは、この記事に示されています。タスクのコピーとデプロイを参照してください。

プロジェクトを準備する

この記事では、ARM テンプレートと Azure DevOps 組織がパイプラインを作成する準備ができているものとします。次の手順は、準備ができていることを確認する方法を示しています。

Azure DevOps 組織があること。お持ちでない場合は、無料で作成してください。チームに既に Azure DevOps 組織がある場合は、使用する Azure DevOps プロジェクトの管理者であることを確認してください。
Azure サブスクリプションへのサービス接続を構成しました。パイプライン内のタスクは、サービスプリンシパルの ID で実行されます。接続を作成する手順については、「 DevOps プロジェクトの作成」を参照してください。
プロジェクトのインフラストラクチャを定義する ARM テンプレートがあります。

パイプラインの作成

以前にパイプラインを追加していない場合は、新しいパイプラインを作成する必要があります。 Azure DevOps 組織から、[ パイプライン ] と [ 新しいパイプライン] を選択します。
コードの格納場所を指定します。次の図は、 Azure Repos Git の選択を示しています。
そのソースから、プロジェクトのコードを含むリポジトリを選択します。
作成するパイプラインの種類を選択します。 スターターパイプラインを選択できます。

Azure PowerShell タスクまたはコピーファイルを追加してタスクをデプロイする準備ができました。

Azure PowerShell タスク

このセクションでは、プロジェクトで PowerShell スクリプトを実行する 1 つのタスクを使用して継続的配置を構成する方法について説明します。テンプレートをデプロイする PowerShell スクリプトが必要な場合は、 Deploy-AzTemplate.ps1 または Deploy-AzureResourceGroup.ps1に関するページを参照してください。

次の YAML ファイルは、Azure PowerShell タスクを作成します。

trigger:
- master

pool:
  vmImage: 'ubuntu-latest'

steps:
- task: AzurePowerShell@5
  inputs:
    azureSubscription: 'script-connection'
    ScriptType: 'FilePath'
    ScriptPath: './Deploy-AzTemplate.ps1'
    ScriptArguments: -Location 'centralus' -ResourceGroupName 'demogroup' -TemplateFile templates\mainTemplate.json
    azurePowerShellVersion: 'LatestVersion'

タスクを AzurePowerShell@5 に設定すると、パイプラインは Az モジュールを使用します。スクリプトで AzureRM モジュールを使用している場合は、タスクを AzurePowerShell@3 に設定します。

steps:
- task: AzurePowerShell@3

azureSubscriptionの場合は、作成したサービス接続の名前を指定します。

inputs:
    azureSubscription: '<your-connection-name>'

scriptPathの場合は、パイプラインファイルからスクリプトへの相対パスを指定します。リポジトリ内でパスを確認できます。

ScriptPath: '<your-relative-path>/<script-file-name>.ps1'

ScriptArgumentsで、スクリプトに必要なパラメーターを指定します。次の例は、スクリプトのパラメーターをいくつか示していますが、スクリプトのパラメーターをカスタマイズする必要があります。

ScriptArguments: -Location 'centralus' -ResourceGroupName 'demogroup' -TemplateFile templates\mainTemplate.json

[保存] を選択すると、ビルドパイプラインが自動的に実行されます。ビルドパイプラインの概要に戻り、状態を確認します。

Azure DevOps のパイプライン結果ビューのスクリーンショット

現在実行中のパイプラインを選択すると、タスクの詳細を確認できます。完了すると、各ステップの結果が表示されます。

タスクのコピーとデプロイ

このセクションでは、2 つのタスクを使用して継続的デプロイを構成する方法を示します。 1 つ目のタスクはストレージアカウントに成果物をステージングし、2 番目のタスクはテンプレートをデプロイします。

ストレージアカウントにファイルをコピーするには、サービス接続のサービスプリンシパルにストレージ BLOB データ共同作成者ロールまたはストレージ BLOB データ所有者ロールが割り当てられている必要があります。詳細については、「 AzCopy の概要」を参照してください。

次の YAML は、Azure ファイルコピータスクを示しています。

trigger:
- master

pool:
  vmImage: 'windows-latest'

steps:
- task: AzureFileCopy@4
  inputs:
    SourcePath: 'templates'
    azureSubscription: 'copy-connection'
    Destination: 'AzureBlob'
    storage: 'demostorage'
    ContainerName: 'projecttemplates'
  name: AzureFileCopy

このタスクには、環境に合わせて変更する部分がいくつかあります。 SourcePathは、パイプラインファイルを基準とした成果物の場所を示します。

SourcePath: '<path-to-artifacts>'

azureSubscriptionの場合は、作成したサービス接続の名前を指定します。

azureSubscription: '<your-connection-name>'

ストレージ名とコンテナー名には、アーティファクトの格納に使用するストレージアカウントとコンテナーの名前を指定します。ストレージアカウントが存在する必要があります。

storage: '<your-storage-account-name>'
ContainerName: '<container-name>'

ファイルのコピータスクを作成したら、ステージングされたテンプレートをデプロイするタスクを追加する準備ができました。

次の YAML は、 Azure Resource Manager テンプレートのデプロイタスクを示しています。

- task: AzureResourceManagerTemplateDeployment@3
  inputs:
    deploymentScope: 'Resource Group'
    azureResourceManagerConnection: 'copy-connection'
    subscriptionId: 'aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e'
    action: 'Create Or Update Resource Group'
    resourceGroupName: 'demogroup'
    ___location: 'West US'
    templateLocation: 'URL of the file'
    csmFileLink: '$(AzureFileCopy.StorageContainerUri)templates/mainTemplate.json$(AzureFileCopy.StorageContainerSasToken)'
    csmParametersFileLink: '$(AzureFileCopy.StorageContainerUri)templates/mainTemplate.parameters.json$(AzureFileCopy.StorageContainerSasToken)'
    deploymentMode: 'Incremental'
    deploymentName: 'deploy1'

このタスクには、さらに詳しく確認する部分がいくつかあります。

deploymentScope: Management Group、 Subscription、 Resource Groupのオプションからデプロイのスコープを選択します。スコープの詳細については、「デプロイスコープ」を参照してください。
azureResourceManagerConnection: 作成したサービス接続の名前を指定します。
subscriptionId: ターゲットサブスクリプション ID を指定します。このプロパティは、リソースグループのデプロイスコープとサブスクリプションのデプロイスコープにのみ適用されます。
resourceGroupName ___location: デプロイ先のリソースグループの名前と場所を指定します。存在しない場合、そのタスクがリソースグループを作成します。
```
resourceGroupName: '<resource-group-name>'
___location: '<___location>'
```
csmFileLink: ステージングされたテンプレートのリンクを指定します。値を設定するときは、ファイルコピータスクから返される変数を使用します。次の例では、mainTemplate.jsonという名前のテンプレートにリンクします。テンプレートという名前のフォルダーが含まれるのは、ファイルコピータスクがファイルのコピー先であるためです。パイプラインで、テンプレートへのパスとテンプレートの名前を指定します。
```
csmFileLink: '$(AzureFileCopy.StorageContainerUri)templates/mainTemplate.json$(AzureFileCopy.StorageContainerSasToken)'
```

パイプラインは次のようになります。

trigger:
- master

pool:
  vmImage: 'windows-latest'

steps:
- task: AzureFileCopy@4
  inputs:
    SourcePath: 'templates'
    azureSubscription: 'copy-connection'
    Destination: 'AzureBlob'
    storage: 'demostorage'
    ContainerName: 'projecttemplates'
  name: AzureFileCopy
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
    deploymentScope: 'Resource Group'
    azureResourceManagerConnection: 'copy-connection'
    subscriptionId: 'aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e'
    action: 'Create Or Update Resource Group'
    resourceGroupName: 'demogroup'
    ___location: 'West US'
    templateLocation: 'URL of the file'
    csmFileLink: '$(AzureFileCopy.StorageContainerUri)templates/mainTemplate.json$(AzureFileCopy.StorageContainerSasToken)'
    csmParametersFileLink: '$(AzureFileCopy.StorageContainerUri)templates/mainTemplate.parameters.json$(AzureFileCopy.StorageContainerSasToken)'
    deploymentMode: 'Incremental'
    deploymentName: 'deploy1'

[保存] を選択すると、ビルドパイプラインが自動的に実行されます。 [ ジョブ ] フレームで、[ ジョブ ] を選択してジョブの状態を確認します。

次のステップ

パイプラインで what-if 操作を使用するには、パイプライン内の What-If を使用して ARM テンプレートをテストする方法に関するページを参照してください。
GitHub Actions で ARM テンプレートを使用する方法については、「GitHub Actions を使用して Azure Resource Manager テンプレートをデプロイする」を参照してください。