Подключение и работа с запросами к базе данных SQL Azure с использованием .NET и Entity Framework Core

Применимо к: База данных SQL Azure

Этот быстрый старт описывает, как подключить приложение к базе данных в База данных SQL Azure и выполнять запросы с помощью .NET и Entity Framework Core. В этом кратком руководстве описан рекомендуемый подход без пароля для подключения к базе данных. Чтобы узнать больше о соединениях без пароля, смотрите раздел «Без пароля».

Предварительные требования

• Подписка Azure
• База данных SQL, настроенная для проверки подлинности с помощью идентификатора Microsoft Entra (ранее — Azure Active Directory). Вы можете создать её, используя Краткое руководство: Создание одной базы данных — База данных SQL Azure.
• .NET 10.0 или выше.
• Visual Studio или более поздней версии с рабочей нагрузкой ASP.NET и веб-разработки .
• Последняя версия Azure CLI.
• Последняя версия инструментов Entity Framework Core:
  • Пользователи Visual Studio должны установить средства консоли диспетчер пакетов для Entity Framework Core.
  • Пользователи .NET CLI должны установить средства .NET CLI для Entity Framework Core.

Настройка сервера базы данных

Безопасные, безпарольные подключения к базе данных SQL Azure требуют определенных конфигураций базы данных. Проверьте следующие параметры на логическом сервере в Azure, чтобы правильно подключиться к База данных SQL Azure в локальных и размещенных средах:

1. Для локальных подключений разработки убедитесь, что логический сервер SQL Azure настроен, чтобы разрешить подключение к локальному IP-адресу компьютера и другим службам Azure:

   1. На портале Azure в меню ресурсов в разделе "Безопасность" выберите "Сеть".

   2. Нажмите кнопку "Выбранные сети" , чтобы отобразить дополнительные параметры конфигурации.

   3. Выберите Добавить IP-адрес клиента (xx.xx.xx.xx), чтобы добавить правило брандмауэра, которое будет разрешать подключения с адреса IPv4 локального компьютера. Кроме того, можно выбрать + Добавить правило брандмауэра, чтобы ввести конкретный IP-адрес.

   4. Убедитесь, что установлен флажок разрешить службам и ресурсам Azure доступ к этому серверу .

      

      Предупреждение

      Включение настройки Разрешить службам и ресурсам Azure доступ к этому серверу не является рекомендуемой практикой безопасности для производственной среды. Реальные приложения должны реализовать более безопасные подходы, такие как более строгие ограничения брандмауэра или конфигурации виртуальной сети.

      Дополнительные сведения о конфигурациях безопасности базы данных см. в следующих ресурсах:

      • Настройте правила брандмауэра База данных SQL Azure.
      • Настройте виртуальную сеть с частными конечными точками.

2. На сервере также должна быть включена проверка подлинности Microsoft Entra и назначена учетная запись администратора Microsoft Entra. Для локальных подключений к разработке учетная запись администратора Microsoft Entra должна быть такой учетной записью, в которую можно также войти в Visual Studio или локально через Azure CLI. Вы можете проверить, включена ли проверка подлинности Microsoft Entra на странице Microsoft Entra ID на вашем логическом сервере.

   

3. Если вы используете личную учетную запись Azure, убедитесь, что Microsoft Entra настроена и сконфигурирована для базы данных Azure SQL, чтобы назначить вашу учетную запись администратором сервера. Если вы используете корпоративную учетную запись, Microsoft Entra ID, скорее всего, уже настроен для вас.

Создание проекта

В этом разделе описано, как создать минимальный веб-API .NET с помощью .NET CLI или Visual Studio 2022.

Добавление Entity Framework Core в проект

Чтобы подключиться к База данных SQL Azure с помощью .NET и Entity Framework Core, добавьте в ваш проект следующие пакеты NuGet, используя один из следующих методов:

dotnet add package Microsoft.EntityFrameworkCore
dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.EntityFrameworkCore.Design
dotnet add package Microsoft.AspNetCore.OpenApi
dotnet add package Swashbuckle.AspNetCore.SwaggerUI

Добавление кода для подключения к База данных SQL Azure

Библиотеки Entity Framework Core полагаются на библиотеки Microsoft.Data.SqlClient и Azure.Identity для реализации безпарольных подключений к базе данных SQL Azure. Библиотека Azure.Identity предоставляет класс DefaultAzureCredential , который обрабатывает проверку подлинности без пароля в Azure.

DefaultAzureCredential поддерживает несколько методов проверки подлинности и определяет, какие из них следует использовать во время выполнения. Такой подход позволяет приложению использовать различные способы проверки подлинности в разных средах (локальной и рабочей) без реализации кода для конкретной среды. Обзор библиотеки удостоверений Azure объясняет, в каком порядке и в каких местах ищет учетные данные.

Выполните следующие действия, чтобы подключиться к База данных SQL Azure с помощью Entity Framework Core и базового DefaultAzureCredential класса:

1. ConnectionStrings Добавьте раздел в appsettings.Development.json файл, чтобы он соответствовал следующему коду. Замените <server>.database.windows.net именем сервера базы данных без пароля, к которому вы хотите подключиться, и <database> именем базы данных.

   {
       "Logging": {
           "LogLevel": {
               "Default": "Information",
               "Microsoft.AspNetCore": "Warning"
           }
       },
       "ConnectionStrings": {
           "AZURE_SQL_CONNECTIONSTRING": "Data Source=<server>.database.windows.net;Initial Catalog=<database>;Authentication=Active Directory Default;Encrypt=True;"
       }
   }
   

   Примечание.

   Не забудьте обновить плейсхолдеры <your database-server-name> и <your-database-name> в строке подключения к базе данных. Строки подключения без пароля можно безопасно хранить в системах управления версиями, так как они не содержат секретной информации, такой как имена пользователей, пароли или ключи доступа.

   Строка подключения без пароля включает значение Authentication=Active Directory Default конфигурации, позволяющее Entity Framework Core использовать DefaultAzureCredential для подключения к службам Azure. При локальном запуске приложение проходит проверку подлинности с помощью пользователя, с которым вы вошли в Visual Studio. После развертывания приложения в Azure тот же код обнаруживает и применяет управляемое удостоверение, связанное с размещенным приложением, которое вы настраиваете позже.

2. Замените содержимое файла Program.cs приведенным ниже кодом.

   using Microsoft.EntityFrameworkCore;
   
   var builder = WebApplication.CreateBuilder();
   
   builder.Services.AddOpenApi();
   
   var connection = string.Empty;
   if (builder.Environment.IsDevelopment())
   {
       builder.Configuration.AddEnvironmentVariables().AddJsonFile("appsettings.Development.json");
       connection = builder.Configuration.GetConnectionString("AZURE_SQL_CONNECTIONSTRING");
   }
   else
   {
       connection = Environment.GetEnvironmentVariable("AZURE_SQL_CONNECTIONSTRING");
   }
   
   builder.Services.AddDbContext<PersonDbContext>(options =>
       options.UseSqlServer(connection));
   
   var app = builder.Build();
   
   if (app.Environment.IsDevelopment())
   {
       app.MapOpenApi();
       app.UseSwaggerUI(options =>
       {
           options.SwaggerEndpoint("/openapi/v1.json", "v1");
       });
   }
   
   app.MapGet("/", () => "Hello world!");
   
   app.MapGet("/Person", (PersonDbContext context) => context.Person.ToList());
   
   app.MapPost("/Person", (Person person, PersonDbContext context) =>
   {
       context.Add(person);
       context.SaveChanges();
   });
   
   app.Run();
   
   public class Person
   {
       public int Id { get; set; }
       public string FirstName { get; set; }
       public string LastName { get; set; }
   }
   
   public class PersonDbContext(DbContextOptions<PersonDbContext> options) : DbContext(options)
   {
       public DbSet<Person> Person { get; set; }
   }
   

   Предыдущий код обрабатывает следующие действия:

   • Извлекает строку подключения без пароля из файла appsettings.Development.json для локальной разработки или из переменных среды в производственных средах.
   • Регистрирует класс Entity Framework Core DbContext в контейнере внедрения зависимостей .NET. Дополнительные сведения о DbContext см. в документации «Начало работы» для Entity Framework Core.
   • Настраивает поддержку .NET 10.0 OpenAPI с помощью SwaggerUI для предоставления интерфейса, который можно использовать для взаимодействия с конечными точками приложения и базой данных.
   • Добавляет конечные точки для извлечения и добавления сущностей в базу данных.
   • Определяет Person класс для представления одной записи в Persons таблице базы данных и PersonDbContext класса, зарегистрированного в контейнере внедрения зависимостей .NET.

Запуск миграций для создания базы данных

Чтобы обновить схему базы данных в соответствии с вашей моделью данных с помощью Entity Framework Core, используйте миграцию. Миграции могут создавать и постепенно обновлять схему базы данных, чтобы обеспечить синхронизацию с моделью данных приложения. Чтобы узнать больше об этой закономерности, ознакомьтесь с обзором миграций.

локальное тестирование приложения.

Приложение готово к локальному тестированию. Убедитесь, что вы вошли в Visual Studio или Azure CLI с той же учётной записью, которую вы установили в качестве администратора вашей базы данных.

1. Выберите кнопку запуска в верхней части Visual Studio, чтобы запустить проект API.

2. На странице Swagger UI (например, https://localhost:<port>/swagger), разверните метод POST и выберите Try it.

3. Измените пример JSON, чтобы включить значения для имени и имени семейства. Выберите "Выполнить" , чтобы добавить новую запись в базу данных. API возвращает успешный ответ.

   

4. GET Разверните метод на странице пользовательского интерфейса Swagger и выберите "Попробовать". Выберите "Выполнить", а пользователь, который вы только что создали, возвращается.

Развёртывание в Служба приложений Azure

Приложение готово к развертыванию в Azure. Visual Studio может создать службу приложение Azure и развернуть приложение в одном рабочем процессе.

1. Убедитесь, что приложение остановлено и успешно собирается.

2. В окне Обозреватель решений Visual Studio щелкните правой кнопкой мыши узел проекта верхнего уровня и выберите "Опубликовать".

3. В диалоговом окне публикации выберите Azure в качестве цели развертывания, а затем нажмите кнопку Далее.

4. Для конкретного целевого объекта выберите службу приложений Azure (Windows) и нажмите Далее.

5. Щелкните зеленый + значок, чтобы создать новую Служба приложений для развертывания и введите следующие значения:

   • Имя: оставьте значение по умолчанию.
   • Имя подписки: выберите подписку для развертывания.
   • Группа ресурсов: выберите "Создать " и создайте новую группу ресурсов с именем msdocs-dotnet-sql.
   • План размещения: выберите "Создать" , чтобы открыть диалоговое окно плана размещения. Оставьте значения по умолчанию и нажмите кнопку "ОК".
   • Нажмите кнопку "Создать", чтобы закрыть исходное диалоговое окно. Visual Studio создает ресурс Служба приложений в Azure.

   

6. После создания ресурса убедитесь, что вы выбрали его в списке сервисов приложений, а затем выберите «Далее».

7. На шаге Управление API установите флажок "Пропустить этот шаг" в нижней части и нажмите кнопку "Готово".

8. Выберите Опубликовать в правом верхнем углу сводки по профилю публикации, чтобы развернуть приложение в Azure.

По завершении развертывания Visual Studio запустит браузер с размещенным приложением. Вы видите сообщение Hello world из конечной точки по умолчанию. Однако на этом этапе конечные точки базы данных не работают правильно в Azure. Для получения данных необходимо настроить безопасное подключение между Служба приложений и базой данных SQL.

Подключите службу приложений к базе данных SQL Azure

Чтобы подключить экземпляр App Service к База данных SQL Azure, выполните следующие шаги:

1. Создайте управляемое удостоверение для Службы приложений. Библиотека Microsoft.Data.SqlClient, включенная в ваше приложение, автоматически обнаруживает управляемое удостоверение точно так же, как она обнаружила локального пользователя Visual Studio.

2. Создайте пользователя базы данных SQL и свяжите его с управляемым удостоверением App Service.

3. Назначьте роли SQL пользователю базы данных, разрешающим чтение, запись и потенциально другие разрешения.

Вы можете использовать несколько инструментов для реализации следующих шагов:

Тестирование развернутого приложения

Перейдите по URL-адресу приложения, чтобы проверить, работает ли подключение к База данных SQL Azure. URL-адрес приложения можно найти на странице обзора App Service. Добавьте в конец URL-адреса путь /person, чтобы перейти к той же конечной точке, которую вы тестировали локально.

Созданный вами локально человек должен отображаться в браузере. Поздравляем, приложение теперь подключено к базе данных SQL Azure как в локальных, так и в размещенных средах.

Очистка ресурсов

После завершения работы с База данных SQL Azure удалите ресурс, чтобы избежать непредвиденных затрат.

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

Связанный контент

• Руководство. Защита базы данных в База данных SQL Azure
• Предоставить доступ к базе данных База данных SQL Azure
• Общие сведения о возможностях безопасности Базы данных SQL Azure и Управляемого экземпляра SQL
• Сборник схем для решения распространенных требований к безопасности с помощью Базы данных SQL Azure и Управляемого экземпляра SQL Azure