Краткое руководство: создание приложения ASP.NET Core с помощью Azure App Configuration

В этом кратком руководстве вы будете использовать службу конфигурации приложений Azure для выноса на внешний ресурс хранения и управления настройками вашего приложения для приложения ASP.NET Core. ASP.NET Core создает один объект конфигурации на основе ключа с использованием параметров от одного или нескольких поставщиков конфигурации. Конфигурация приложений предоставляет библиотеку поставщика конфигурации .NET. Таким образом, вы можете использовать Конфигурация приложений в качестве дополнительного источника конфигурации для приложения. Если у вас есть существующее приложение, чтобы начать использовать Конфигурация приложений, вам потребуется лишь несколько небольших изменений в коде запуска приложения.

• Учетная запись Azure с активной подпиской. Создайте ее бесплатно.
• Хранилище конфигурации приложений, как показано в руководстве по созданию хранилища.
• Пакет SDK для .NET версии 6.0 или более поздней версии

Добавьте следующие ключевые значения в хранилище Конфигурация приложений и оставьте метку и тип контента со значениями по умолчанию. Дополнительные сведения о добавлении значений ключей в хранилище с помощью портал Azure или ИНТЕРФЕЙСА командной строки см. в разделе "Создание значения ключа".

Используйте интерфейс командной строки .NET (CLI), чтобы создать проект веб-приложения ASP.NET Core. Azure Cloud Shell предоставляет эти инструменты. Они также доступны на платформах Windows, macOS и Linux.

Выполните следующую команду, чтобы создать веб-приложение ASP.NET Core в новой папке TestAppConfig :

dotnet new webapp --output TestAppConfig

Подключитесь к вашему хранилищу конфигурации приложения, используя Microsoft Entra ID (рекомендуется) или строки подключения.

1. Перейдите в каталог TestAppConfig проекта и выполните следующую команду, чтобы добавить ссылки на пакеты NuGet.

   • Идентификатор Microsoft Entra (рекомендуется)
   • Строка соединения

   dotnet add package Microsoft.Azure.AppConfiguration.AspNetCore
   dotnet add package Azure.Identity
   

2. Создайте секрет пользователя для приложения, перейдя в папку TestAppConfig и выполнив следующую команду.

   • Идентификатор Microsoft Entra (рекомендуется)
   • Строка соединения

   Команда использует Диспетчер секретов для хранения секрета с именем Endpoints:AppConfiguration, который сохраняет конечную точку для хранилища конфигурации приложений. Замените заполнитель <your-App-Configuration-endpoint> конечной точкой хранилища параметров вашего приложения. Конечную точку можно найти на вкладке Обзор в хранилище параметров приложений в портале Azure.

   dotnet user-secrets init
   dotnet user-secrets set Endpoints:AppConfiguration "<your-App-Configuration-endpoint>"
   

3. Откройте Program.cs и добавьте следующие пространства имен:

   • Идентификатор Microsoft Entra (рекомендуется)
   • Строка соединения

   using Microsoft.Extensions.Configuration;
   using Microsoft.Azure.AppConfiguration.AspNetCore;
   using Azure.Identity;
   

4. Подключитесь к хранилищу конфигурации приложения AddAzureAppConfiguration, вызвав метод в файле Program.cs.

   • Идентификатор Microsoft Entra (рекомендуется)
   • Строка соединения

   Вы используете DefaultAzureCredential для аутентификации в вашем хранилище Конфигурации приложений. Следуйте инструкциям, чтобы назначить вашим учетным данным роль Чтение данных конфигурации приложений. Перед запуском приложения обязательно предоставьте достаточно времени для распространения разрешения.

   var builder = WebApplication.CreateBuilder(args); 
   
   // Retrieve the endpoint
   string endpoint = builder.Configuration.GetValue<string>("Endpoints:AppConfiguration")
       ?? throw new InvalidOperationException("The setting `Endpoints:AppConfiguration` was not found.");
   
   // Load configuration from Azure App Configuration 
   builder.Configuration.AddAzureAppConfiguration(options =>
   {
       options.Connect(new Uri(endpoint), new DefaultAzureCredential());
   });
   
   // The rest of existing code in program.cs
   // ... ...    
   

   Этот код загружает все значения ключей, не имеющие метки из хранилища Конфигурация приложений. Дополнительные сведения о загрузке данных из Конфигурации приложений см. в справочнике API поставщика Конфигурации приложений.

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

1. Добавьте файл Settings.cs в корневой каталог проекта. Он определяет строго типизированный Settings класс для используемой конфигурации. Замените пространство имен именем проекта.

   namespace TestAppConfig
   {
       public class Settings
       {
           public string BackgroundColor { get; set; }
           public long FontSize { get; set; }
           public string FontColor { get; set; }
           public string Message { get; set; }
       }
   }
   

2. Привяжите раздел TestApp:Settings в конфигурации к объекту Settings.

   Обновите Program.cs со следующим кодом и добавьте TestAppConfig пространство имен в начале файла.

   using TestAppConfig;
   
   // Existing code in Program.cs
   // ... ...
   
   builder.Services.AddRazorPages();
   
   // Bind configuration "TestApp:Settings" section to the Settings object
   builder.Services.Configure<Settings>(builder.Configuration.GetSection("TestApp:Settings"));
   
   var app = builder.Build();
   
   // The rest of existing code in program.cs
   // ... ...
   

3. Откройте Index.cshtml.cs в каталоге Pages и обновите IndexModel класс следующим кодом. using Microsoft.Extensions.Options Добавьте пространство имен в начале файла, если он еще не существует.

   public class IndexModel : PageModel
   {
       private readonly ILogger<IndexModel> _logger;
   
       public Settings Settings { get; }
   
       public IndexModel(IOptionsSnapshot<Settings> options, ILogger<IndexModel> logger)
       {
           Settings = options.Value;
           _logger = logger;
       }
   }
   

4. Откройте Index.cshtml в каталоге Pages и обновите содержимое следующим кодом.

   @page
   @model IndexModel
   @{
       ViewData["Title"] = "Home page";
   }
   
   <style>
       body {
           background-color: @Model.Settings.BackgroundColor;
       }
   
       h1 {
           color: @Model.Settings.FontColor;
           font-size: @(Model.Settings.FontSize)px;
       }
   </style>
   
   <h1>@Model.Settings.Message</h1>
   

1. Чтобы создать приложение с помощью интерфейса командной строки .NET, перейдите в корневой каталог проекта. Выполните приведенную ниже команду в командной оболочке.

   dotnet build
   

2. Когда создание завершится, запустите веб-приложение локально с помощью следующей команды:

   dotnet run
   

3. Выходные данные dotnet run команды содержат два URL-адреса. Откройте браузер и перейдите к одному из этих URL-адресов, чтобы получить доступ к приложению. Например: https://localhost:5001.

   Если вы работаете в Azure Cloud Shell, нажмите кнопку Просмотр в Интернете, а затем — Настроить. При появлении запроса на настройку порта для предварительной версии введите 5000 и нажмите кнопку "Открыть и просмотреть".

   

   Веб-страница выглядит следующим образом:

Если вы не планируете в дальнейшем использовать ресурсы, созданные при работе с этой статьей, удалите созданную группу ресурсов, чтобы избежать расходов.

1. Войдите на портал Azure и выберитеГруппы ресурсов.
2. Введите имя группы ресурсов в поле Фильтровать по имени.
3. В списке результатов выберите имя группы ресурсов, чтобы просмотреть общие сведения.
4. Выберите команду Удалить группу ресурсов.
5. Подтвердите операцию удаления группы ресурсов. Введите имя группы ресурсов, которую необходимо удалить, и нажмите Удалить.

Через некоторое время группа ресурсов и все ее ресурсы будут удалены.

В этом кратком руководстве вы сможете:

• Подготовлено новое хранилище конфигураций приложений.
• Подключено к хранилищу конфигурации приложений с использованием библиотеки провайдера конфигурации приложений.
• Считайте ключ-значения хранилища конфигурации приложения с помощью библиотеки поставщика конфигурации.
• Отображается веб-страница с параметрами, настроенными в хранилище Конфигурация приложений.

Чтобы узнать, как настроить веб-приложение ASP.NET Core для динамического обновления параметров конфигурации, перейдите к следующему руководству.