.NET と Microsoft.Data.SqlClient ライブラリを使って Azure SQL Database に接続し、クエリを実行する

適用対象: Azure SQL Database

このクイックスタートでは、.NET と Microsoft.Data.SqlClient ライブラリを使って Azure SQL Database 内のデータベースにアプリケーションを接続し、クエリを実行する方法について説明します。 このクイックスタートでは、データベースに接続するための推奨されるパスワードレス アプローチに従います。 パスワードレス接続について詳しくは、パスワードレス ハブに関する記事を参照してください。

前提条件

• Azure サブスクリプション。
• Microsoft Entra ID (旧称 Azure Active Directory) を使用して認証を構成した Azure SQL データベース。 データベースの作成クイックスタートを使用して作成できます。
• 最新バージョンの Azure CLI。
• ASP.NET と Web 開発ワークロードを含む Visual Studio 以降。
• .NET 7.0 以降。

データベースを構成する

Azure SQL Database への安全なパスワードレス接続には、特定のデータベース構成が必要です。 Azure の論理サーバーで次の設定を確認し、ローカル環境とホスト環境の両方で Azure SQL Database に適切に接続します。

1. ローカル開発の接続の場合は、ローカル コンピューターの IP アドレスやその他の Azure サービスで接続できるように論理サーバーが構成されていることを確認します。

   • お使いのサーバーの [ネットワーク] ページに移動します。

   • [選択されたネットワーク] ラジオ ボタンを切り替えて、追加の構成オプションを表示します。

   • [Add your client IPv4 address(xx.xx.xx.xx)] (クライアント IPv4 アドレスの追加 (xx.xx.xx.xx)) を選び、ローカル コンピューターの IPv4 アドレスからの接続を有効にするファイアウォール規則を追加します。 または、[+ Add a firewall rule] (ファイアウォール規則の追加) を選び、選んだ特定の IP アドレスを入力することもできます。

   • [Azure サービスおよびリソースにこのサーバーへのアクセスを許可する] チェックボックスがオンになっていることを確認します。

     

     警告

     [Azure サービスおよびリソースにこのサーバーへのアクセスを許可する] 設定を有効にすることは、運用環境のシナリオでは推奨されるセキュリティ プラクティスではありません。 実際のアプリケーションでは、より強力なファイアウォール制限や仮想ネットワーク構成など、より安全なアプローチを実装する必要があります。

     データベース セキュリティの構成について詳しくは、次のリソースを参照してください。

     • Azure SQL Database ファイアウォール規則を構成する。
     • プライベート エンドポイントを使用して仮想ネットワークを構成する。

2. また、サーバーでは Microsoft Entra 認証が有効になっており、Microsoft Entra 管理者アカウントが割り当てられている必要があります。 ローカル開発接続の場合、Microsoft Entra 管理者アカウントは、ローカルで Visual Studio または Azure CLI にログインできるアカウントである必要があります。 論理サーバーの Microsoft Entra ID ページで、サーバーで Microsoft Entra 認証が有効になっているかどうかを確認できます。

   

3. 個人の Azure アカウントを使用している場合は、アカウントをサーバー管理者として割り当てるために、Microsoft Entra がセットアップされ、Azure SQL Database 用に構成されていることを確認してください。企業アカウントを使用している場合は、Microsoft Entra ID がおそらくすでに構成済みになっています。

プロジェクトを作成する

次の手順では、.NET CLI または Visual Studio 2022 のいずれかを使って、.NET の最小限の Web API を作成します。

Microsoft.Data.SqlClient ライブラリを追加する

.NET を使って Azure SQL Database に接続するには、Microsoft.Data.SqlClient をインストールします。 このパッケージは、データベースへの接続、コマンドの実行、結果の取得を行うためのデータ プロバイダーとして機能します。

dotnet add package Microsoft.Data.SqlClient

接続文字列の構成

"ConnectionStrings": {
    "AZURE_SQL_CONNECTIONSTRING": "Server=tcp:<database-server-name>.database.windows.net,1433;Initial Catalog=<database-name>;Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Authentication=\"Active Directory Default\";"
}

"ConnectionStrings": {
    "AZURE_SQL_CONNECTIONSTRING": "Server=tcp:<database-server-name>.database.windows.net,1433;Initial Catalog=<database-name>;Persist Security Info=False;User ID=<user-id>;Password=<password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;"
}

Azure SQL Database に接続するコードを追加する

Program.cs ファイルの内容を、以下の重要な手順を行う次のコードに置き換えます。

• appsettings.json からパスワードレスの接続文字列を取得する
• 起動時にデータベース内に Persons テーブルを作成する (テスト シナリオのみ)
• Persons テーブルに格納されているすべてのレコードを取得する HTTP GET エンドポイントを作成します
• Persons テーブルに新しいレコードを追加する HTTP POST エンドポイントを作成します

using Microsoft.Data.SqlClient;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// For production scenarios, consider keeping Swagger configurations behind the environment check
// if (app.Environment.IsDevelopment())
// {
    app.UseSwagger();
    app.UseSwaggerUI();
// }

app.UseHttpsRedirection();

string connectionString = app.Configuration.GetConnectionString("AZURE_SQL_CONNECTIONSTRING")!;

try
{
    // Table would be created ahead of time in production
    using var conn = new SqlConnection(connectionString);
    conn.Open();

    var command = new SqlCommand(
        "CREATE TABLE Persons (ID int NOT NULL PRIMARY KEY IDENTITY, FirstName varchar(255), LastName varchar(255));",
        conn);
    using SqlDataReader reader = command.ExecuteReader();
}
catch (Exception e)
{
    // Table may already exist
    Console.WriteLine(e.Message);
}

app.MapGet("/Person", () => {
    var rows = new List<string>();

    using var conn = new SqlConnection(connectionString);
    conn.Open();

    var command = new SqlCommand("SELECT * FROM Persons", conn);
    using SqlDataReader reader = command.ExecuteReader();

    if (reader.HasRows)
    {
        while (reader.Read())
        {
            rows.Add($"{reader.GetInt32(0)}, {reader.GetString(1)}, {reader.GetString(2)}");
        }
    }

    return rows;
})
.WithName("GetPersons")
.WithOpenApi();

app.MapPost("/Person", (Person person) => {
    using var conn = new SqlConnection(connectionString);
    conn.Open();

    var command = new SqlCommand(
        "INSERT INTO Persons (firstName, lastName) VALUES (@firstName, @lastName)",
        conn);

    command.Parameters.Clear();
    command.Parameters.AddWithValue("@firstName", person.FirstName);
    command.Parameters.AddWithValue("@lastName", person.LastName);

    using SqlDataReader reader = command.ExecuteReader();
})
.WithName("CreatePerson")
.WithOpenApi();

app.Run();

最後に、Person クラスを Program.cs ファイルの下部に追加します。 このクラスは、データベースの Persons テーブル内の 1 つのレコードを表します。

public class Person
{
    public required string FirstName { get; set; }
    public required string LastName { get; set; }
}

アプリをローカルで実行してテストする

アプリをローカルでテストする準備ができました。 データベースの管理者として設定したのと同じアカウントを使って、Visual Studio または Azure CLI にサインインしていることを確認します。

1. Visual Studio の上部にある実行ボタンを押して、API プロジェクトを起動します。

2. Swagger UI ページで、POST メソッドを展開し、[テスト] を選択します。

3. 姓と名の値を含むようにサンプル JSON を変更します。 [実行] を選択して、新しいレコードをデータベースに追加します。 API は正常な応答を返します。

   

4. Swagger UI ページで GET メソッドを展開し、[テスト] を選択します。 [実行] を選択すると、先ほど作成した人物が返されます。

Azure App Service にデプロイする

アプリを Azure にデプロイする準備ができました。 Visual Studio によって、1 つのワークフローで Azure アプリ サービスを作成し、アプリケーションをデプロイできます。

1. アプリが停止していることと、正常にビルドされていることを確認します。

2. Visual Studio の [ソリューション エクスプローラー] ウィンドウで、最上位レベルのプロジェクト ノードを右クリックし、[発行] を選択します。

3. 発行ダイアログで、デプロイ ターゲットとして [Azure] を選んでから、[次へ] を選択します。

4. 具体的なターゲットとしては、[Azure App Service (Windows)] を選択し、[次へ] を選択します。

5. [+] アイコンを選択して、デプロイ先となる新しい App Service を作成し、次の値を入力します。

   • 名前: 既定値のままにします。

   • サブスクリプション名: デプロイするサブスクリプションを選択します。

   • [リソース グループ]: [新規] を選択し、msdocs-dotnet-sql という名前の新しいリソース グループを作成します。

   • [ホスティング プラン]: [新規] を選択して、ホスティング プラン ダイアログを開きます。 既定値のままにして [OK] を選択します。

   • [作成] 選択して、元のダイアログを閉じます。 Visual Studio によって、Azure に App Service リソースが作成されます。

     

6. リソースが作成されたら、それがアプリ サービスの一覧で選択されていることを確認してから、[次へ] を選択します。

7. [API Management] の手順で、下部にある [この手順をスキップする] チェックボックスをオンにし、[完了] を選択します。

8. [終了] 手順で、ダイアログが自動的に閉じない場合は [閉じる] を選択します。

9. 発行プロファイルの概要の右上にある [発行] を選択して、アプリを Azure にデプロイします。

デプロイが完了すると、Visual Studio によってブラウザーが起動され、ホストされているアプリが表示されますが、この時点ではアプリは Azure で正しく動作しません。 データを取得するために、App Service と SQL データベースの間にセキュリティで保護された接続を構成する必要があります。

App Service を Azure SQL Database に接続する

az webapp connection create sql \
    -g <app-service-resource-group> \
    -n <app-service-name> \
    --tg <database-server-resource-group> \
    --server <database-server-name> \
    --database <database-name> \
    --system-identity

デプロイされたアプリケーションをテストする

1. App Service の [概要] ページの上部にある [参照] ボタンを選択して、アプリのルート URL を起動します。

2. URL に /swagger/index.html パスを追加して、ローカルで使用したのと同じ Swagger テスト ページを読み込みます。

3. GET および POST 要求のテストを実行して、エンドポイントが期待どおりに動作することを確認します。

おめでとうございます。 これで、ローカル環境とホスト環境の両方で、アプリケーションを Azure SQL Database に接続することができました。

リソースのクリーンアップ

Azure SQL Database の操作が完了したら、意図しないコストを回避するためにリソースを削除します。

az sql db delete --name <database-name> --resource-group <resource-group-name> --server <logical-server-name>