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

Azure PowerShell と Resource Manager テンプレートを使用して Azure にリソースをデプロイする方法について説明します。Learn how to use Azure PowerShell with Resource Manager templates to deploy your resources to Azure. Azure ソリューションのデプロイと管理の概念について詳しくは、「Azure Resource Manager の概要」をご覧ください。For more information about the concepts of deploying and managing your Azure solutions, see Azure Resource Manager overview.

デプロイのスコープDeployment scope

Azure サブスクリプション、またはサブスクリプション内のリソース グループのいずれかを、デプロイの対象として指定できます。You can target your deployment to either an Azure subscription or a resource group within a subscription. 多くの場合、リソース グループをデプロイの対象にします。In most cases, you'll target deployment to a resource group. サブスクリプション デプロイを使用するのは、サブスクリプション全体にポリシーとロールの割り当てを適用するときです。Use subscription deployments to apply policies and role assignments across the subscription. また、リソース グループを作成し、それにリソースをデプロイする場合も、サブスクリプション デプロイを使用します。You also use subscription deployments to create a resource group and deploy resources to it. 使用するコマンドは、デプロイのスコープに応じて異なります。Depending on the scope of the deployment, you use different commands.

リソース グループにデプロイするには、New-AzResourceGroupDeployment を使用します。To deploy to a resource group, use New-AzResourceGroupDeployment:

New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateFile <path-to-template>

サブスクリプションにデプロイするには、New-AzDeployment を使用します。To deploy to a subscription, use New-AzDeployment:

New-AzDeployment -Location <location> -TemplateFile <path-to-template>

現時点では、管理グループのデプロイは、REST API を介してのみサポートされます。Currently, management group deployments are only supported through the REST API. Resource Manager テンプレートと Resource Manager REST API を使用したリソースのデプロイ」を参照してください。See Deploy resources with Resource Manager templates and Resource Manager REST API.

この記事の例では、リソース グループ デプロイを使用します。The examples in this article use resource group deployments. サブスクリプション デプロイの詳細については、「サブスクリプション レベルでリソース グループとリソースを作成する」を参照してください。For more information about subscription deployments, see Create resource groups and resources at the subscription level.

前提条件Prerequisites

デプロイするテンプレートが必要です。You need a template to deploy. デプロイするテンプレートがない場合は、Azure クイック スタート テンプレート リポジトリからサンプル テンプレートを保存します。If you don't already have one, download and save an example template from the Azure Quickstart templates repo. この記事で使用されているローカル ファイル名は、c:\MyTemplates\azuredeploy.json です。The local file name used in this article is c:\MyTemplates\azuredeploy.json.

Azure Cloud Shell を使用してテンプレートをデプロイする場合以外は、Azure PowerShell をインストールして Azure に接続する必要があります。Unless you use the Azure Cloud shell to deploy templates, you need to install Azure PowerShell and connect to Azure:

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

次の例では、リソース グループを作成し、ローカル コンピューターからテンプレートをデプロイします。The following example creates a resource group, and deploys a template from your local machine. リソース グループ名には、英数字、ピリオド、アンダースコア、ハイフン、かっこのみを含めることができます。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.

$resourceGroupName = Read-Host -Prompt "Enter the Resource Group name"
$location = Read-Host -Prompt "Enter the location (i.e. centralus)"

New-AzResourceGroup -Name $resourceGroupName -Location $location
New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName `
  -TemplateFile c:\MyTemplates\azuredeploy.json

デプロイが完了するまでに数分かかる場合があります。The deployment can take a few minutes to complete.

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

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.

$resourceGroupName = Read-Host -Prompt "Enter the Resource Group name"
$location = Read-Host -Prompt "Enter the location (i.e. centralus)"

New-AzResourceGroup -Name $resourceGroupName -Location $location
New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-storage-account-create/azuredeploy.json

前の例では、テンプレートにはパブリックにアクセスできる 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. チュートリアルについては、「チュートリアル:Resource Manager テンプレートのデプロイで Azure Key Vault を統合する」を参照してください。To go through a tutorial, see Tutorial: Integrate Azure Key Vault in Resource Manager Template deployment.

Azure Cloud Shell からデプロイするDeploy from Azure Cloud shell

Azure Cloud Shell を使用して、テンプレートをデプロイできます。You can use the Azure Cloud Shell to deploy your template. 外部テンプレートをデプロイするには、テンプレートの URI を指定します。To deploy an external template, provide the URI of the template. ローカル テンプレートをデプロイするには、最初に Cloud Shell のストレージ アカウントにテンプレートを読み込む必要があります。To deploy a local template, you must first load your template into the storage account for your Cloud Shell. ファイルをシェルにアップロードするには、シェル ウィンドウから [ファイルのアップロード/ダウンロード] メニュー アイコンを選択します。To upload files to the shell, select the Upload/Download files menu icon from the shell window.

Cloud Shell を開くには、https://shell.azure.com を参照するか、または次のコード セクションの [使ってみる] を選択します。To open the Cloud shell, browse to https://shell.azure.com, or select Try-It from the following code section:

$resourceGroupName = Read-Host -Prompt "Enter the Resource Group name"
$location = Read-Host -Prompt "Enter the location (i.e. centralus)"

New-AzResourceGroup -Name $resourceGroupName -Location $location
New-AzResourceGroupDeployment -ResourceGroupName $resourceGroupName `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-storage-account-create/azuredeploy.json

シェルにコードを貼り付けて、シェル内を右クリックし、 [貼り付け] を選択します。To paste the code into the shell, right-click inside the shell and then select Paste.

パラメーター値を渡すPass parameter values

パラメーター値を渡すには、インライン パラメーターまたはパラメーター ファイルのいずれかを使用できます。To pass parameter values, you can use either inline parameters or a parameter file.

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

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

$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -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-AzResourceGroupDeployment -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.

オブジェクトの配列を渡す必要がある場合、PowerShell でハッシュ テーブルを作成し、そのテーブルを配列に追加します。If you need to pass in an array of objects, create hash tables in PowerShell and add them to an array. デプロイの際に、その配列をパラメーターとして渡します。Pass that array as a parameter during deployment.

$hash1 = @{ Name = "firstSubnet"; AddressPrefix = "10.0.0.0/24"}
$hash2 = @{ Name = "secondSubnet"; AddressPrefix = "10.0.1.0/24"}
$subnetArray = $hash1, $hash2
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile c:\MyTemplates\demotemplate.json `
  -exampleArray $subnetArray

パラメーター ファイル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.

パラメーター ファイルの詳細については、「Resource Manager パラメーター ファイルを作成する」を参照してください。For more information about the parameter file, see Create Resource Manager parameter file.

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

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

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

New-AzResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-storage-account-create/azuredeploy.json `
  -TemplateParameterUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-storage-account-create/azuredeploy.parameters.json

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

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

Test-AzResourceGroupDeployment -ResourceGroupName ExampleResourceGroup `
  -TemplateFile c:\MyTemplates\azuredeploy.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-AzResourceGroupDeployment -ResourceGroupName testgroup `
  -TemplateFile c:\MyTemplates\azuredeploy.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):
          'Standard_LRS,Standard_ZRS,Standard_GRS,Standard_RAGRS,Premium_LRS'.'.
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-AzResourceGroupDeployment : After parsing a value an unexpected character was encountered: 
  ". Path 'variables', line 31, position 3.

次の手順Next steps