Mulai Cepat: Membuat aplikasi ASP.NET Core dengan Azure App Configuration

Dalam panduan cepat ini, Anda akan menggunakan Azure App Configuration untuk mengeksternalisasi penyimpanan dan pengelolaan pengaturan aplikasi ASP.NET Core Anda. ASP.NET Core membangun satu objek konfigurasi berbasis nilai kunci menggunakan pengaturan dari satu atau beberapa penyedia konfigurasi. App Configuration menawarkan pustaka penyedia konfigurasi .NET. Oleh karena itu, Anda dapat menggunakan App Configuration sebagai sumber konfigurasi tambahan untuk aplikasi Anda. Jika Anda memiliki aplikasi yang sudah ada, untuk mulai menggunakan App Configuration, Anda hanya memerlukan beberapa perubahan kecil pada kode startup aplikasi Anda.

Prasyarat

• Akun Azure dengan langganan aktif. Buat akun gratis.
• Penyimpanan App Configuration, seperti yang ditunjukkan dalam tutorial untuk membuat penyimpanan.
• .NET SDK 6.0 atau yang lebih baru

Petunjuk / Saran

Azure Cloud Shell adalah shell interaktif gratis yang dapat Anda gunakan untuk menjalankan langkah-langkah dalam artikel ini. Ini memiliki alat Azure umum yang telah diinstal sebelumnya, termasuk .NET SDK. Jika Anda masuk ke langganan Azure, luncurkan Azure Cloud Shell dari shell.azure.com. Anda dapat mempelajari selengkapnya mengenai Azure Cloud Shell dengan membaca dokumentasi kami

Menambahkan nilai kunci

Tambahkan nilai kunci berikut ke penyimpanan App Configuration dan biarkan Label dan Tipe Konten dengan nilai defaultnya. Untuk informasi selengkapnya tentang cara menambahkan pasangan kunci-nilai ke penyimpanan menggunakan portal Azure atau CLI, buka Menambahkan pasangan kunci-nilai.

Tombol	Nilai
TestApp:Settings:BackgroundColor	putih
TestApp:Settings:FontColor	hitam
TestApp:Settings:FontSize	24
TestApp:Settings:Message	Data dari Azure App Configuration

Buat aplikasi web ASP.NET Core

Gunakan antarmuka baris perintah (CLI) .NET untuk membuat proyek aplikasi web ASP.NET Core baru. Azure Cloud Shell menyediakan alat tersebut untuk Anda. Alat tersebut juga tersedia di seluruh platform Windows, macOS, dan Linux.

Jalankan perintah berikut untuk membuat aplikasi web ASP.NET Core di folder TestAppConfig baru:

dotnet new webapp --output TestAppConfig

Hubungkan ke penyimpanan Azure App Configuration

Sambungkan ke penyimpanan App Configuration Anda menggunakan ID Microsoft Entra (disarankan), atau string koneksi.

1. Navigasikan ke direktori proyek TestAppConfig, dan jalankan perintah berikut untuk menambahkan referensi paket NuGet.

   ID Microsoft Entra (disarankan)

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

   String koneksi

   dotnet add package Microsoft.Azure.AppConfiguration.AspNetCore
   

2. Buat rahasia pengguna untuk aplikasi dengan menavigasi ke folder TestAppConfig dan menjalankan perintah berikut.

   ID Microsoft Entra (disarankan)

   Perintah ini menggunakan Secret Manager untuk menyimpan sebuah rahasia yang bernama Endpoints:AppConfiguration, yang menyimpan endpoint untuk toko App Configuration Anda. Gantilah placeholder <your-App-Configuration-endpoint> dengan titik akhir dari penyimpanan App Configuration Anda. Anda dapat menemukan titik akhir di panel Gambaran Umum App Configuration store di portal Azure.

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

   String koneksi

   Perintah menggunakan Secret Manager untuk menyimpan rahasia bernama ConnectionStrings:AppConfiguration, yang menyimpan berkas koneksi untuk toko Konfigurasi Aplikasi Anda. Ganti placeholder <your-App-Configuration-connection-string> dengan string koneksi hanya-baca dari penyimpanan App Configuration Anda. Anda dapat menemukan string koneksi di pengaturan Akses penyimpanan App Configuration Anda di portal Azure.

   dotnet user-secrets init
   dotnet user-secrets set ConnectionStrings:AppConfiguration "<your-App-Configuration-connection-string>"
   

   Petunjuk / Saran

   Beberapa shell akan memotong string koneksi kecuali jika string tersebut dalam tanda kutip. Pastikan bahwa output perintah dotnet user-secrets list menampilkan seluruh string koneksi. Jika tidak, silakan jalankan ulang perintah dengan menyertakan string koneksi dalam tanda kutip.

   Secret Manager menyimpan rahasia di luar pohon proyek Anda, yang membantu mencegah berbagi rahasia yang tidak disengaja dalam kode sumber. Ini hanya digunakan untuk menguji aplikasi web secara lokal. Saat aplikasi disebarkan ke Azure seperti App Service, gunakan string Koneksi, Pengaturan aplikasi, atau variabel lingkungan untuk menyimpan string koneksi. Atau, untuk menghindari penggunaan string koneksi sama sekali, Anda dapat terhubung ke App Configuration menggunakan identitas terkelola atau identitas Microsoft Entra lainnya.

3. Buka Program.cs dan tambahkan namespace berikut:

   ID Microsoft Entra (disarankan)

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

   String koneksi

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

4. Hubungkan ke penyimpanan App Configuration Anda dengan memanggil metode AddAzureAppConfiguration pada berkas Program.cs.

   ID Microsoft Entra (disarankan)

   Anda menggunakan DefaultAzureCredential untuk mengautentikasi ke penyimpanan App Configuration Anda. Ikuti instruksi untuk menetapkan kredensial Anda ke dalam peran App Configuration Data Reader. Pastikan untuk mengizinkan waktu yang memadai agar izin disebarluaskan sebelum menjalankan aplikasi Anda.

   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
   // ... ...    
   

   String koneksi

   var builder = WebApplication.CreateBuilder(args);
   
   // Retrieve the connection string
   string connectionString = builder.Configuration.GetConnectionString("AppConfiguration")
       ?? throw new InvalidOperationException("The connection string 'AppConfiguration' was not found.");
   
   // Load configuration from Azure App Configuration
   builder.Configuration.AddAzureAppConfiguration(connectionString);
   
   // The rest of existing code in program.cs
   // ... ...
   

   Kode ini memuat semua nilai kunci yang tidak memiliki label dari penyimpanan App Configuration Anda. Untuk informasi selengkapnya tentang memuat data dari App Configuration, lihat referensi API untuk penyedia App Configuration.

Baca dari penyimpanan konfigurasi aplikasi

Dalam contoh ini, Anda akan memperbarui halaman web untuk menampilkan kontennya menggunakan pengaturan yang Anda konfigurasi di penyimpanan konfigurasi Aplikasi Anda.

1. Tambahkan file Settings.cs di akar direktori proyek Anda. Ini mendefinisikan kelas Settings dengan tipe yang kuat untuk konfigurasi yang akan Anda gunakan. Ganti ruang nama dengan nama proyek Anda.

   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. Ikat bagian TestApp:Settings dalam konfigurasi ke objek Settings.

   Perbarui Program.cs dengan kode berikut dan tambahkan TestAppConfig namespace di awal file.

   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. Buka Index.cshtml.cs di direktori Pages , dan perbarui IndexModel kelas dengan kode berikut. Tambahkan using Microsoft.Extensions.Options namespace di awal file, jika belum ada.

   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. Buka Index.cshtml di direktori Pages , dan perbarui konten dengan kode berikut.

   @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>
   

Membangun dan menjalankan aplikasi secara lokal

1. Untuk membuat aplikasi menggunakan .NET CLI, navigasikan ke direktori akar proyek Anda. Jalankan perintah berikut pada terminal perintah:

   dotnet build
   

2. Setelah pembangunan berhasil diselesaikan, jalankan perintah berikut untuk menjalankan aplikasi secara lokal:

   dotnet run
   

3. Output dari perintah dotnet run berisi dua URL. Buka browser dan navigasi ke salah satu URL ini untuk mengakses aplikasi Anda. Misalnya: https://localhost:5001.

   Jika Anda bekerja pada Azure Cloud Shell, pilih tombol Pratinjau Web diikuti dengan Konfigurasikan. Ketika diminta untuk mengonfigurasi port untuk pratinjau, masukkan 5000, dan pilih Buka dan telusuri.

   

   Halaman web terlihat seperti ini:

Membersihkan sumber daya

Jika Anda tidak ingin terus menggunakan sumber daya yang dibuat dalam artikel ini, hapus grup sumber daya yang Anda buat di sini untuk menghindari biaya.

Penting

Penghapusan grup sumber daya tidak bisa dipulihkan. Grup sumber daya dan semua sumber daya yang ada di dalamnya akan dihapus secara permanen. Pastikan Anda tidak menghapus grup atau sumber daya yang salah secara tidak sengaja. Jika Anda membuat sumber daya untuk artikel ini dalam grup sumber daya yang ada yang berisi sumber daya lain yang ingin disimpan, hapus setiap sumber daya satu per satu dari panelnya masing-masing, bukan menghapus grup sumber daya.

1. Masuk ke portal Azure, lalu pilih Grup sumber daya.
2. Dalam kotak Filter menurut nama, masukkan nama grup sumber daya Anda.
3. Dalam daftar hasil, pilih nama grup sumber daya untuk melihat gambaran umum.
4. Pilih Hapus grup sumber daya.
5. Anda akan diminta untuk mengonfirmasi penghapusan grup sumber daya. Masukkan nama grup sumber daya Anda untuk mengonfirmasi, dan pilih Hapus.

Setelah beberapa saat, grup sumber daya dan semua sumber dayanya akan dihapus.

Langkah berikutnya

Dalam panduan singkat ini, Anda:

• Menyediakan penyimpanan App Configuration baru.
• Tersambung ke penyimpanan App Configuration Anda menggunakan pustaka penyedia App Configuration.
• Baca nilai kunci penyimpanan App Configuration Anda melalui pustaka penyedia konfigurasi.
• Menampilkan halaman web menggunakan pengaturan yang Anda konfigurasi di penyimpanan App Configuration Anda.

Untuk mempelajari cara mengonfigurasi aplikasi web ASP.NET Core Anda untuk menyegarkan pengaturan konfigurasi secara dinamis, lanjutkan ke tutorial berikutnya.

Mengaktifkan konfigurasi dinamis