Visual Studio での Azure リソースグループの作成とデプロイ

[アーティクル]
03/20/2024

Visual Studio では、インフラストラクチャとコードを Azure にデプロイするプロジェクトを作成することができます。たとえば、Web ホスト、Web サイト、および Web サイトのコードをデプロイできます。 Visual Studio では、一般的なシナリオのデプロイに適したさまざまなスターターテンプレートを多数用意しています。この記事では、Web アプリをデプロイします。

この記事では、Azure の開発および ASP.NETのワークロードがインストールされている Visual Studio 2019 以降を使用する方法について説明します。 Visual Studio 2017 を使用しても、操作内容はほとんど同じです。

Azure リソースグループプロジェクトを作成する

このセクションでは、Web アプリ テンプレートを使用して Azure リソースグループプロジェクトを作成します。

Visual Studio で、 [ファイル]>[新規]>[プロジェクト] を選択します。
[Azure リソースグループ] プロジェクトテンプレートを選択し、 [次へ] を選択します。
プロジェクトに名前を付けます。他の既定の設定はおそらく問題ありませんが、お使いの環境でそれらが機能するように確認してください。完了したら、 [作成] を選択します。
Azure Resource Manager にデプロイするテンプレートを選択します。デプロイするプロジェクトの種類に応じて、さまざまなオプションがあります。この記事では、 [Web アプリ] テンプレートを選択し、 [OK] を選択します。

選択したテンプレートは出発点にすぎません。リソースを追加したり削除したりしてシナリオの要件を満たすことができます。

Visual Studio で、Web アプリ用のリソースグループデプロイプロジェクトが作成されます。そのプロジェクトのファイルを確認するには、デプロイプロジェクト内のノードを表示します。

リソースグループデプロイのプロジェクトファイルを示す Visual Studio ソリューションエクスプローラーのスクリーンショット。

[Web アプリ] テンプレートを選択したため、次のファイルが表示されます。

ファイル名	説明
Deploy-AzureResourceGroup.ps1	Azure Resource Manager にデプロイするために PowerShell コマンドを実行する PowerShell スクリプト。 Visual Studio では、この PowerShell スクリプトを使用してテンプレートをデプロイします。
WebSite.json	Azure にデプロイするインフラストラクチャと、デプロイ中に指定できるパラメーターを定義した Resource Manager テンプレートです。 Resource Manager によってリソースが正しい順序でデプロイされるように、リソース間の依存性も定義されます。
WebSite.parameters.json	テンプレートで必要な値を含むパラメーターファイルです。パラメーターの値を渡すことによって各デプロイをカスタマイズします。 [ビルドアクション] が [コンテンツ] に設定されていることに注意してください。パラメーターファイルをさらに追加する場合は、ビルドアクションが [コンテンツ] に設定されていることを確認します。

すべてのリソースグループデプロイプロジェクトに、上記の基本的なファイルが含まれます。他のプロジェクトには、他の機能をサポートするために追加のファイルが含まれることがあります。

Resource Manager テンプレートをカスタマイズする

デプロイプロジェクトをカスタマイズするには、デプロイするリソースが記述されている Resource Manager テンプレートを変更します。リソースマネージャーのテンプレートの要素の詳細については、「 Azure リソースマネージャーのテンプレートの作成」を参照してください。

テンプレートで作業するには、WebSite.json を開きます。
Visual Studio エディターでは、Resource Manager テンプレートの編集に役立つツールを提供しています。 [JSON アウトライン] ウィンドウを使用すると、テンプレートで定義されている要素を簡単に確認できます。
アウトラインで要素を選択して、テンプレートのその部分に移動します。
リソースを追加するには、[JSON アウトライン] ウィンドウの上部にある [リソースの追加] ボタンを選択するか、または [リソース] を右クリックして [新しいリソースの追加] を選択します。
[ストレージアカウント] を選択し、名前を付けます。数字と小文字のみで構成された 11 文字未満の名前を指定します。
リソースだけでなく、ストレージアカウントの種類を示すパラメーターとストレージアカウントの名前を示す変数も追加されています。
ストレージアカウントの種類を表すパラメーターは、使用できる種類と既定の種類があらかじめ定義されています。これらの値は、そのまま使用することも、シナリオに合わせて編集することもできます。このテンプレートを使用して Premium_LRS ストレージアカウントをデプロイするのをどのユーザーにも許可しない場合は、許可する種類からそれを削除します。
```
"demoaccountType": {
  "type": "string",
  "defaultValue": "Standard_LRS",
  "allowedValues": [
    "Standard_LRS",
    "Standard_ZRS",
    "Standard_GRS",
    "Standard_RAGRS"
  ]
}
```
Visual Studio では、テンプレートの編集時に使用できるプロパティがわかるように、Intellisense を提供しています。たとえば、App Service プランのプロパティを編集するには、HostingPlan リソースに移動し、properties の値を追加します。 Intellisense では、使用できる値を示し、その値に関する説明を提供します。

numberOfWorkers を 1 に設定し、ファイルを保存することができます。
```
"properties": {
  "name": "[parameters('hostingPlanName')]",
  "numberOfWorkers": 1
}
```
WebSite.parameters.json ファイルを開きます。パラメーターファイルを使用して、デプロイされるリソースをカスタマイズする値をデプロイ中に渡します。ホスティングプランに名前を指定し、そのファイルを保存します。
```
{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "hostingPlanName": {
      "value": "demoHostPlan"
    }
  }
}
```

Azure にプロジェクトをデプロイする

これで、プロジェクトをリソースグループにデプロイする準備が整いました。

既定では、このプロジェクトの PowerShell スクリプト (Deploy-AzureResourceGroup.ps1) は、AzureRM モジュールを使用します。 AzureRM モジュールがインストールされたままで、引き続きそれを使用する場合は、この既定のスクリプトを使用できます。このスクリプトを使用すると、Visual Studio のインターフェイスを使用してソリューションをデプロイできます。

ただし、新しい Az モジュールに移行した場合は、プロジェクトに新しいスクリプトを追加する必要があります。 Az モジュールを使用するスクリプトを追加するには、Deploy-AzTemplate.ps1 スクリプトをコピーしてプロジェクトに追加します。このスクリプトをデプロイに使用するには、Visual Studio のデプロイインターフェイスを使用するのではなく、PowerShell コンソールから実行する必要があります。

この記事では、両方の方法を紹介します。この記事では、既定のスクリプトを AzureRM モジュールスクリプトと呼び、新しいスクリプトを Az モジュールスクリプトと呼びます。

Az モジュールスクリプト

Az モジュールスクリプトの場合は、PowerShell コンソールを開き、以下を実行します。

.\Deploy-AzTemplate.ps1 -ArtifactStagingDirectory . -Location centralus -TemplateFile WebSite.json -TemplateParametersFile WebSite.parameters.json

AzureRM モジュールスクリプト

AzureRM モジュールスクリプトの場合は、Visual Studio を使用します。

デプロイプロジェクトノードのショートカットメニューで [デプロイ]>[New (新規)] の順に選択します。
[リソースグループに配置する] ダイアログボックスが表示されます。 [リソースグループ] ボックスの一覧で、既存のリソースグループを選択するか、新しいリソースグループを作成します。 [デプロイ] を選択します。
出力ウィンドウに、デプロイの進行状況が表示されます。デプロイが完了すると、最後に、デプロイが成功したことを示す次のようなメッセージが表示されます。
```
18:00:58 - Successfully deployed template 'website.json' to resource group 'ExampleAppDeploy'.
```

デプロイされているリソースを表示する

結果を確認しましょう。

ブラウザーで、 Azure Portal を開き、アカウントにサインインします。リソースグループの内容を確認するには、 [リソースグループ] を選択し、デプロイしたリソースグループを選択します。
デプロイ済みのすべてのリソースが表示されます。ストレージアカウントの名前が、そのリソースを追加したときに指定したものとまったく同じにはならないことに注意してください。ストレージアカウントは一意である必要があります。テンプレートによって、指定した名前に自動的に文字列が追加され、一意の名前が作成されます。

プロジェクトにコードを追加する

この時点で、アプリ用のインフラストラクチャはデプロイ済みですが、実際のコードはプロジェクトでデプロイされていません。

Visual Studio ソリューションにプロジェクトを追加します。ソリューションを右クリックして、 [追加]>[新しいプロジェクト] の順に選択します。
ASP.NET Core Web アプリケーションを追加します。
Web アプリに名前を付け、 [作成] を選択します。
[Web アプリケーション] を選択し、 [作成] を選択します。
Visual Studio によって Web アプリが作成されると、ソリューションに両方のプロジェクトが表示されます。
次に、リソースグループプロジェクトで新しいプロジェクトが認識されていることを確認する必要があります。リソースグループプロジェクト (ExampleAppDeploy) に戻ります。 [参照] を右クリックし、 [参照の追加] を選択します。
作成した Web アプリプロジェクトを選択します。

参照を追加することで、リソースグループプロジェクトに Web アプリプロジェクトをリンクし、いくつかのプロパティを自動的に設定します。これらのプロパティはその参照の [プロパティ] ウィンドウに表示されます。 [Include File Path](ファイルパスを含める) にはパッケージを作成するパスが含まれます。フォルダー (ExampleApp) とファイル (package.zip) をメモします。これらの値は、アプリケーションをデプロイする際にパラメーターとして指定するため、知っておく必要があります。
テンプレート (WebSite.json) に戻り、テンプレートにリソースを追加します。
今回は [Web App の Web 配置] を選択します。

テンプレートを保存します。
テンプレートには、新しいパラメーターがいくつか存在します。それらは前の手順で追加されました。 _artifactsLocation または _artifactsLocationSasToken の値は自動的に生成されるため、指定する必要はありません。ただし、デプロイパッケージが含まれているパスにフォルダーおよびファイル名を設定する必要があります。これらのパラメーターの名前の末尾は、PackageFolder および PackageFileName となります。名前の最初の部分は、追加した Web 配置リソースの名前です。この記事では、ExampleAppPackageFolder および ExampleAppPackageFileName という名前が付いています。

Website.parameters.json を開き、それらのパラメーターを、参照プロパティで確認した値に設定します。 ExampleAppPackageFolder をフォルダーの名前に設定します。 ExampleAppPackageFileName を ZIP ファイルの名前に設定します。
```
{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "hostingPlanName": {
      "value": "demoHostPlan"
    },
    "ExampleAppPackageFolder": {
      "value": "ExampleApp"
    },
    "ExampleAppPackageFileName": {
      "value": "package.zip"
    }
  }
}
```

インフラストラクチャでコードをデプロイする

プロジェクトにコードを追加したため、今回のデプロイは少し異なっています。デプロイ中に、Resource Manager からアクセスできる場所にプロジェクトの成果物をステージします。成果物は、ストレージアカウントにステージされます。

Az モジュールスクリプト

Az モジュールスクリプトを使用している場合は、テンプレートに 1 つの小さな変更を加える必要があります。このスクリプトにより、成果物の場所にスラッシュが追加されますが、対象のテンプレートではスラッシュが想定されていません。 WebSite.json を開き、MSDeploy 拡張機能のプロパティを見つけます。 packageUri という名前のプロパティがあります。成果物の場所とパッケージフォルダーの間のスラッシュを削除します。

次のようになります。

"packageUri": "[concat(parameters('_artifactsLocation'), parameters('ExampleAppPackageFolder'), '/', parameters('ExampleAppPackageFileName'), parameters('_artifactsLocationSasToken'))]",

前の例では parameters('_artifactsLocation') と parameters('ExampleAppPackageFolder') の間に '/', がないことに注意してください。

プロジェクトをリビルドします。プロジェクトをビルドすると、デプロイする必要があるファイルがステージングフォルダーに追加されます。

ここで、PowerShell コンソールを開き、以下を実行します。

.\Deploy-AzTemplate.ps1 -ArtifactStagingDirectory .\bin\Debug\staging\ExampleAppDeploy -Location centralus -TemplateFile WebSite.json -TemplateParametersFile WebSite.parameters.json -UploadArtifacts -StorageAccountName <storage-account-name>

AzureRM モジュールスクリプト

AzureRM モジュールスクリプトの場合は、Visual Studio を使用します。

再デプロイするには、 [デプロイ] を選択し、以前にデプロイしたリソースグループを選択します。
[成果物のストレージアカウント] で、このリソースグループと共にデプロイしたストレージアカウントを選択します。

Web アプリを表示する

デプロイが完了したら、ポータルで Web アプリを選択します。 URL を選択して新しいサイトを参照します。
既定の ASP.NET アプリが正しくデプロイされていることがわかります。

操作ダッシュボードを追加する

リソースは、Visual Studio インターフェイスを通じて利用できるものに限定されません。テンプレートにカスタムリソースを追加することで、デプロイをカスタマイズできます。リソースの追加を表示するには、デプロイしたリソースを管理する運用ダッシュボードを追加します。

WebSite.json ファイルを開き、resources セクションのストレージアカウントリソースの後、右角かっこ ] の前に次の JSON を追加します。

 ,{
   "properties": {
     "lenses": {
       "0": {
         "order": 0,
         "parts": {
           "0": {
             "position": {
               "x": 0,
               "y": 0,
               "colSpan": 4,
               "rowSpan": 6
             },
             "metadata": {
               "inputs": [
                 {
                   "name": "resourceGroup",
                   "isOptional": true
                 },
                 {
                   "name": "id",
                   "value": "[resourceGroup().id]",
                   "isOptional": true
                 }
               ],
               "type": "Extension/HubsExtension/PartType/ResourceGroupMapPinnedPart"
             }
           },
           "1": {
             "position": {
               "x": 4,
               "y": 0,
               "rowSpan": 3,
               "colSpan": 4
             },
             "metadata": {
               "inputs": [],
               "type": "Extension[azure]/HubsExtension/PartType/MarkdownPart",
               "settings": {
                 "content": {
                   "settings": {
                     "content": "__Customizations__\n\nUse this dashboard to create and share the operational views of services critical to the application performing. To customize simply pin components to the dashboard and then publish when you're done. Others will see your changes when you publish and share the dashboard.\n\nYou can customize this text too. It supports plain text, __Markdown__, and even limited HTML like images <img width='10' src='https://portal.azure.com/favicon.ico'/> and <a href='https://azure.microsoft.com' target='_blank'>links</a> that open in a new tab.\n",
                     "title": "Operations",
                     "subtitle": "[resourceGroup().name]"
                   }
                 }
               }
             }
           }
         }
       }
     },
     "metadata": {
       "model": {
         "timeRange": {
           "value": {
             "relative": {
               "duration": 24,
               "timeUnit": 1
             }
           },
           "type": "MsPortalFx.Composition.Configuration.ValueTypes.TimeRange"
         }
       }
     }
   },
   "type": "Microsoft.Portal/dashboards",
   "apiVersion": "2015-08-01-preview",
   "name": "[concat('ARM-',resourceGroup().name)]",
   "location": "[resourceGroup().location]",
   "tags": {
     "hidden-title": "[concat('OPS-',resourceGroup().name)]"
   }
 }

プロジェクトを再デプロイします。
デプロイが完了したら、ポータルでダッシュボードを表示します。 [ダッシュボード] を選択し、デプロイしたものを選択します。
カスタマイズされたダッシュボードが表示されます。

ダッシュボードへのアクセスを管理するには、Azure のロールベースのアクセス制御 (RBAC) を使用します。また、デプロイした後で、ダッシュボードの外観をカスタマイズすることもできます。ただし、リソースグループを再デプロイすると、ダッシュボードはテンプレートの既定の状態にリセットされます。ダッシュボードの作成について詳しくは、「プログラムによる Azure ダッシュボードの作成」をご覧ください。

リソースをクリーンアップする

Azure リソースが不要になったら、リソースグループを削除して、デプロイしたリソースをクリーンアップします。

Azure portal で、左側のメニューから [リソースグループ] を選択します。
リソースグループ名を選択します。
トップメニューから [リソースグループの削除] を選択します。

次のステップ

この記事では、Visual Studio を使用してテンプレートを作成およびデプロイする方法について説明しました。テンプレートの開発についてさらに学習するには、以下の新しい初心者向けチュートリアルシリーズを参照してください。

初心者向けチュートリアル

Visual Studio での Azure リソース グループの作成とデプロイ

Azure リソース グループ プロジェクトを作成する

Resource Manager テンプレートをカスタマイズする

Azure にプロジェクトをデプロイする

Az モジュール スクリプト

AzureRM モジュール スクリプト

デプロイされているリソースを表示する

プロジェクトにコードを追加する

インフラストラクチャでコードをデプロイする

Az モジュール スクリプト

AzureRM モジュール スクリプト

Web アプリを表示する

操作ダッシュボードを追加する

リソースをクリーンアップする

次のステップ

その他のリソース

Visual Studio での Azure リソースグループの作成とデプロイ

Azure リソースグループプロジェクトを作成する

Az モジュールスクリプト

AzureRM モジュールスクリプト

Az モジュールスクリプト

AzureRM モジュールスクリプト