Share via

.NET ve Microsoft.Data.SqlClient kitaplığını kullanarak Azure SQL Veritabanı Bağlan ve sorgular

  • Makale

Şunlar için geçerlidir:Azure SQL Veritabanı

Bu hızlı başlangıçta bir uygulamanın Azure SQL Veritabanı'deki bir veritabanına nasıl bağlandığı ve .NET ve Microsoft.Data.SqlClient kitaplığını kullanarak sorgular nasıl gerçekleştirebileceğiniz açıklanır. Bu hızlı başlangıç, veritabanına bağlanmak için önerilen parolasız yaklaşımı izler. Parolasız bağlantılar hakkında daha fazla bilgiyi parolasız hub'dan öğrenebilirsiniz.

Önkoşullar

Veritabanını yapılandırma

Azure SQL Veritabanı için güvenli, parolasız bağlantılar için belirli veritabanı yapılandırmaları gerekir. Hem yerel hem de barındırılan ortamlardaki Azure SQL Veritabanı düzgün bir şekilde bağlanmak için Azure'daki mantıksal sunucunuzda aşağıdaki ayarları doğrulayın:

  1. Yerel geliştirme bağlantıları için mantıksal sunucunuzun yerel makine IP adresinizin ve diğer Azure hizmetlerinin bağlanmasına izin verecek şekilde yapılandırıldığından emin olun:

    • Sunucunuzun Ağ sayfasına gidin.

    • Ek yapılandırma seçeneklerini göstermek için Seçili ağlar radyo düğmesini değiştirin.

    • Yerel makinenizin IPv4 adresinden bağlantıları etkinleştirecek bir güvenlik duvarı kuralı eklemek için İstemci IPv4 adresinizi (xx.xx.xx.xx) ekle'yi seçin. Alternatif olarak, istediğiniz belirli bir IP adresini girmek için + Güvenlik duvarı kuralı ekle'yi de seçebilirsiniz.

    • Azure hizmetlerinin ve kaynaklarının bu sunucuya erişmesine izin ver onay kutusunun seçili olduğundan emin olun.

      A screenshot showing how to configure firewall rules.

      Uyarı

      Azure hizmetlerinin ve kaynaklarının bu sunucuya erişmesine izin ver ayarını etkinleştirmek, üretim senaryoları için önerilen bir güvenlik uygulaması değildir. Gerçek uygulamalar daha güçlü güvenlik duvarı kısıtlamaları veya sanal ağ yapılandırmaları gibi daha güvenli yaklaşımlar uygulamalıdır.

      Aşağıdaki kaynaklarda veritabanı güvenlik yapılandırmaları hakkında daha fazla bilgi edinebilirsiniz:

  2. Sunucuda ayrıca Microsoft Entra kimlik doğrulaması etkinleştirilmiş ve atanmış bir Microsoft Entra yönetici hesabı olmalıdır. Yerel geliştirme bağlantıları için, Microsoft Entra yönetici hesabı yerel olarak Visual Studio'da veya Azure CLI'da oturum açabileceğiniz bir hesap olmalıdır. Mantıksal sunucunuzun Microsoft Entra Id sayfasında sunucunuzda Microsoft Entra kimlik doğrulamasının etkinleştirilip etkinleştirilmediğini doğrulayabilirsiniz.

    A screenshot showing how to enable Microsoft Entra authentication.

  3. Kişisel bir Azure hesabı kullanıyorsanız hesabınızı sunucu yöneticisi olarak atamak için Microsoft Entra kurulumunu yaptığınızdan ve Azure SQL Veritabanı için yapılandırdığınızdan emin olun. Şirket hesabı kullanıyorsanız, Microsoft Entra Id büyük olasılıkla sizin için zaten yapılandırılmış olacaktır.

Proje oluşturma

İlerideki adımlar için .NET CLI veya Visual Studio 2022 kullanarak bir .NET Minimal Web API'si oluşturun.

  1. Visual Studio menüsünde Dosya>Yeni>Proje... seçeneğine gidin.

  2. İletişim kutusu penceresinde proje şablonu arama kutusuna ASP.NET girin ve ASP.NET Çekirdek Web API'sinin sonucunu seçin. İletişim kutusunun alt kısmındaki İleri'yi seçin.

  3. Proje Adı için DotNetSQL girin. Kalan alanlar için varsayılan değerleri bırakın ve İleri'yi seçin.

  4. Çerçeve için .NET 7.0'ı seçin ve Denetleyicileri kullan seçeneğinin işaretini kaldırın (en düşük API'leri kullanmak için işaretini kaldırın). Bu hızlı başlangıçta uç nokta oluşturma ve yapılandırma süreçlerini kolaylaştırmak için Minimal API şablonu kullanılmaktadır.

  5. Oluştur’u seçin. Yeni proje Visual Studio ortamında açılır.

Microsoft.Data.SqlClient kitaplığını ekleme

.NET kullanarak Azure SQL Veritabanı bağlanmak için yükleyinMicrosoft.Data.SqlClient. Bu paket veritabanlarına bağlanmak, komutları yürütmek ve sonuçları almak için bir veri sağlayıcısı işlevi görür.

Dekont

yüklemesini değilSystem.Data.SqlClient, yüklediğinizden Microsoft.Data.SqlClient emin olun. Microsoft.Data.SqlClient , ek özellikler sağlayan SQL istemci kitaplığının daha yeni bir sürümüdür.

  1. Çözüm Gezgini penceresinde projenin Bağımlılıklar düğümüne sağ tıklayın ve NuGet Paketlerini Yönet'i seçin.

  2. Sonuçta elde edilen pencerede SqlClient için arama yapın. Microsoft.Data.SqlClient Sonucu bulun ve Yükle'yi seçin.

Bağlantı dizesini yapılandırma

Azure SQL Veritabanı parolasız bağlantılarla yerel geliştirme için dosyaya appsettings.json aşağıdaki ConnectionStrings bölümü ekleyin. <database-server-name> ve <database-name> yer tutucularını kendi değerlerinizle değiştirin.

"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\";"
}

Parolasız bağlantı dizesi, kitaplığına Authentication="Active Directory Default"adlı DefaultAzureCredentialbir sınıf kullanarak Azure SQL Veritabanı bağlanmasını sağlayan Microsoft.Data.SqlClient bir yapılandırma değeri ayarlar. DefaultAzureCredential Azure hizmetlerine parolasız bağlantıları etkinleştirir ve SQL istemci kitaplığının bağımlı olduğu Azure Kimlik kitaplığı tarafından sağlanır. DefaultAzureCredential birden çok kimlik doğrulama yöntemini destekler ve farklı ortamlar için çalışma zamanında hangisinin kullanılacağını belirler.

Örneğin, uygulama yerel olarak çalıştığında, DefaultAzureCredential Visual Studio'da oturum açtığınız kullanıcı veya Azure CLI gibi diğer yerel araçlar aracılığıyla kimlik doğrulaması yapar. Uygulama Azure'a dağıtıldıktan sonra, daha sonra yapılandırabileceğiniz barındırılan uygulamayla ilişkili yönetilen kimliği aynı kod bulur ve uygular. Azure Kimlik kitaplığına genel bakış , kimlik bilgilerinin arandığı DefaultAzureCredential sırayı ve konumları açıklar.

Dekont

Parolasız bağlantı dizesi, kullanıcı adları, parolalar veya erişim anahtarları gibi gizli diziler içermediğinden kaynak denetimine bağlanmak güvenlidir.

Azure SQL Veritabanı bağlanmak için kodu ekleme

Dosyanın içeriğini Program.cs aşağıdaki önemli adımları gerçekleştiren aşağıdaki kodla değiştirin:

  • Parolasız bağlantı dizesi alırappsettings.json
  • Başlatma sırasında veritabanında bir Persons tablo oluşturur (yalnızca test senaryoları için)
  • Tabloda depolanan Persons tüm kayıtları almak için bir HTTP GET uç noktası oluşturur
  • Tabloya yeni kayıtlar Persons eklemek için bir HTTP POST uç noktası oluşturur
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();

Son olarak, sınıfını Person dosyanın en altına Program.cs ekleyin. Bu sınıf, veritabanının Persons tablosundaki tek bir kaydı temsil eder.

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

Uygulamayı yerel olarak çalıştırma ve test edin

Uygulama yerel olarak test edilmeye hazırdır. Veritabanınızın yöneticisi olarak ayarladığınız hesapla Visual Studio'da veya Azure CLI'da oturum açtığınızdan emin olun.

  1. API projesini başlatmak için Visual Studio'nun üst kısmındaki çalıştır düğmesine basın.

  2. Swagger kullanıcı arabirimi sayfasında POST yöntemini genişletin ve Deneyin'i seçin.

  3. Örnek JSON'ı ad ve soyadı değerlerini içerecek şekilde değiştirin. Veritabanına yeni bir kayıt eklemek için Yürüt'e tıklayın. API başarılı bir yanıt döndürür.

    A screenshot showing how to test the API.

  4. Swagger kullanıcı arabirimi sayfasında GET yöntemini genişletin ve Deneyin'i seçin. Yürüt'e tıklayın ve yeni oluşturduğunuz kişi döndürülür.

Azure App Service’e dağıtma

Uygulama Azure'a dağıtılmaya hazırdır. Visual Studio bir Azure Uygulaması Hizmeti oluşturabilir ve uygulamanızı tek bir iş akışında dağıtabilir.

  1. Uygulamanın durdurulup başarıyla derlendiğinden emin olun.

  2. Visual Studio'nun Çözüm Gezgini penceresinde üst düzey proje düğümüne sağ tıklayın ve Yayımla'yı seçin.

  3. Yayımlama iletişim kutusunda dağıtım hedefi olarak Azure'ı ve ardından İleri'yi seçin.

  4. Belirli bir hedef için Azure Uygulaması Hizmeti (Windows) ve ardından İleri'yi seçin.

  5. + Dağıtılacak yeni bir App Service oluşturmak için simgesini seçin ve aşağıdaki değerleri girin:

    • Ad: Varsayılan değeri bırakın.

    • Abonelik adı: Dağıtılacak aboneliği seçin.

    • Kaynak grubu: Yeni'yi seçin ve msdocs-dotnet-sql adlı yeni bir kaynak grubu oluşturun.

    • Barındırma Planı: Barındırma planı iletişim kutusunu açmak için Yeni'yi seçin. Varsayılan değerleri bırakın ve Tamam'ı seçin.

    • Özgün iletişim kutusunu kapatmak için Oluştur'u seçin. Visual Studio, Azure'da App Service kaynağını oluşturur.

      A screenshot showing how to deploy with Visual Studio.

  6. Kaynak oluşturulduktan sonra uygulama hizmetleri listesinden seçildiğinden emin olun ve İleri'yi seçin.

  7. API Management adımında, alttaki Bu adımı atla onay kutusunu ve ardından Son'u seçin.

  8. Son adımında, iletişim kutusu otomatik olarak kapatılmazsa Kapat'ı seçin.

  9. Uygulamayı Azure'a dağıtmak için yayımlama profili özetinin sağ üst kısmındaki Yayımla'yı seçin.

Dağıtım tamamlandığında, Visual Studio barındırılan uygulamayı görüntülemek için tarayıcıyı başlatır, ancak bu noktada uygulama Azure'da düzgün çalışmaz. Yine de verilerinizi almak için App Service ile SQL veritabanı arasındaki güvenli bağlantıyı yapılandırmanız gerekir.

App Service'i Azure SQL Veritabanı Bağlan

App Service örneği ile Azure SQL Veritabanı arasında parolasız bağlantı oluşturmak için aşağıdaki adımlar gereklidir:

  1. App Service için yönetilen kimlik oluşturma. Microsoft.Data.SqlClient Uygulamanıza dahil edilen kitaplık, yerel Visual Studio kullanıcınızı keşfettiği gibi yönetilen kimliği otomatik olarak bulur.
  2. Bir SQL veritabanı kullanıcısı oluşturun ve bunu App Service yönetilen kimliğiyle ilişkilendirin.
  3. Veritabanı kullanıcısına okuma, yazma ve diğer izinlere izin veren SQL rolleri atayın.

Bu adımları uygulamak için kullanabileceğiniz birden çok araç vardır:

Service Bağlan or, Azure'daki farklı hizmetler arasındaki kimliği doğrulanmış bağlantıları kolaylaştıran bir araçtır. Service Bağlan veya şu anda komutunu kullanarak Azure CLI aracılığıyla App Service'i SQL veritabanına bağlamayı az webapp connection create sql destekler. Bu tek komut sizin için yukarıda belirtilen üç adımı tamamlar.

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

Service Bağlan veya tarafından yapılan değişiklikleri App Service ayarlarından doğrulayabilirsiniz.

  1. App Service'inizin Kimlik sayfasına gidin. Sistem tarafından atanan sekmesinin altında Durum Açık olarak ayarlanmalıdır. Bu değer, uygulamanız için sistem tarafından atanan yönetilen kimliğin etkinleştirildiği anlamına gelir.

  2. App Service'inizin Yapılandırma sayfasına gidin. Bağlan ion dizeleri sekmesinin altında AZURE_SQL_CONNECTIONSTRING adlı bir bağlantı dizesi görmeniz gerekir. Oluşturulan parolasız bağlantı dizesi görüntülemek için Değer metnini göstermek için tıklayın'ı seçin. Bu bağlantı dizesi adı, uygulamanızda yapılandırdığınız adla eşleştiğinden, Azure'da çalışırken otomatik olarak bulunur.

Önemli

Bu çözüm başlangıç için basit bir yaklaşım sağlasa da, üretim sınıfı ortamlar için en iyi yöntem değildir. Bu senaryolarda uygulama, tek bir yükseltilmiş kimlik kullanarak tüm işlemleri gerçekleştirmemelidir. Belirli görevler için belirli izinlere sahip birden çok kimlik yapılandırarak en az ayrıcalık ilkesini uygulamaya çalışmanız gerekir.

Aşağıdaki kaynaklarda veritabanı rollerini ve güvenliğini yapılandırma hakkında daha fazla bilgi edinebilirsiniz:

Dağıtılan uygulamayı test edin

  1. Uygulamanızın kök URL'sini başlatmak için App Service'e genel bakış sayfasının üst kısmındaki Gözat düğmesini seçin.

  2. /swagger/index.html Yerel olarak kullandığınız Swagger test sayfasını yüklemek için URL'nin yolunu ekleyin.

  3. Uç noktaların beklendiği gibi çalıştığını doğrulamak için GET ve POST isteklerini test edin.

Bahşiş

Test sırasında 500 İç Sunucu hatası alırsanız, bunun nedeni veritabanı ağ yapılandırmalarınız olabilir. Mantıksal sunucunuzun Veritabanını yapılandırma bölümünde özetlenen ayarlarla yapılandırıldığını doğrulayın.

Tebrikler! Uygulamanız artık hem yerel hem de barındırılan ortamlardaki Azure SQL Veritabanı bağlı.

Kaynakları temizleme

Azure SQL Veritabanı ile çalışmayı bitirdiğinizde, istenmeyen maliyetlerden kaçınmak için kaynağı silin.

  1. Azure portalı arama çubuğunda Azure SQL'i arayın ve eşleşen sonucu seçin.

  2. Veritabanı listesinde veritabanınızı bulun ve seçin.

  3. Azure SQL Veritabanı Genel Bakış sayfasında Sil'i seçin.

  4. Açılan Azure'da silmek istediğinizden emin olun... sayfasında, onaylamak için veritabanınızın adını yazın ve sil'i seçin.