Resource Manager テンプレートと Azure PowerShell を使用したリソースのデプロイDeploy resources with Resource Manager templates and Azure PowerShell

この記事では、Azure PowerShell と Resource Manager テンプレートを使用して Azure にリソースをデプロイする方法について説明します。This article explains how to use Azure PowerShell with Resource Manager templates to deploy your resources to Azure. Azure ソリューションのデプロイと管理に関する概念に精通していない場合は、「Azure Resource Manager の概要」を参照してください。If you aren't familiar with the concepts of deploying and managing your Azure solutions, see Azure Resource Manager overview.

デプロイする Resource Manager テンプレートとして、コンピューター上のローカル ファイル、または GitHub などのリポジトリに配置した外部ファイルを使用できます。The Resource Manager template you deploy can either be a local file on your machine or an external file that is located in a repository like GitHub. この記事でデプロイするテンプレートは、GitHub のストレージ アカウントのテンプレートとして入手できます。The template you deploy in this article is available as storage account template in GitHub.

必要に応じて、Azure PowerShell ガイドの手順に従って Azure PowerShell モジュールをインストールし、Connect-AzureRmAccount を実行して、Azure との接続を作成します。If needed, install the Azure PowerShell module using the instructions found in the Azure PowerShell guide, and then run Connect-AzureRmAccount to create a connection with Azure.

ローカル コンピューターからテンプレートをデプロイするDeploy a template from your local machine

リソースを Azure にデプロイするときは、以下の手順に従います。When deploying resources to Azure, you:

  1. Azure アカウントへのサインインSign in to your Azure account
  2. デプロイ済みのリソースのコンテナーとして機能するリソース グループを作成します。Create a resource group that serves as the container for the deployed resources. リソース グループ名には、英数字、ピリオド、アンダースコア、ハイフン、かっこのみを含めることができます。The name of the resource group can only include alphanumeric characters, periods, underscores, hyphens, and parenthesis. 最大長は 90 文字です。It can be up to 90 characters. 末尾をピリオドにすることはできません。It can't end in a period.
  3. 作成するリソースを定義するテンプレートをリソース グループにデプロイするDeploy to the resource group the template that defines the resources to create

テンプレートには、デプロイをカスタマイズできるパラメーターを含めることができます。A template can include parameters that enable you to customize the deployment. たとえば、特定の環境 (開発、テスト、運用など) 向けにカスタマイズした値を指定できます。For example, you can provide values that are tailored for a particular environment (such as dev, test, and production). サンプル テンプレートでは、ストレージ アカウント SKU のパラメーターを定義します。The sample template defines a parameter for the storage account SKU.

次の例では、リソース グループを作成し、ローカル コンピューターからテンプレートをデプロイします。The following example creates a resource group, and deploys a template from your local machine:


Select-AzureRmSubscription -SubscriptionName <yourSubscriptionName>

New-AzureRmResourceGroup -Name ExampleResourceGroup -Location "South Central US"
New-AzureRmResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateFile c:\MyTemplates\storage.json -storageAccountType Standard_GRS

デプロイが完了するまでに数分かかる場合があります。The deployment can take a few minutes to complete. デプロイが完了すると、次のような結果を含むメッセージが表示されます。When it finishes, you see a message that includes the result:

ProvisioningState       : Succeeded

外部ソースからテンプレートをデプロイするDeploy a template from an external source

Resource Manager テンプレートは、ローカル コンピューターに格納する代わりに、外部の場所に格納することもできます。Instead of storing Resource Manager templates on your local machine, you may prefer to store them in an external location. ソース管理リポジトリ (GitHub など) にテンプレートを格納できます。You can store templates in a source control repository (such as GitHub). または、組織内の共有アクセス用の Azure ストレージ アカウントに格納することができます。Or, you can store them in an Azure storage account for shared access in your organization.

外部テンプレートをデプロイするには、TemplateUri パラメーターを使用します。To deploy an external template, use the TemplateUri parameter. この例の URI を使用して、GitHub のサンプル テンプレートをデプロイします。Use the URI in the example to deploy the sample template from GitHub.

New-AzureRmResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateUri `
  -storageAccountType Standard_GRS

前の例では、テンプレートにはパブリックにアクセスできる URI が必要になります。テンプレートに機密データを含めてはいけないため、この方法は多くの場合に利用できます。The preceding example requires a publicly accessible URI for the template, which works for most scenarios because your template shouldn't include sensitive data. 機密データ (管理者パスワードなど) を指定する必要がある場合は、セキュリティで保護されたパラメーターとしてその値を渡します。If you need to specify sensitive data (like an admin password), pass that value as a secure parameter. ただし、テンプレートを一般からアクセス可能にしない場合は、プライベートなストレージ コンテナーに格納することで保護できます。However, if you don't want your template to be publicly accessible, you can protect it by storing it in a private storage container. Shared Access Signature (SAS) トークンを必要とするテンプレートをデプロイする方法については、SAS トークンを使用したプライベート テンプレートのデプロイに関するページをご覧ください。For information about deploying a template that requires a shared access signature (SAS) token, see Deploy private template with SAS token.

Cloud Shell からのテンプレートのデプロイDeploy template from Cloud Shell

テンプレートは、Cloud Shell を使ってデプロイすることができます。You can use Cloud Shell to deploy your template. ただし、最初に Cloud Shell のストレージ アカウントにテンプレートを読み込む必要があります。However, you must first load your template into the storage account for your Cloud Shell. Cloud Shell の使用経験がない場合は、その設定について Azure Cloud Shell の概要に関するページを参照してください。If you have not used Cloud Shell, see Overview of Azure Cloud Shell for information about setting it up.

  1. Azure Portal にサインインします。Sign in to the Azure portal.

  2. Cloud Shell リソース グループを選択します。Select your Cloud Shell resource group. 名前のパターンは cloud-shell-storage-<region> です。The name pattern is cloud-shell-storage-<region>.

    リソース グループの選択

  3. Cloud Shell のストレージ アカウントを選択します。Select the storage account for your Cloud Shell.

    ストレージ アカウントを選択する

  4. [BLOB] を選択します。Select Blobs.

    BLOB の選択

  5. [+ コンテナー] を選択します。Select + Container.


  6. コンテナーに名前とアクセス レベルを付与します。Give your container a name and an access level. この記事のサンプル テンプレートには機密性の高い情報は含まれていないため、匿名の読み取りアクセスを許可します。The sample template in this article contains no sensitive information, so allow anonymous read access. [OK] を選択します。Select OK.


  7. 作成したコンテナーを選択します。Select the container you created.


  8. [アップロード] を選択します。Select Upload.

    BLOB のアップロード

  9. テンプレートを見つけてアップロードします。Find and upload your template.


  10. アップロードが完了したら、テンプレートを選択します。After it has uploaded, select the template.


  11. URL をコピーします。Copy the URL.

    URL のコピー

  12. プロンプトを開きます。Open the prompt.

    Cloud Shell を開く

Cloud Shell で次のコマンドを使用します。In the Cloud Shell, use the following commands:

New-AzureRmResourceGroup -Name ExampleResourceGroup -Location "South Central US"
New-AzureRmResourceGroupDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateUri <copied URL> `
  -storageAccountType Standard_GRS

複数のリソース グループまたはサブスクリプションにデプロイするDeploy to more than one resource group or subscription

テンプレートに含まれているリソースはすべて 1 つのリソース グループにデプロイするのが一般的です。Typically, you deploy all the resources in your template to a single resource group. 一方、さまざまなリソースを 1 つにまとめたうえで、複数のリソース グループまたはサブスクリプションにデプロイしたい状況もあります。However, there are scenarios where you want to deploy a set of resources together but place them in different resource groups or subscriptions. 単一のデプロイにデプロイできるリソース グループは 5 つまでです。You can deploy to only five resource groups in a single deployment. 詳細については、「複数のサブスクリプションまたはリソース グループに Azure リソースをデプロイする」を参照してください。For more information, see Deploy Azure resources to more than one subscription or resource group.


パラメーター値を渡すには、インライン パラメーターまたはパラメーター ファイルのいずれかを使用できます。To pass parameter values, you can use either inline parameters or a parameter file. この記事の先の例では、インライン パラメーターを示しています。The preceding examples in this article show inline parameters.

インライン パラメーターInline parameters

インライン パラメーターを渡すには、New-AzureRmResourceGroupDeployment コマンドでパラメーターの名前を指定します。To pass inline parameters, provide the names of the parameter with the New-AzureRmResourceGroupDeployment command. たとえば、文字列と配列をテンプレートに渡すには、以下を使用します。For example, to pass a string and array to a template, use:

$arrayParam = "value1", "value2"
New-AzureRmResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile c:\MyTemplates\demotemplate.json `
  -exampleString "inline string" `
  -exampleArray $arrayParam

ファイルの内容を取得し、その内容をインライン パラメーターとして提供することもできます。You can also get the contents of file and provide that content as an inline parameter.

$arrayParam = "value1", "value2"
New-AzureRmResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile c:\MyTemplates\demotemplate.json `
  -exampleString $(Get-Content -Path c:\MyTemplates\stringcontent.txt -Raw) `
  -exampleArray $arrayParam

ファイルからのパラメーター値の取得は、構成値を指定する必要がある場合に便利です。Getting a parameter value from a file is helpful when you need to provide configuration values. たとえば、Linux 仮想マシン用の cloud-init の値を指定できます。For example, you can provide cloud-init values for a Linux virtual machine.

パラメーター ファイルParameter files

スクリプト内のインライン値としてパラメーターを渡すよりも、パラメーター値を含む JSON ファイルを使用するほうが簡単な場合もあります。Rather than passing parameters as inline values in your script, you may find it easier to use a JSON file that contains the parameter values. パラメーター ファイルは、ローカル ファイルでも、アクセス可能な URI を持つ外部ファイルでもかまいません。The parameter file can be a local file or an external file with an accessible URI.

パラメーター ファイルは次の形式にする必要があります。The parameter file must be in the following format:

  "$schema": "",
  "contentVersion": "",
  "parameters": {
     "storageAccountType": {
         "value": "Standard_GRS"

parameters セクションに、テンプレートで定義したパラメーター (storageAccountType) に一致するパラメーター名が含まれていることに注目してください。Notice that the parameters section includes a parameter name that matches the parameter defined in your template (storageAccountType). パラメーター ファイルに、このパラメーターの値が含まれます。The parameter file contains a value for the parameter. この値は、デプロイの際に、テンプレートに自動的に渡されます。This value is automatically passed to the template during deployment. 複数のパラメーター ファイルを作成し、シナリオに合う適切なパラメーター ファイルを渡すことができます。You can create more than one parameter file, and then pass in the appropriate parameter file for the scenario.

前の例をコピーし、storage.parameters.json という名前のファイルとして保存します。Copy the preceding example and save it as a file named storage.parameters.json.

ローカル パラメーター ファイルを渡すには、TemplateParameterFile パラメーターを使用します。To pass a local parameter file, use the TemplateParameterFile parameter:

New-AzureRmResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateFile c:\MyTemplates\storage.json `
  -TemplateParameterFile c:\MyTemplates\storage.parameters.json

外部パラメーター ファイルを渡すには、TemplateParameterUri パラメーターを使用します。To pass an external parameter file, use the TemplateParameterUri parameter:

New-AzureRmResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateUri `

パラメーターの優先順位Parameter precedence

同じデプロイ操作で、インライン パラメーターとローカル パラメーター ファイルを使用することができます。You can use inline parameters and a local parameter file in the same deployment operation. たとえば、一部の値をローカル パラメーター ファイルで指定し、その他の値をデプロイ中にインラインで追加します。For example, you can specify some values in the local parameter file and add other values inline during deployment. ローカル パラメーター ファイルとインラインの両方でパラメーターの値を指定すると、インラインの値が優先されます。If you provide values for a parameter in both the local parameter file and inline, the inline value takes precedence.

ただし、外部パラメーター ファイルを使用する場合、他の値をインラインまたはローカル ファイルから渡すことはできません。However, when you use an external parameter file, you can't pass other values either inline or from a local file. TemplateParameterUri パラメーターでパラメーター ファイルを指定すると、すべてのインライン パラメーターが無視されます。When you specify a parameter file in the TemplateParameterUri parameter, all inline parameters are ignored. すべてのパラメーター値を外部ファイル内で指定します。Provide all parameter values in the external file. パラメーター ファイルに含めることができない機密性の高い値がテンプレートに含まれている場合は、その値をキー コンテナーに追加するか、すべてのパラメーター値をインラインで動的に指定してください。If your template includes a sensitive value that you can't include in the parameter file, either add that value to a key vault, or dynamically provide all parameter values inline.

パラメーター名の競合Parameter name conflicts

PowerShell コマンドのパラメーターのいずれかと名前が同じであるパラメーターがテンプレートに含まれている場合、PowerShell ではテンプレート内のパラメーター名の後ろに FromTemplate という文字を付加します。If your template includes a parameter with the same name as one of the parameters in the PowerShell command, PowerShell presents the parameter from your template with the postfix FromTemplate. たとえば、テンプレート内の ResourceGroupName という名前のパラメーターは、New-AzureRmResourceGroupDeployment コマンドレットの ResourceGroupName パラメーターと競合します。For example, a parameter named ResourceGroupName in your template conflicts with the ResourceGroupName parameter in the New-AzureRmResourceGroupDeployment cmdlet. ResourceGroupNameFromTemplate の値を指定するように求められます。You're prompted to provide a value for ResourceGroupNameFromTemplate. 一般的に、このような混乱を防ぐために、デプロイ処理に使用したパラメーターと同じ名前をパラメーターに付けないことが推奨されます。In general, you should avoid this confusion by not naming parameters with the same name as parameters used for deployment operations.

テンプレートのデプロイをテストするTest a template deployment

リソースを実際にデプロイすることなく、テンプレートとパラメーターの値をテストするには、Test-AzureRmResourceGroupDeployment を使用します。To test your template and parameter values without actually deploying any resources, use Test-AzureRmResourceGroupDeployment.

Test-AzureRmResourceGroupDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateFile c:\MyTemplates\storage.json -storageAccountType Standard_GRS

エラーが検出されなかった場合は、コマンドが応答なしで終了します。If no errors are detected, the command finishes without a response. エラーが検出された場合は、エラー メッセージが返されます。If an error is detected, the command returns an error message. たとえば、ストレージ アカウント SKU について間違った値を渡した場合は、次のエラーが返されます。For example, passing an incorrect value for the storage account SKU, returns the following error:

Test-AzureRmResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile c:\MyTemplates\storage.json -storageAccountType badSku

Code    : InvalidTemplate
Message : Deployment template validation failed: 'The provided value 'badSku' for the template parameter 'storageAccountType'
          at line '15' and column '24' is not valid. The parameter value is not part of the allowed value(s):
Details :

テンプレートに構文エラーがある場合は、テンプレートを解析できなかったことを示すエラー メッセージが返されます。If your template has a syntax error, the command returns an error indicating it couldn't parse the template. このメッセージには、解析エラーの行番号と位置が表示されます。The message indicates the line number and position of the parsing error.

Test-AzureRmResourceGroupDeployment : After parsing a value an unexpected character was encountered: 
  ". Path 'variables', line 31, position 3.

次の手順Next steps