Zenn
Open7

【Azure】ローカル開発環境の構築手順メモ

C#
Azure
VS Code
Azure Functions
noknok

はじめに

AzureFunctionsなどを、ローカルで開発する環境を構築する手順をメモしていきます

利用環境

項目 バージョンなど
MacOS Sonoma
VS Code 1.87.2
.NET SDK 8.0 LTS

インストールしたいもの

項目 概要
.NET SDK C#による開発を行いたい場合に必要になる（SDKには .NET CLIも含まれるので、CLIも利用可能になる）
Azure CLI コマンドラインからAzureのリソース操作が可能になる
Azure Functions Core Tools ローカル環境でAzureFunctionsの開発が可能になる
C#（VSCode拡張機能） C#コードのインテリセンスやコード補完などが可能になる
Azure CLI Tools（VSCode拡張機能） Azure CLIのコマンドの実行が可能になる
Azure Functions（VSCode拡張機能） VSCode上で簡単にAzureFunctionsの開発が可能になる
noknok

MacOSに.NETをインストールする

1..NETのダウンロードサイトにアクセス（.NETダウンロード先）
2. 任意のバージョンのリンクを選択し、対象のインストーラをダウンロードする
　※１：今回は、現時点で最新の「.NET 8.0」をインストールとした
　※２：Appleシリコン搭載のMacの場合は、ARM64を選択
3. ダウンロードしたpkgファイルをダブルクリックし、インストールダイアログに従ってインストール

公式ドキュメント

https://learn.microsoft.com/ja-jp/dotnet/core/install/macos

noknok

Azure CLIをインストールする

Azure CLIとは

Azureに接続して、Azureリソースに対して管理コマンドを実行するための、クロスプラットフォームのコマンドラインツール。
ターミナルやスクリプトを通じてコマンドの実行が可能になる。

インストール手順

1.ターミナルを起動後。以下コマンドでインストールを行う

ターミナル
brew update && brew install azure-cli

2.インストール確認を行う

ターミナル
az --version

# 出力例
azure-cli                         2.58.0 *

core                              2.58.0 *
telemetry                          1.1.0

Dependencies:
msal                              1.26.0
azure-mgmt-resource             23.1.0b2

公式ドキュメント

https://learn.microsoft.com/ja-jp/cli/azure/install-azure-cli-macos

noknok

Azure Functions Core Toolsをインストールする

Azure Functions Core Toolsとは

ローカル上で関数の開発、およびテストが可能になるツール

インストール手順

1.ターミナルを起動後。以下コマンドでインストールを行う

ターミナル
brew tap azure/functions
brew install azure-functions-core-tools@4
# if upgrading on a machine that has 2.x or 3.x installed:
brew link --overwrite azure-functions-core-tools@4

2.インストール確認を行う

ターミナル
func --version

# 出力例
4.0.5571

インストール時のエラー対応メモ

エラー内容

コマンドラインツールのバージョンが古すぎるという理由でエラーが発生した

ターミナル
==> Installing azure-functions-core-tools@4 from azure/functions
Error: Your Xcode (14.2 => /Applications/Xcode_14.2.app/Contents/Developer) at /Applications/Xcode_14.2.app is too outdated.
Please update to Xcode 15.1 (or delete it).
Xcode can be updated from the App Store.

Error: Your Command Line Tools are too outdated.
Update them from Software Update in System Settings.

If that doesn't show you any updates, run:
  sudo rm -rf /Library/Developer/CommandLineTools
  sudo xcode-select --install

Alternatively, manually download them from:
  https://developer.apple.com/download/all/.
You should download the Command Line Tools for Xcode 15.1.

対応内容

Xcodeのバージョンをアップデート（AppStoreから、Xcodeのバージョンアップを実行）後に、インストールコマンドを再実行することで対応した

公式ドキュメント

https://learn.microsoft.com/ja-jp/azure/azure-functions/functions-run-local?tabs=macos%2Cisolated-process%2Cnode-v4%2Cpython-v2%2Chttp-trigger%2Ccontainer-apps&pivots=programming-language-csharp

noknok

Azure CLI で拡張機能を使用および管理する

拡張機能とは

公式ドキュメントより引用

Azure CLI には、拡張機能を読み込む機能が用意されています。 Azure CLI の拡張機能は Python の wheel 形式であり、CLI には付属していませんが CLI コマンドとして実行できます。 拡張機能を使用すると、独自の CLI インターフェイスを記述する機能と共に、リリース前の実験的なコマンドにアクセスすることができます。

拡張機能のインストール

拡張機能の検索方法

「az extension list-available」 コマンドを使用する

ターミナル
az extension list-available --output table

拡張機能の手動インストール方法

「az extension add」 コマンドを使用する
拡張機能の名前やURLを指定することでインストールする

ターミナル
az extension add --name <extension-name>
ターミナル
az extension add --source <URL-or-path>

拡張機能の自動インストール方法

「az config set extension.use_dynamic_install」 コマンドを使用する

ターミナル
az config set extension.use_dynamic_install=yes_without_prompt

拡張機能の更新方法

「az extension update」 コマンドを使用する

ターミナル
az extension update --name <extension-name>

拡張機能のアンインストール方法

「az extension remove」 コマンドを使用する

az extension remove --name <extension-name>

公式ドキュメント

https://learn.microsoft.com/ja-jp/cli/azure/azure-cli-extensions-overview

noknok

VSCode拡張機能をインストールする

VSCodeの拡張機能メニューから、以下を検索してインストールした
各機能の説明は冒頭の 説明 ご参照

  • C#
  • Azure CLI Tools
  • Azure Functions
noknok

VSCode上で、「Azure Functionsプロジェクトの作成 〜 Functions実行」までを試してみる

https://learn.microsoft.com/ja-jp/azure/azure-functions/functions-develop-vs-code?tabs=node-v4%2Cpython-v2%2Cisolated-process&pivots=programming-language-csharp#prerequisites

手順

１、Azure Functionsプロジェクト作成

  1. VSCodeのAzureアイコン > Functionsアイコン > [Create Function...] を選択（プロジェクトの保存先は、任意のディレクトリを選択する）
    手順-1

  2. 任意のプログラミング言語を選択（「C#」とする）
    手順-2

  3. 任意のランタイムバージョンを選択（「.NET 8.0」とする）
    手順-3

  4. 任意のテンプレートを選択（「HTTP trigger」とする）
    手順-4

  5. 任意の関数名を入力し、Enterキーを押下
    手順-5

  6. 任意の名前空間を入力し、Enterキーを押下
    手順-6

  7. 任意の承認レベルを選択し、Enterキーを押下（詳細は右記参照： 承認レベル）
    手順-7

  8. [Add to workspace]を選択
    手順-8

  9. プロジェクト作成が完了し、初期プロジェクトが表示される
    手順-9

２、Azure Functionsプロジェクトの実行

  1. VSCode上で、[F5]キー押下

  2. プロジェクトが実行されてURLが表示される

  3. URLを任意のブラウザで開き、結果を確認する
    手順-10
    手順-11

  4. 実行終了したい場合は、[ctrl + c]を押下 > 適当なキーを押下