Azure Functions を使用して Azure SQL Database に接続する

[アーティクル]
04/27/2023

この記事では、Azure Functions を使用して Azure SQL Database または Azure SQL Managed Instance に接続するスケジュール済みジョブを作成する方法を示します。この関数コードは、データベース内のテーブル内の行をクリーンアップします。この新しい C# 関数は、Visual Studio 2019 の定義済みタイマートリガーテンプレートに基づいて作成されます。このシナリオを実現するには、別途データベースの接続文字列を関数アプリのアプリ設定として設定する作業が必要となります。 Azure SQL Managed Instance の場合は、Azure Functions から接続できるようにパブリックエンドポイントを有効にする必要があります。このシナリオではデータベースに対する一括操作を使用しています。

C# 関数を初めて使用する場合は、Azure Functions C# 開発者向けリファレンスをお読みください。

前提条件

「Visual Studio を使用して初めての関数を作成する」記事の手順が完了しており、バージョン 2.x 以降のランタイムを対象としたローカル関数アプリを作成しています。また、プロジェクトを Azure の関数アプリに発行している必要があります。
この記事では、AdventureWorksLT サンプルデータベースの SalesOrderHeader テーブルに対して一括クリーンアップ操作を実行する Transact-SQL コマンドの例を取り上げています。 AdventureWorksLT サンプルデータベースを作成するには、Azure portal を使用して Azure SQL Database でデータベースを作成する方法に関する記事の手順を実行します。
このクイックスタートに使用するコンピューターのパブリック IP アドレスに対するサーバーレベルのファイアウォール規則を追加している必要があります。このルールは、ローカルコンピューターから SQL Database インスタンスにアクセスできるようにするために必要です。

接続情報の取得

Azure portal を使用して Azure SQL Database でデータベースを作成する方法に関する記事の手順で作成したデータベースの接続文字列を取得する必要があります。

Azure portal にサインインします。
左側のメニューから [SQL データベース] を選択し、 [SQL データベース] ページで目的のデータベースをクリックします。
[Settings] \(設定) の下の [接続文字列] を選択し、完全な ADO.NET の接続文字列をコピーします。 Azure SQL Managed Instance の場合は、パブリックエンドポイントの接続文字列をコピーします。

接続文字列の設定

Function App は、Azure での関数の実行をホストします。セキュリティ上、接続文字列をはじめとするシークレットは、関数アプリの設定に保存することをお勧めします。アプリケーション設定を使用して、コードによって誤って接続文字列が公開されることを防ぎます。関数アプリのアプリ設定には、Visual Studio から直接アクセスできます。

以前アプリを Azure に発行している必要があります。まだ行っていない場合は、[Publish your function app to Azure]\(関数アプリを Azure に発行) します。

ソリューションエクスプローラーで関数アプリプロジェクトを右クリックし、 [発行] を選択します。
[発行] ページで [ホスティング] 領域から省略記号 (...) を選択し、 [Azure App Service の設定を管理する] を選択します。
[アプリケーション設定] で [設定の追加] を選択し、 [新しいアプリ設定名] で「sqldb_connection」と入力して [OK] を選択します。
新しい sqldb_connection の設定で、前のセクションでコピーした接続文字列を [Local] \(ローカル) フィールドに貼り付け、{your_username} および {your_password} プレースホルダーを実際の値で置き換えます。 [ローカルから値を挿入する] を選択し、更新した値を [Remote] \(リモート) フィールドにコピーして [OK] を選択します。

接続文字列は、Azure で暗号化されて格納されます (リモート)。シークレットの漏えいを防ぐため、.gitignore ファイルなどを使用して local.settings.json プロジェクトファイル (ローカル) をソース管理から除外します。

SqlClient パッケージをプロジェクトに追加する

SqlClient ライブラリを含む NuGet パッケージを追加する必要があります。 SQL Database への接続には、このデータアクセスライブラリが必要です。

Visual Studio 2022 でローカル関数アプリプロジェクトを開きます。
ソリューションエクスプローラーで関数アプリプロジェクトを右クリックし、 [NuGet パッケージの管理] を選択します。
[参照] タブで Microsoft.Data.SqlClient を探し、見つかったらそれを選択します。
[Microsoft.Data.SqlClient] ページで、バージョン 5.1.0 を選択して、[インストール] をクリックします。
インストールが完了したら変更を確認し、 [OK] をクリックして [プレビュー] ウィンドウを閉じます。
[ライセンスへの同意] ウィンドウが表示された場合は [同意する] をクリックします。

それでは、SQL Database に接続する C# 関数のコードを追加しましょう。

タイマーでトリガーされる関数を追加する

ソリューションエクスプローラーで関数アプリプロジェクトを右クリックし、 [Add] \(追加)>[新しい Azure 関数] を選択します。
Azure Functions テンプレートを選択し、新しい項目に DatabaseCleanup.cs などの名前を付けて、 [Add] \(追加) を選択します。
[新しい Azure 関数] ダイアログボックスで、[タイマートリガー]、[追加]の順に選択します。このダイアログで、タイマートリガー関数のコードファイルが作成されます。
新しいコードファイルを開き、次の using ステートメントをファイルの先頭に追加します。
```
using Microsoft.Data.SqlClient;
using System.Threading.Tasks;
```

既存の Run 関数を次のコードに置き換えます。

[FunctionName("DatabaseCleanup")]
public static async Task Run([TimerTrigger("*/15 * * * * *")]TimerInfo myTimer, ILogger log)
{
    // Get the connection string from app settings and use it to create a connection.
    var str = Environment.GetEnvironmentVariable("sqldb_connection");
    using (SqlConnection conn = new SqlConnection(str))
    {
        conn.Open();
        var text = "UPDATE SalesLT.SalesOrderHeader " +
                "SET [Status] = 5  WHERE ShipDate < GetDate();";

        using (SqlCommand cmd = new SqlCommand(text, conn))
        {
            // Execute the command and log the # rows affected.
            var rows = await cmd.ExecuteNonQueryAsync();
            log.LogInformation($"{rows} rows were updated");
        }
    }
}

この関数は 15 秒間隔で実行され、出荷日に基づいて Status 列を更新します。タイマートリガーの詳細については、「Azure Functions のタイマートリガー」を参照してください。

F5 キーを押して関数アプリを起動します。 Visual Studio の背後で [Azure Functions Core Tools] 実行ウィンドウが開きます。
起動後 15 秒で、関数が実行されます。出力を確認し、更新された SalesOrderHeader テーブルの行数に注意してください。

最初の実行では、32 行のデータを更新する必要があります。以降の実行では、UPDATE ステートメントで行が選択されるように SalesOrderHeader テーブルのデータに変更を加えた場合を除き、データ行は更新されません。

この関数を発行する予定がある場合は、TimerTrigger 属性を 15 秒ごとよりも適切な cron スケジュールに変更してください。関数アプリが Azure SQL Database または Azure SQL Managed Instance にアクセスできることを確認する必要もあります。詳細については、使用している Azure SQL の種類に応じて、次のいずれかのリンクを参照してください。

次のステップ

次に、使用方法を学習します。 Logic Apps で Functions を使用して、その他のサービスと統合します。

Logic Apps と統合される関数を作成する

関数の詳細については、次の記事をご覧ください。

Azure Functions 開発者向けリファレンス
関数のコーディングとトリガーおよびバインドの定義に関するプログラマ向けリファレンスです。
Azure Functions のテスト
関数をテストするための各種ツールと手法について説明します。