More than 1 year has passed since last update.

【やってみた】Azureチュートリアル：ARMテンプレートのデプロイ

Last updated at 2024-04-28Posted at 2024-04-28

サマリ

Azure公式ドキュメントにある、
「チュートリアル:初めての ARM テンプレートを作成してデプロイする」をやってみました。

背景

昨年の自分の記事で
AWSの１０分間チュートリアルをやってから早半年、、

クラウド学習から遠ざかっていたので、
今度はAzureのチュートリアルを一つピックアップしてやってみました。
（一貫性のなさがすごい）

ゴール

以下の公式ドキュメントに記載のチュートリアルを最後までやりきる

対象読者

Azureを触ってみたいがとっかかりがなく触れていない方
自分（備忘のため）

前提

必須：Azure環境（今回AzurePortalにログインした後からの手順なので、Azureの環境がない方は別記事などでまずは事前準備いただく必要があります）
推奨：Azure、特にARMに関する知識（自分もまだFundamentalsを勉強中で全然知識ないです）

環境

作業PCのOS：Window10 Home
Azure CLI：2.59.0

手順

そもそもARMとは

公式ページによると以下とのことです。
Azureのリソースの管理やそれらをデプロイするためのサービスということですね（そのまま

Azure Resource Manager は、Azure のデプロイおよび管理サービスです。

そもそもARMテンプレートとは

こちらも公式ページを貼り付けます。

アジャイル開発における課題等も色々書いてあるのですが、
ようはIaC（Infrastructure as Code）を実現するためのテンプレートということですね（強引）
以下の通り、AzureではJSON形式で定義するようです。

Azure ソリューション用にインフラストラクチャをコードとして実装するには、Azure Resource Manager テンプレート (ARM テンプレート) を使用します。テンプレートは JavaScript Object Notation (JSON) ファイルであり、プロジェクトのインフラストラクチャと構成が定義されています。

今回はそのテンプレートのサンプルをデプロイしてみようということですね。

手順実施

ざっくりイメージをつかんだところで手順に移ります。

基本的に冒頭でも張り付けた公式ドキュメントの通り進めます。

エディタの準備

まずは事前の準備として、

テンプレートを作成するには、適切な JSON エディターが必要です。 Visual Studio Code と Azure Resource Manager Tools 拡張機能をお勧めします。

とのことです。
Visual Studio Codeは手元にあったのですが、
ARM Toolsの拡張機能がなかったのでインストールすることにしました。

アクティビティバーの機能拡張のところで検索してみると、

一番上にそれらしいものが出ました。
こちらをインストールします。

行けました。

コマンドライン環境の準備

テンプレートをデプロイするには、Azure PowerShell または Azure Command-Line Interface (CLI) も必要です。 Azure CLI を使用する場合は、バージョン 2.37.0 以降が必要です。

とのことで、こちらもAzure初心者としては準備が必要なので対応します。

Azure Powershell か Azure CLIのどちらかが必要ですが、
どっちがいいのかよくわかりません。（おい

公式ドキュメントおよび記事をピックアップしました。

詳しいことはよくわかりませんが、
なんとなくAzure CLIの方が直感的そうなので今回はこちらにすることにします。
（ちなみに今回のチュートリアルの手順には両方の手順が載っているのでよほど業務上指定がある等の理由がなければどちらでもいいかと思います。）

Azure CLIのインストールも公式に手順があるのでこちらを参考に進めていきます。

msiファイルを実行します。

License Agreementが出るので、ノールックでチェックしInstallを選択（おい

Finishで完了です。

これでどうやらWindowsのPowerShellまたはコマンドプロンプトでazコマンドが使えるようになっていること…
本当か…！？

…

ほんまや～！

ということで次に行きたいのですが、公式ドキュメント曰く、
コマンドのタブ補完をできるようにしておいた方がいいということで

notepad $PROFILEコマンドを打ち込みます。
すると、メモ帳とともに以下のポップアップが出ます。
（すでにプロファイルを作成済みの場合は出ないかもです）

はいを押下し、自動で開かれたメモ帳に以下の情報をコピペして保存します。
（こちらも公式ドキュメントに記載のものです）

Register-ArgumentCompleter -Native -CommandName az -ScriptBlock {
    param($commandName, $wordToComplete, $cursorPosition)
    $completion_file = New-TemporaryFile
    $env:ARGCOMPLETE_USE_TEMPFILES = 1
    $env:_ARGCOMPLETE_STDOUT_FILENAME = $completion_file
    $env:COMP_LINE = $wordToComplete
    $env:COMP_POINT = $cursorPosition
    $env:_ARGCOMPLETE = 1
    $env:_ARGCOMPLETE_SUPPRESS_SPACE = 0
    $env:_ARGCOMPLETE_IFS = "`n"
    $env:_ARGCOMPLETE_SHELL = 'powershell'
    az 2>&1 | Out-Null
    Get-Content $completion_file | Sort-Object | ForEach-Object {
        [System.Management.Automation.CompletionResult]::new($_, $_, "ParameterValue", $_)
    }
    Remove-Item $completion_file, Env:\_ARGCOMPLETE_STDOUT_FILENAME, Env:\ARGCOMPLETE_USE_TEMPFILES, Env:\COMP_LINE, Env:\COMP_POINT, Env:\_ARGCOMPLETE, Env:\_ARGCOMPLETE_SUPPRESS_SPACE, Env:\_ARGCOMPLETE_IFS, Env:\_ARGCOMPLETE_SHELL
}

念のためPowershellを再起動してみると、エラーが出ているではないですか、、

こちらの記事を見てみると、
実行ポリシーが初期状態のままであることが原因のようです。
（デフォルトではシェルの実行が許可されていない）

記事に従って、

Get-ExecutionPolicyコマンドで改めてRestrictedになっていることを確認、

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Processを実施
RemoteSignedになっていることを確認

余談
詳細は割愛しますが、以下の記事の通り
Powershellの実行ポリシー変更に関してはscopeという概念があり、
どの範囲で変更を適用するか設定できるようです。
（今回は、実行ポリシーを変更してもとに戻すのが手間（あるいは戻し忘れによるリスク回避）のため、scopeをprocessに変更することであくまで一時的なポリシー変更とすることが目的）

https://qiita.com/kikuchi/items/59f219eae2a172880ba6

ポリシーを変更したら、
ps1ファイルの実行は下記を参考にさせていただきました。
（ps1ファイルがあるフォルダに移動してファイル名打ち込むだけですね）

おぉ～特にエラーが出ない。

試しにここまで売ってから、Tabを押してみると、、

おぉ～自動補完されました！（本当ですよ）

Azure CLIの最新化

az upgradeコマンド実行しました。

すでに最新版だよということですね（そりゃそうか）

最初のテンプレートを作成する

はぁ、はぁ、長い道のりだ…
ようやく本題に入ります。

VSCode に移り、公式でドキュメントに則りazuredeploy.jsonファイルを新しく作ります。

以下のJSONをコピーして貼り付けます（公式ドキュメントより引用）

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": []
}

このテンプレートではリソースをデプロイしません。間違いが生じる可能性をできるだけ抑えつつ、テンプレートをデプロイする手順に慣れることができるよう、最初は空のテンプレートを扱います。

とのことです、初心者に優しいですね～

各要素についても解説が載っているので気になる方は読んでもらえたらと思います。

公式ドキュメントから抜粋

$schema: JSON スキーマファイルの場所を指定します。
contentVersion: テンプレートのバージョンを指定します (1.0.0.0 など)。
resources: デプロイまたは更新するリソースが格納されます。

ファイルの保存を忘れずしたらテンプレートの完成です。

Azureへのサインイン

az loginコマンドをPowerShellで実行します。
するとブラウザでログイン画面が出るのでログインします。
（自分の場合すでにログイン済だったので以下の表示になっています）

ログイン出来たらPowerShellにこんな感じの情報が出てきます。

リソースグループの作成

az group create --name myResourceGroup --location "Central US"
コマンドを実行します。

すると、以下の表示が出ます

うまくいったっぽいですね。

テンプレートのデプロイ

公式ドキュメントの手順通り

templateFile="{provide-the-path-to-the-template-file}"
az deployment group create --name blanktemplate --resource-group myResourceGroup --template-file $templateFile