クイックスタート: コマンドラインから Azure に PowerShell 関数を作成する

[アーティクル]
08/24/2023

この記事では、コマンドラインツールを使用して、HTTP 要求に応答する PowerShell 関数を作成します。コードをローカルでテストした後、Azure Functions のサーバーレス環境にデプロイします。

このクイックスタートを完了すると、ご利用の Azure アカウントでわずかな (数セント未満の) コストが発生します。

また、この記事の Visual Studio Code ベースのバージョンも存在します。

ローカル環境を構成する

開始する前に、次の項目を用意する必要があります。

アクティブなサブスクリプションが含まれる Azure アカウント。無料でアカウントを作成できます。
次のいずれかのツール。Azure リソースの作成に使用します。
- Azure Az PowerShell モジュールバージョン 9.4.0 以降。
- Azure CLI バージョン 2.4 以降。
.NET 6.0 SDK
PowerShell 7.4

Azure Functions Core Tools のインストール

Core Tools をインストールするための推奨される方法は、ローカル開発用コンピューターのオペレーティングシステムによって異なります。

次の手順で、Windows インストーラー (MSI) を使用して Core Tools v4.x をインストールします。その他のパッケージベースのインストーラーの詳細については、Core Tools の Readme をご覧ください。

Windows のバージョンに応じて、以下の Core Tools インストーラーをダウンロードして実行します。

v4.x - Windows 64 ビット (推奨。Visual Studio Code デバッグには 64 ビットが必要です)。
v4.x - Windows 32 ビット

以前に Windows で Windows インストーラー (MSI) を使用して Core Tools をインストールした場合は、最新のバージョンをインストールする前に、[プログラムの追加と削除] から古いバージョンをアンインストールする必要があります。

次の手順で、Homebrew を使用して macOS 上に Core Tools をインストールします。

まだインストールしていない場合は、Homebrew をインストールします。

次のコマンドを使って、Core Tools のパッケージをインストールします。

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

次の手順で APT 使用して、Ubuntu/Debian Linux ディストリビューションに Core Tools をインストールします。他の Linux ディストリビューションについては、Core Tools の readme に関するページを参照してください。

パッケージの整合性を検証するには、Microsoft パッケージリポジトリの GPG キーをインストールします。

curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.gpg
sudo mv microsoft.gpg /etc/apt/trusted.gpg.d/microsoft.gpg

APT 更新を行う前に、APT ソースリストを設定します。

Ubuntu

sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/microsoft-ubuntu-$(lsb_release -cs 2>/dev/null)-prod $(lsb_release -cs 2>/dev/null) main" > /etc/apt/sources.list.d/dotnetdev.list'

Debian

sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/debian/$(lsb_release -rs 2>/dev/null | cut -d'.' -f 1)/prod $(lsb_release -cs 2>/dev/null) main" > /etc/apt/sources.list.d/dotnetdev.list'

/etc/apt/sources.list.d/dotnetdev.list ファイルを調べて、次の表に示す適切な Linux バージョン文字列のいずれかがあることを確認します。

Linux ディストリビューション	バージョン
Debian 12	`bookworm`
Debian 11	`bullseye`
Debian 10	`buster`
Debian 9	`stretch`
Ubuntu 22.04	`jammy`
Ubuntu 20.04	`focal`
Ubuntu 19.04	`disco`
Ubuntu 18.10	`cosmic`
Ubuntu 18.04	`bionic`
Ubuntu 17.04	`zesty`
Ubuntu 16.04/Linux Mint 18	`xenial`

APT ソースの更新を開始します。
```
sudo apt-get update
```
次のコマンドを使って、Core Tools のパッケージをインストールします。
```
sudo apt-get install azure-functions-core-tools-4
```

ローカル関数プロジェクトを作成する

Azure Functions における関数プロジェクトとは、それぞれが特定のトリガーに応答する個別の関数を 1 つまたは複数含んだコンテナーです。プロジェクト内のすべての関数は、同じローカル構成とホスティング構成を共有します。このセクションでは、関数を 1 つだけ含んだ関数プロジェクトを作成します。

次のように func init コマンドを実行して、特定のランタイムを含んだ LocalFunctionProj という名前のフォルダーに関数プロジェクトを作成します。
```
func init LocalFunctionProj --powershell
```
プロジェクトフォルダーに移動します。
```
cd LocalFunctionProj
```
このフォルダーにはプロジェクト用の各種ファイルが格納されています。たとえば、local.settings.json や host.json といった名前の構成ファイルです。 local.settings.json には Azure からダウンロードしたシークレットを含めることができるため、このファイルは既定で .gitignore ファイルによってソース管理から除外されます。
次のコマンドを使用して、関数をプロジェクトに追加します。ここで、--name 引数は関数の一意の名前 (HttpExample) で、--template 引数は関数のトリガー (HTTP) を指定します。
```
func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"
```
func new によって、関数と同じ名前のサブフォルダーが作成されます。ここには、プロジェクト用に選択した言語に適したコードファイルと、function.json という名前の構成ファイルが含まれます。

(省略可) ファイルの内容を確認する

先に「関数をローカルで実行する」に進み、ファイルの内容は後から確認してもかまいません。

run.ps1

run.ps1 は、function.json の構成に従ってトリガーされる関数スクリプトを定義します。

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$name = $Request.Query.Name
if (-not $name) {
    $name = $Request.Body.Name
}

$body = "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."

if ($name) {
    $body = "Hello, $name. This HTTP triggered function executed successfully."
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = [HttpStatusCode]::OK
    Body = $body
})

HTTP トリガーの場合、この関数は、function.json に定義された $Request パラメーターに渡された要求データを受け取ります。 function.json で Response として定義されている返されるオブジェクトが、応答として Push-OutputBinding コマンドレットに渡されます。

function.json

function.json は、関数の入出力 bindings (トリガーの型を含む) を定義する構成ファイルです。

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    }
  ]
}

各バインディングは、方向、型、一意の名前を必要とします。 HTTP トリガーには、httpTrigger 型の入力バインディングと、http 型の出力バインディングが与えられます。

関数をローカルで実行する

LocalFunctionProj フォルダーから、ローカルの Azure Functions ランタイムホストを起動して関数を実行します。
```
func start
```
出力の最後の方に、次の行があります。

Note

HttpExample が上記のように表示されない場合、プロジェクトのルートフォルダー以外からホストを起動したと考えられます。その場合は Ctrl+C キーを使用してホストを停止し、プロジェクトのルートフォルダーに移動して、前出のコマンドを再度実行してください。
この出力から HTTP 関数の URL をブラウザーにコピーし、クエリ文字列 ?name=<YOUR_NAME> を付加して、http://localhost:7071/api/HttpExample?name=Functions のような完全な URL にします。ブラウザーには、クエリ文字列値をエコーバックする応答メッセージが表示されるはずです。要求を行うと、プロジェクトを起動したターミナルにもログ出力が表示されます。
完了したら、Ctrl + C キーを押し、「y」を入力して関数ホストを停止してください。

関数用の関連 Azure リソースを作成する

関数コードを Azure にデプロイする前に、3 つのリソースを作成する必要があります。

リソースグループ。関連リソースの論理コンテナーです。
ストレージアカウント。関数についての情報 (状態など) を維持する目的で使用されます。
関数アプリ。関数コードを実行するための環境となります。関数アプリは、ローカルの関数プロジェクトと対応関係にあります。これを使用すると、リソースの管理、デプロイ、共有を容易にするための論理ユニットとして関数をグループ化できます。

以下のコマンドを使用してこれらの項目を作成します。 Azure CLI と PowerShell の両方がサポートされます。

まだ Azure にサインインしていない場合は、Azure にサインインします。
- Azure CLI
- Azure PowerShell
```
az login
```
az login コマンドで Azure アカウントにサインインします。
```
Connect-AzAccount
```
Connect-AzAccount コマンドレットで Azure アカウントにサインインします。
選択したリージョンに AzureFunctionsQuickstart-rg という名前のリソースグループを作成します。
- Azure CLI
- Azure PowerShell
```
az group create --name AzureFunctionsQuickstart-rg --location <REGION>
```
az group create コマンドでリソースグループを作成します。上記のコマンドで、<REGION> コマンドから返された使用可能なリージョンコードを使用して、<REGION> を自分の近くのリージョンに置き換えます。
```
New-AzResourceGroup -Name AzureFunctionsQuickstart-rg -Location <REGION>
```
New-AzResourceGroup コマンドでリソースグループを作成します。リソースグループとリソースは通常、近くのリージョンに作成します。Get-AzLocation コマンドレットから返される利用可能なリージョンを使用してください。
リソースグループとリージョン内に汎用ストレージアカウントを作成します。
- Azure CLI
- Azure PowerShell
```
az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS --allow-blob-public-access false
```
az storage account create コマンドでストレージアカウントを作成します。
```
New-AzStorageAccount -ResourceGroupName AzureFunctionsQuickstart-rg -Name <STORAGE_NAME> -SkuName Standard_LRS -Location <REGION> -AllowBlobPublicAccess $false
```
New-AzStorageAccount コマンドレットでストレージアカウントを作成します。
前の例の <STORAGE_NAME> は、適宜、Azure Storage 内で一意の名前に置き換えてください。名前は 3 文字から 24 文字とし、小文字のみを使用する必要があります。 Standard_LRS は汎用アカウントを指定します。これは Functions でサポートされています。

重要

ストレージアカウントは、アプリケーションコード自体を含む重要なアプリデータを格納するために使用されます。他のアプリやユーザーからのアクセスをストレージアカウントに制限する必要があります。

Azure に関数アプリを作成します。
- Azure CLI
- Azure PowerShell
```
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime powershell --functions-version 4 --name <APP_NAME> --storage-account <STORAGE_NAME>
```
az functionapp create コマンドで Azure に関数アプリを作成します。
```
New-AzFunctionApp -Name <APP_NAME> -ResourceGroupName AzureFunctionsQuickstart-rg -StorageAccount <STORAGE_NAME> -Runtime PowerShell -FunctionsVersion 4 -Location '<REGION>'
```
New-AzFunctionApp コマンドレットによって、Azure に関数アプリが作成されます。
前の例では、<STORAGE_NAME> を前の手順で使用したアカウントの名前に、<APP_NAME> を適宜グローバルに一意の名前に置き換えてください。 <APP_NAME> は、関数アプリの既定の DNS ドメインでもあります。

このコマンドでは、Azure Functions 従量課金プラン (ここで発生する使用量に関しては無料) で、指定された言語ランタイムで実行される関数アプリを作成します。また、このコマンドを実行すると、関連する Azure Application Insights インスタンスが同じリソースグループにプロビジョニングされます。このインスタンスを使用することで、関数アプリを監視したりログを確認したりすることができます。詳しくは、「Azure Functions を監視する」をご覧ください。このインスタンスは、アクティブにするまでコストが発生しません。

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

Azure 内に関数アプリを作成することに成功したら、func azure functionapp publish コマンドを使用してローカル関数プロジェクトをデプロイする準備が整います。

ルートプロジェクトフォルダーで、次の func azure functionapp publish コマンドを実行します。

func azure functionapp publish <APP_NAME>

この例では、<APP_NAME> をご自身のアプリの名前に置き換えてください。デプロイが成功すると、次の出力のような結果 (簡潔にするために切り詰められています) が表示されます。

...

Getting site publishing info...
Creating archive for current directory...
Performing remote build for functions project.

...

Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in msdocs-azurefunctions-qs:
    HttpExample - [httpTrigger]
        Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample

Azure 上の関数を呼び出す

この関数は HTTP トリガーを使用しているため、呼び出しは、その URL にブラウザーから HTTP 要求を送信するか、または curl などのツールを使用して行います。

ブラウザー
curl

publish コマンドの出力に表示されている完全な呼び出し URL にクエリパラメーター ?name=Functions を追加して、ブラウザーのアドレスバーにコピーします。関数をローカルで実行したときと同様の出力がブラウザーに表示されるはずです。

Azure 上で実行された関数の出力をブラウザーで表示したところ

凖リアルタイムのストリーミングログを表示するには、次のコマンドを実行します。

func azure functionapp logstream <APP_NAME>

別のターミナルウィンドウまたはブラウザーで、もう一度リモート関数を呼び出します。 Azure で実行された関数の詳細ログがターミナルに表示されます。

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

次の手順に進んで Azure Storage キュー出力バインディングを追加する場合、既存の作業をベースにするので、リソースはすべてそのままにしておいてください。

それ以外の場合は、追加コストの発生を避けるために、次のコマンドを使用して、リソースグループとそこに含まれるすべてのリソースを削除してください。

Azure CLI
Azure PowerShell

az group delete --name AzureFunctionsQuickstart-rg

Remove-AzResourceGroup -Name AzureFunctionsQuickstart-rg

次のステップ

Azure Storage キューに接続する

次の方法で共有

クイックスタート: コマンドラインから Azure に PowerShell 関数を作成する

ローカル環境を構成する

Azure Functions Core Tools のインストール

Ubuntu

Debian

ローカル関数プロジェクトを作成する

(省略可) ファイルの内容を確認する

run.ps1

function.json

関数をローカルで実行する

関数用の関連 Azure リソースを作成する

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

Azure 上の関数を呼び出す

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

次のステップ

フィードバック

その他のリソース

次の方法で共有

クイックスタート: コマンド ラインから Azure に PowerShell 関数を作成する

ローカル環境を構成する

Azure Functions Core Tools のインストール

ローカル関数プロジェクトを作成する

(省略可) ファイルの内容を確認する

run.ps1

function.json

関数をローカルで実行する

関数用の関連 Azure リソースを作成する

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

Azure 上の関数を呼び出す

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

次のステップ

フィードバック

その他のリソース

クイックスタート: コマンドラインから Azure に PowerShell 関数を作成する