Azure CLIで Azure Resource Manager (ARM) デプロイテンプレートを使用する方法

この記事では、Azure Resource Manager テンプレート (ARM テンプレート) でAzure CLIを使用して、リソースをAzureにデプロイする方法について説明します。 Azure ソリューションのデプロイと管理の概念に慣れていない場合は、template デプロイの概要を参照してください。

デプロイコマンドは、Azure CLI バージョン 2.2.0 で変更されました。この記事の例では、Azure CLI バージョン 2.20.0 以降が必要です。

このサンプルを実行するには、Azure CLIの最新バージョンをインストールします。開始するには、az login を実行して、Azureとの接続を作成します。

Azure CLIのサンプルは、bash シェル用に記述されています。 PowerShell またはコマンドプロンプトWindowsでこのサンプルを実行するには、スクリプトの要素を変更する必要がある場合があります。

Azure CLIがインストールされていない場合は、Azure Cloud Shellを使用できます。詳細については、「deploy ARM templates from Azure Cloud Shell」を参照してください。

ヒント

Bicep は ARM テンプレートと同じ機能を提供し、構文の方が使いやすいためです。詳細については、「 Bicep と Azure CLIを参照してください。

[前提条件]

必要なアクセス許可

Bicep ファイルまたは Azure Resource Manager (ARM) テンプレートをデプロイするには、デプロイするリソースに対する書き込みアクセス権と、Microsoft.Resources/deployments リソースの種類に対するすべての操作へのアクセス権が必要です。たとえば、仮想マシンをデプロイするには、Microsoft.Compute/virtualMachines/write と Microsoft.Resources/deployments/* アクセス許可が必要です。 What-If 操作のアクセス許可要件も同じです。

Azure CLIバージョン 2.76.0 以降 および Azure PowerShell バージョン 13.4.0 以降では、このプロセス中に ARM がBicep テンプレートをどの程度徹底的に検証するかを判断する ValidationLevel スイッチが導入されています。詳細については、「What-if コマンド」を参照してください。

ロールとアクセス許可の一覧については、「Azure組み込みロールを参照してください。

配備の範囲

Azureデプロイテンプレートは、リソースグループ、サブスクリプション、管理グループ、またはテナントを対象にすることができます。使用するコマンドは、デプロイのスコープに応じて異なります。

リソースグループにデプロイするには、az deployment group create を使用します。

az deployment group create --resource-group <resource-group-name> --template-file <path-to-template>

サブスクリプションにデプロイするには、az deployment sub create を使用します。
```
az deployment sub create --location <location> --template-file <path-to-template>
```
サブスクリプションレベルのデプロイの詳細については、「サブスクリプションレベルでのリソースグループとリソースの作成」を参照してください。
管理グループにデプロイするには、az deployment mg create を使用します。
```
az deployment mg create --location <location> --template-file <path-to-template>
```
管理グループレベルのデプロイの詳細については、「管理グループレベルでのリソースの作成」を参照してください。
テナントにデプロイするには、az deployment tenant create を使用します。
```
az deployment tenant create --location <location> --template-file <path-to-template>
```
テナントレベルのデプロイの詳細については、「テナントレベルでのリソースの作成」を参照してください。

各スコープに対して、テンプレートをデプロイするユーザーにはリソースを作成するためのアクセス許可が必要です。

ローカルテンプレートのデプロイ

ローカルコンピューターからの ARM テンプレートまたは外部に格納されているものをデプロイできます。ここでは、ローカルテンプレートのデプロイについて説明します。

存在しないリソースグループにデプロイする場合、リソースグループを作成する必要があります。リソースグループ名には、英数字、ピリオド、アンダースコア、ハイフン、かっこのみを含めることができます。最大長は 90 文字です。名前の末尾をピリオドにすることはできません。

az group create --name ExampleGroup --location "Central US"

ローカルテンプレートをデプロイするには、デプロイコマンドで --template-file パラメーターを使用します。次の例では、パラメーター値を設定する方法も示しています。

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file <path-to-template> \
  --parameters storageAccountType=Standard_GRS

--template-file パラメーターの値は、Bicep ファイルまたは .json または .jsonc ファイルである必要があります。ファイル拡張子が .jsonc であれば、ファイルに // スタイルコメントを含めることができます。 ARM システムは、// ファイルで .json コメントを受け入れます。ファイル拡張子の違いによって影響は受けません。コメントとメタデータの詳細については、「 ARM テンプレートの構造と構文を理解する」を参照してください。

Azureデプロイテンプレートの完了には数分かかる場合があります。デプロイが完了すると、次のような結果を含むメッセージが表示されます。

"provisioningState": "Succeeded",

リモートテンプレートのデプロイ

ARM テンプレートをローカルコンピューターに格納する代わりに、外部の場所に格納することもできます。テンプレートは、ソース管理リポジトリ (GitHub など) に格納できます。または、組織内の共有アクセス用のAzure ストレージアカウントに格納することもできます。

注

プライベート GitHub リポジトリに格納されているテンプレートをデプロイするか、リンクされたテンプレートを参照するには、カスタムおよびセキュリティで保護されたAzure portalオファリングの作成に記載されているカスタムソリューションを参照してください。 Azure Key VaultからGitHubトークンをプルするAzure関数を作成できます。

az group create --name ExampleGroup --location "Central US"

外部テンプレートをデプロイするには、template-uri パラメーターを使用します。

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-uri "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json" \
  --parameters storageAccountType=Standard_GRS

前の例では、テンプレートにはパブリックにアクセスできる URI が必要になります。テンプレートに機密データを含めてはいけないため、この方法は多くの場合に利用できます。機密データ (管理者パスワードなど) を指定する必要がある場合は、セキュリティで保護されたパラメーターとしてその値を渡します。ただし、テンプレートへのアクセスを管理する場合は、テンプレートスペックの使用を検討してください。

離れた場所にあり、リンクされているテンプレートを、ストレージアカウントに格納されている相対パスでデプロイするには、query-string を使用して SAS トークンを指定します。

az deployment group create \
  --name linkedTemplateWithRelativePath \
  --resource-group myResourceGroup \
  --template-uri "https://stage20210126.blob.core.windows.net/template-staging/mainTemplate.json" \
  --query-string $sasToken

詳細については、「リンクされたテンプレートの相対パスを使用する」を参照してください。

Azure デプロイテンプレート名

ARM テンプレートをデプロイするときに、Azureデプロイテンプレートに名前を付けることができます。この名前は、デプロイ履歴からデプロイを復元するのに役立ちます。デプロイの名前を指定しない場合は、テンプレートファイルの名前が使用されます。たとえば、 azuredeploy.json という名前のテンプレートをデプロイし、デプロイ名を指定しない場合、デプロイには azuredeploy という名前が付けられます。

デプロイを実行するたびに、リソースグループのデプロイ履歴にデプロイ名のエントリが追加されます。別のデプロイを実行するときに同じ名前を付けると、現在のデプロイによって前のエントリが置き換えられます。デプロイ履歴に一意のエントリを保持する場合は、デプロイごとに一意の名前を付けます。

一意の名前を作成するために、ランダムな数値を割り当てることができます。

deploymentName='ExampleDeployment'$RANDOM

または、日付の値を追加します。

deploymentName='ExampleDeployment'$(date +"%d-%b-%Y")

同じリソースグループに対して同じ名前のデプロイを同時に実行した場合は、最後のデプロイのみが完了します。完了していない同じ名前のデプロイは、最後のデプロイによって置き換えられます。たとえば、newStorage という名前のストレージアカウントをデプロイする storage1 という名前のデプロイを実行し、newStorage という名前のストレージアカウントをデプロイする storage2 という名前の別のデプロイを同時に実行した場合は、1 つのストレージアカウントのみがデプロイされます。結果のストレージアカウントの名前は storage2 になります。

ただし、newStorage という名前のストレージアカウントをデプロイする storage1 という名前のデプロイを実行し、その完了直後に、newStorage という名前のストレージアカウントをデプロイする storage2 という名前の別のデプロイを実行した場合は、ストレージアカウントは 2 つになります。 1 つは storage1 という名前に、もう 1 つは storage2 という名前になります。ただし、デプロイ履歴にはエントリが 1 つだけ存在します。

デプロイごとに一意の名前を指定すると、競合なしでそれらを同時に実行できます。 newStorage1 という名前のストレージアカウントをデプロイする storage1 という名前のデプロイを実行し、newStorage2 という名前のストレージアカウントをデプロイする storage2 という名前の別のデプロイを同時に実行した場合は、2 つのストレージアカウントがデプロイされ、デプロイ履歴には 2 つのエントリが存在します。

同時デプロイによる競合を回避し、デプロイ履歴に一意のエントリが確実に存在するようにするには、各デプロイに一意の名前を付けます。

テンプレートスペックのデプロイ

ローカルテンプレートまたはリモートテンプレートをデプロイする代わりに、template 仕様を作成できます。テンプレートスペックは、ARM テンプレートを含む Azure サブスクリプション内のリソースです。これにより、組織内のユーザーとテンプレートを安全に共有することが容易になります。 Azureロールベースのアクセス制御 (Azure RBAC) を使用して、テンプレートスペックへのアクセスを許可します。この機能は現在プレビュー段階です。

次の例では、テンプレートスペックの作成とデプロイの方法を示します。

まず、ARM テンプレートを指定して、テンプレートスペックを作成します。

az ts create \
  --name storageSpec \
  --version "1.0" \
  --resource-group templateSpecRG \
  --location "westus2" \
  --template-file "./mainTemplate.json"

次に、テンプレートスペックの ID を取得して、デプロイします。

id = $(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")

az deployment group create \
  --resource-group demoRG \
  --template-spec $id

詳細については、「Azure Resource Manager テンプレートスペックを参照してください。

変更のプレビュー

ARM テンプレートをデプロイする前に、テンプレートが環境に加える変更をプレビューできます。 what-if 操作を使用して、テンプレートが期待する変更を行うことを確認します。 What-if はまた、テンプレートのエラーも検証します。

パラメーター

パラメーター値を渡すには、インラインパラメーターまたはパラメーターファイルのいずれかを使用できます。パラメーターファイルには、Bicep パラメーターファイルまたは JSON パラメーターファイルのいずれかを指定できます。

インラインパラメーター

インラインパラメーターを渡すには、parameters に値を指定します。たとえば、Bash シェルで文字列と配列をテンプレートに渡すには、以下を使用します。

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-template> \
  --parameters exampleString='inline string' exampleArray='("value1", "value2")'

Windows コマンドプロンプト (CMD) または PowerShell でAzure CLIを使用している場合は、exampleArray="['value1','value2']" の形式で配列を渡します。

ファイルの内容を取得し、その内容をインラインパラメーターとして提供することもできます。

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-template> \
  --parameters exampleString=@stringContent.txt exampleArray=@arrayContent.json

ファイルからのパラメーター値の取得は、構成値を指定する必要がある場合に便利です。たとえば、 Linux 仮想マシンに cloud-init 値を指定できます。

arrayContent.json 形式は次のとおりです。

[
  "value1",
  "value2"
]

タグの設定などを目的にオブジェクトを渡すには、JSON を使用します。たとえば、テンプレートには、次のようなパラメーターを含めることができます。

"resourceTags": {
  "type": "object",
  "defaultValue": {
    "Cost Center": "IT Department"
  }
}

この場合は、次の Bash スクリプトに示すように、JSON 文字列を渡してパラメーターを設定できます。

tags='{"Owner":"Contoso","Cost Center":"2345-324"}'
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $templateFile \
--parameters resourceName=abcdef4556 resourceTags="$tags"

オブジェクトに渡す JSON を二重引用符で囲みます。

変数を使用してパラメーター値を格納できます。 Bash では、変数をすべてのパラメーター値に設定し、それをデプロイコマンドに追加します。

params="prefix=start suffix=end"

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-template> \
  --parameters $params

ただし、Windows コマンドプロンプト (CMD) または PowerShell でAzure CLIを使用している場合は、変数を JSON 文字列に設定します。引用符をエスケープします ($params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }')。

JSON パラメーターファイル

スクリプトでパラメーターをインライン値として渡すのではなく、パラメーター値を含むパラメーターファイル (.bicepparam ファイルまたは JSON パラメーターファイル) を使用する方が簡単な場合があります。パラメータファイルはローカルファイルである必要があります。外部パラメーターファイルは、Azure CLIではサポートされていません。

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters 'storage.parameters.json'

パラメーターファイルの詳細については、「Create Resource Manager パラメーターファイルを参照してください。

Bicep のパラメーターファイル

Azure CLI バージョン 2.53.0 以降と Bicep CLI バージョン 0.22.6 以降を使用して、Bicep パラメーターファイルを利用することで Bicep ファイルをデプロイできます。 Bicep パラメーターファイル内の using ステートメントでは、--template-file スイッチにBicep パラメーターファイルを指定するときに、--parameters スイッチを指定する必要はありません。 --template-file スイッチを含めると、「.bicepparam ファイルには、.bicep ファイルのみが許可されます」というエラーが発生します。

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --parameters storage.bicepparam

パラメータファイルはローカルファイルである必要があります。外部パラメーターファイルは、Azure CLIではサポートされていません。パラメーターファイルの詳細については、「create Resource Manager parameters file」を参照してください。

コメントと拡張 JSON 形式

パラメーターファイルに // スタイルコメントを含めることができますが、このファイルの拡張子を .jsonc にする必要があります。

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters '@storage.parameters.jsonc'

コメントとメタデータの詳細については、「 ARM テンプレートの構造と構文について」を参照してください。

バージョン 2.3.0 以前のAzure CLIを使用している場合は、--handle-extended-json-format スイッチを使用して、複数行の文字列またはコメントを含むテンプレートをデプロイできます。次に例を示します。

{
  "type": "Microsoft.Compute/virtualMachines",
  "apiVersion": "2025-04-01",
  "name": "[variables('vmName')]", // to customize name, change it in variables
  "location": "[
    parameters('location')
    ]", //defaults to resource group location
  /*
    storage account and network interface
    must be deployed first
  */
  "dependsOn": [
    "[resourceId('Microsoft.Storage/storageAccounts/', variables('storageAccountName'))]",
    "[resourceId('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
  ],

次のステップ

エラーが発生したときに正常なデプロイにロールバックするには、「デプロイが成功した場合のエラー時のロールバック」を参照してください。
リソースグループに存在するが、テンプレートで定義されていないリソースの処理方法を指定するには、「Azure Resource Manager デプロイモードを参照してください。
テンプレートでパラメーターを定義する方法については、「ARM テンプレートの構造と構文について」を参照してください。
一般的なデプロイエラーの解決に関するヒントについては、「 Azure Resource Manager」を参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-04-28

次の方法で共有

Azure CLIで Azure Resource Manager (ARM) デプロイ テンプレートを使用する方法

[前提条件]

必要なアクセス許可

配備の範囲

ローカル テンプレートのデプロイ

リモート テンプレートのデプロイ

Azure デプロイ テンプレート名

テンプレート スペックのデプロイ