Azure Resource Manager テンプレートを使用して、Azure Cosmos DB と Azure App Service および GitHub の Web アプリをデプロイする

[アーティクル]
06/01/2023

適用対象: NoSQL

このチュートリアルでは、最初の実行で Azure Cosmos DB に接続する Web アプリケーションを "ノータッチで" デプロイする方法について説明します。Azure Cosmos DB の接続情報を切り取って appsettings.json に貼り付けたり、Azure portal で Azure App Services のアプリケーション設定に貼り付ける必要はありません。これらの操作はすべて、Azure Resource Manager テンプレートを使用して、1 回の操作で行われます。この例では、Web アプリのチュートリアルの Azure Cosmos DB ToDo サンプルをデプロイします。

Resource Manager テンプレートは非常に柔軟であり、Azure の任意のサービスにわたる複雑なデプロイを構成できます。これには、GitHub からのアプリケーションのデプロイや、Azure portal での Azure App Service のアプリケーション設定への接続情報の挿入などの高度なタスクが含まれます。このチュートリアルでは、1 つの Resource Manager テンプレートを使用して次の操作を行う方法について説明します。

Azure Cosmos DB アカウントをデプロイする。
Azure App Service ホスティングプランをデプロイする。
Azure App Service をデプロイする。
Azure Cosmos DB アカウントのエンドポイントとキーを、Azure portal の App Service アプリケーション設定に挿入する。
GitHub リポジトリから App Service に Web アプリケーションをデプロイする。

結果のデプロイには、Azure Cosmos DB のエンドポイント URL または認証キーを Azure portal から切り取って貼り付ける必要なく Azure Cosmos DB に接続できる、完全に機能する Web アプリケーションが含まれます。

前提条件

ヒント

このチュートリアルは、Azure Resource Manager テンプレートや JSON の使用経験があるユーザーを対象にしているわけではありませんが、参照するテンプレートやデプロイメントオプションに変更を加える場合は、これらの領域に関する知識が必要になります。

手順 1:テンプレートのデプロイ

最初に、以下の [Azure に配置する] ボタンを選択して Azure portal を開き、カスタムデプロイを作成します。 Azure Resource Manager テンプレートは、Azure クイックスタートテンプレートギャラリーから表示することもできます

Azure portal で、デプロイ先のサブスクリプションを選択し、新しいリソースグループを選択または作成します。次に、以下の値を入力します。

Screenshot of the template deployment UI

[リージョン] - Resource Manager に必要です。リソースが配置される場所のパラメーターで使用されているものと同じリージョンを入力します。
[アプリケーション名] - この名前は、このデプロイのすべてのリソースで使用されます。既存の Azure Cosmos DB および App Service アカウントとの競合を避けるために、必ず一意の名前を選択してください。
[場所] - リソースがデプロイされるリージョン。
[App Service Plan Tier](App Service プランレベル) - App Service プランの価格レベルです。
[App Service Plan Instances](App Service プランインスタンス) - App Service プランのワーカーの数。
[リポジトリの URL] - GitHub 上の Web アプリケーションに対するリポジトリ。
[ブランチ] - GitHub リポジトリのブランチ。
[データベース名] - Azure Cosmos DB データベース名。
[コンテナー名] - Azure Cosmos DB コンテナー名。

値を入力したら、 [作成] ボタンを選択してデプロイを開始します。この手順は完了するまでに 5 分から 10 分かかります。

ヒント

このテンプレートでは、テンプレートに入力された Azure App Service アプリ名と Azure Cosmos DB アカウント名が有効かつ使用可能であることが検証されません。デプロイメントの送信前に、指定する予定の名前の可用性を確認しておくことを強くお勧めします。

手順 2:リソースを調べる

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

テンプレートによってリソースがデプロイされると、リソースグループ内でそれぞれを確認できるようになります。

Resource Group

Azure Cosmos DB エンドポイントとキーを表示する

次に、ポータルで Azure Cosmos DB アカウントを開きます。次のスクリーンショットは、Azure Cosmos DB アカウントのエンドポイントとキーを示しています。

Azure Cosmos DB Keys

アプリケーション設定で Azure Cosmos DB キーを表示する

次に、リソースグループ内の Azure App Service に移動します。 [構成] タブをクリックして、App Service の [アプリケーション設定] を表示します。 [アプリケーション設定] には、Azure Cosmos DB に接続するために必要な Azure Cosmos DB アカウントと主キーの値、およびテンプレートデプロイから渡されたデータベース名とコンテナー名が含まれています。

Application Settings

[デプロイセンター] で Web アプリを表示する

次に、App Service の [デプロイセンター] に移動します。ここには、テンプレートに渡された GitHub リポジトリを指す [リポジトリ] が表示されます。また、下の [状態] は [Success(Active)](成功 (アクティブ)) を示しています。これはアプリケーションが正常にデプロイされ、開始されたことを意味します。

Deployment Center

Web アプリケーションの実行

[デプロイセンター] の上部にある [参照] をクリックして、Web アプリケーションを開きます。 Web アプリケーションのホーム画面が表示されます。 [新規作成] をクリックし、フィールドにデータを入力して、[保存] をクリックします。結果の画面には Azure Cosmos DB に保存されたデータが表示されます。

Home Screen

手順 3:動作のしくみ

これを機能させるには、3 つの要素が必要です。

実行時のアプリ設定の読み取り

まず、アプリケーションでは、ASP.NET MVC Web アプリケーションの Startup クラスで、Azure Cosmos DB エンドポイントとキーを要求する必要があります。 Azure Cosmos DB To Do サンプルはローカルで実行でき、お客様が appsettings.json に接続情報を入力できます。しかし、デプロイする場合、このファイルはアプリと共にデプロイされます。赤で囲まれた以下の行で appsettings.json の設定にアクセスできない場合は、Azure App Service のアプリケーション設定から試行されます。

Screenshot shows a method with several string variables marked in red, including databaseName, containerName, account, and key.

特殊な Azure リソース管理関数の使用

デプロイされたアプリケーションでこれらの値を使用できるようにするために、Azure Resource Manager テンプレートでは、reference や listKeys などの特殊な Azure リソース管理関数を使用して、Azure Cosmos DB アカウントからこれらの値を要求できます。これらの関数を使うと、Azure Cosmos DB アカウントから値を取得し、'{section:key}' 形式で、上のアプリケーションで使用されているものと一致するキー名を使用して、アプリケーション設定の値に挿入できます。たとえば、CosmosDb:Account のようにします。

Template Keys

GitHub からの Web アプリのデプロイ

最後に、GitHub から App Service に Web アプリケーションをデプロイする必要があります。これは、以下の JSON を使用して行います。 2 点注意しなければならないのは、このリソースの種類と名前です。 "type": "sourcecontrols" と "name": "web" の両方のプロパティ値はハードコーディングされているため、変更しないでください。

Deploy From GitHub

次のステップ

お疲れさまでした。 Azure Cosmos DB、Azure App Service、および Azure Cosmos DB への接続に必要な接続情報を自動的に取得するサンプル Web アプリケーションを、すべて 1 回の操作で、機密情報の切り取りと貼り付けを行う必要なくデプロイできました。このテンプレートを出発点として使用し、変更を加えることで、独自の Web アプリケーションを同じ方法でデプロイできます。

このサンプル用の Azure Resource Manager テンプレートについては、Azure クイックスタートテンプレートギャラリーにアクセスしてください
サンプルアプリのソースコードについては、GitHub 上の Azure Cosmos DB To Do アプリにアクセスしてください。