Połączenie do usługi Azure SQL Database i wykonywania na ich podstawie zapytań przy użyciu platformy .NET i programu Entity Framework Core

  • Artykuł

Dotyczy:Azure SQL Database

W tym przewodniku Szybki start opisano sposób łączenia aplikacji z bazą danych w usłudze Azure SQL Database i wykonywania zapytań przy użyciu platformy .NET i platformy Entity Framework Core. Ten przewodnik Szybki start jest zgodny z zalecanym podejściem bez hasła w celu nawiązania połączenia z bazą danych. Więcej informacji na temat połączeń bez hasła można uzyskać w centrum bez hasła.

Wymagania wstępne

Konfigurowanie serwera bazy danych

Bezpieczne, bez hasła połączenia z usługą Azure SQL Database wymagają pewnych konfiguracji bazy danych. Sprawdź następujące ustawienia na serwerze logicznym na platformie Azure , aby prawidłowo nawiązać połączenie z usługą Azure SQL Database w środowiskach lokalnych i hostowanych:

  1. W przypadku lokalnych połączeń programistycznych upewnij się, że serwer logiczny jest skonfigurowany tak, aby zezwolić na nawiązywanie połączenia z adresem IP komputera lokalnego i innymi usługami platformy Azure:

    • Przejdź do strony Sieć serwera.

    • Przełącz przycisk radiowy Wybrane sieci, aby wyświetlić dodatkowe opcje konfiguracji.

    • Wybierz pozycję Dodaj adres IPv4 klienta (xx.xx.xx.xx.xx ), aby dodać regułę zapory, która umożliwi połączenia z adresu IPv4 komputera lokalnego. Alternatywnie możesz również wybrać pozycję + Dodaj regułę zapory, aby wprowadzić wybrany konkretny adres IP.

    • Upewnij się, że pole wyboru Zezwalaj usługom i zasobom platformy Azure na dostęp do tego serwera jest zaznaczone.

      A screenshot showing how to configure firewall rules.

      Ostrzeżenie

      Włączenie opcji Zezwalaj usługom i zasobom platformy Azure na dostęp do tego ustawienia serwera nie jest zalecaną praktyką zabezpieczeń w scenariuszach produkcyjnych. Rzeczywiste aplikacje powinny implementować bezpieczniejsze podejścia, takie jak silniejsze ograniczenia zapory lub konfiguracje sieci wirtualnej.

      Więcej informacji na temat konfiguracji zabezpieczeń bazy danych można uzyskać w następujących zasobach:

  2. Serwer musi również mieć włączone uwierzytelnianie Microsoft Entra i mieć przypisane konto administratora firmy Microsoft Entra. W przypadku lokalnych połączeń programistycznych konto administratora firmy Microsoft Entra powinno być kontem, które można również zalogować się do programu Visual Studio lub interfejsu wiersza polecenia platformy Azure lokalnie. Możesz sprawdzić, czy serwer ma włączone uwierzytelnianie firmy Microsoft Entra na stronie Identyfikator entra firmy Microsoft serwera logicznego.

    A screenshot showing how to enable Microsoft Entra authentication.

  3. Jeśli używasz osobistego konta platformy Azure, upewnij się, że masz konfigurację usługi Microsoft Entra i skonfigurowaną dla usługi Azure SQL Database w celu przypisania konta jako administratora serwera. Jeśli używasz konta firmowego, identyfikator Firmy Microsoft najprawdopodobniej zostanie już skonfigurowany.

Tworzenie projektu

Kroki opisane w tej sekcji umożliwiają utworzenie minimalnego internetowego interfejsu API platformy .NET przy użyciu interfejsu wiersza polecenia platformy .NET lub programu Visual Studio 2022.

  1. Na pasku menu programu Visual Studio przejdź do pozycji Plik>nowy>projekt...

  2. W oknie dialogowym wprowadź ASP.NET w polu wyszukiwania szablonu projektu i wybierz wynik ASP.NET Core Web API. Wybierz pozycję Dalej w dolnej części okna dialogowego.

  3. W polu Nazwa projektu wprowadź wartość DotNetSQL. Pozostaw wartości domyślne pozostałych pól i wybierz pozycję Dalej.

  4. W obszarze Framework wybierz pozycję .NET 7.0 i usuń zaznaczenie pola wyboru Użyj kontrolerów (usuń zaznaczenie, aby używać minimalnych interfejsów API).. W tym przewodniku Szybki start użyto szablonu interfejsu API minimalnego w celu usprawnienia tworzenia i konfigurowania punktu końcowego.

  5. Wybierz pozycję Utwórz. Nowy projekt zostanie otwarty w środowisku programu Visual Studio.

Dodawanie programu Entity Framework Core do projektu

Aby nawiązać połączenie z usługą Azure SQL Database przy użyciu platformy .NET i programu Entity Framework Core, należy dodać do projektu trzy pakiety NuGet przy użyciu jednej z następujących metod:

  1. W oknie Eksplorator rozwiązań kliknij prawym przyciskiem myszy węzeł Zależności projektu i wybierz polecenie Zarządzaj pakietami NuGet.

  2. W wyświetlonym oknie wyszukaj wartość EntityFrameworkCore. Znajdź i zainstaluj następujące pakiety:

  • Microsoft.EntityFrameworkCore: zapewnia podstawowe funkcje programu Entity Framework Core
  • Microsoft.EntityFrameworkCore.SqlServer: udostępnia dodatkowe składniki umożliwiające nawiązanie połączenia z serwerem logicznym
  • Microsoft.EntityFrameworkCore.Design: zapewnia obsługę uruchamiania migracji programu Entity Framework

Alternatywnie możesz również uruchomić Install-Package polecenie cmdlet w oknie konsoli Menedżer pakietów:

Install-Package Microsoft.EntityFrameworkCore
Install-Package Microsoft.EntityFrameworkCore.SqlServer
Install-Package Microsoft.EntityFrameworkCore.Design

Dodawanie kodu w celu nawiązania połączenia z usługą Azure SQL Database

Biblioteki Platformy Entity Framework Core bazują na bibliotekach Microsoft.Data.SqlClient i, Azure.Identity aby zaimplementować połączenia bez hasła z usługą Azure SQL Database. Biblioteka Azure.Identity udostępnia klasę o nazwie DefaultAzureCredential , która obsługuje uwierzytelnianie bez hasła na platformie Azure.

DefaultAzureCredential obsługuje wiele metod uwierzytelniania i określa, które z nich mają być używane w czasie wykonywania. Takie podejście umożliwia aplikacji używanie różnych metod uwierzytelniania w różnych środowiskach (lokalnych i produkcyjnych) bez implementowania kodu specyficznego dla środowiska. Omówienie biblioteki tożsamości platformy Azure wyjaśnia kolejność i lokalizacje, w których DefaultAzureCredential szuka poświadczeń.

Wykonaj następujące kroki, aby nawiązać połączenie z usługą Azure SQL Database przy użyciu platformy Entity Framework Core i podstawowej DefaultAzureCredential klasy:

  1. Dodaj sekcję ConnectionStrings do appsettings.Development.json pliku, aby była zgodna z poniższym kodem. Pamiętaj, aby zaktualizować <your database-server-name> symbole zastępcze i <your-database-name> .

    Parametry połączenia bez hasła zawiera wartość Authentication=Active Directory Defaultkonfiguracji , która umożliwia programowi Entity Framework Core DefaultAzureCredential łączenie się z usługami platformy Azure. Gdy aplikacja jest uruchamiana lokalnie, uwierzytelnia się przy użyciu użytkownika, za pomocą którego logujesz się do programu Visual Studio. Po wdrożeniu aplikacji na platformie Azure ten sam kod odnajduje i stosuje tożsamość zarządzaną skojarzona z hostowaną aplikacją, którą skonfigurujesz później.

    Uwaga

    Bez hasła parametry połączenia są bezpieczne do zatwierdzania kontroli źródła, ponieważ nie zawierają żadnych wpisów tajnych, takich jak nazwy użytkowników, hasła lub klucze dostępu.

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

  2. Dodaj następujący kod do Program.cs pliku powyżej wiersza kodu, który odczytuje var app = builder.Build();element . Ten kod wykonuje następujące konfiguracje:

    • Pobiera bez hasła bazę danych parametry połączenia z appsettings.Development.json pliku na potrzeby programowania lokalnego lub ze zmiennych środowiskowych dla hostowanych scenariuszy produkcyjnych.

    • Rejestruje klasę Entity Framework Core DbContext w kontenerze iniekcji zależności platformy .NET.

      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));

  3. Dodaj następujące punkty końcowe do dołu powyższego Program.csapp.Run() pliku, aby pobrać i dodać jednostki w bazie danych przy użyciu PersonDbContext klasy .

    app.MapGet("/Person", (PersonDbContext context) =>
{
    return context.Person.ToList();
})
.WithName("GetPersons")
.WithOpenApi();

app.MapPost("/Person", (Person person, PersonDbContext context) =>
{
    context.Add(person);
    context.SaveChanges();
})
.WithName("CreatePerson")
.WithOpenApi();

    Na koniec dodaj Person klasy i PersonDbContext do dołu Program.cs pliku. Klasa Person reprezentuje pojedynczy rekord w tabeli bazy danych Persons . Klasa PersonDbContext reprezentuje bazę danych Person i umożliwia wykonywanie na niej operacji za pomocą kodu. Więcej informacji DbContext można uzyskać w dokumentacji Wprowadzenie dla programu Entity Framework Core.

    public class Person
{
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

public class PersonDbContext : DbContext
{
    public PersonDbContext(DbContextOptions<PersonDbContext> options)
        : base(options)
    {
    }

    public DbSet<Person> Person { get; set; }
}

Uruchamianie migracji w celu utworzenia bazy danych

Aby zaktualizować schemat bazy danych tak, aby był zgodny z modelem danych przy użyciu programu Entity Framework Core, należy użyć migracji. Migracje mogą tworzyć i przyrostowo aktualizować schemat bazy danych, aby zachować synchronizację z modelem danych aplikacji. Więcej informacji na temat tego wzorca można uzyskać w omówieniu migracji.

  1. Otwórz okno terminalu w katalogu głównym projektu.

  2. Uruchom następujące polecenie, aby wygenerować początkową migrację, która może utworzyć bazę danych:

    Add-Migration InitialCreate

  3. Folder Migrations powinien pojawić się w katalogu projektu wraz z plikiem o nazwie InitialCreate z unikatowymi liczbami wstępnie utworzonymi. Uruchom migrację, aby utworzyć bazę danych przy użyciu następującego polecenia:

    Update-Database

    Narzędzia Platformy Entity Framework Core spowodują utworzenie schematu bazy danych na platformie Azure zdefiniowanego przez klasę PersonDbContext .

Lokalne przetestowanie aplikacji

Aplikacja jest gotowa do testowania lokalnie. Upewnij się, że logujesz się do programu Visual Studio lub interfejsu wiersza polecenia platformy Azure przy użyciu tego samego konta, które zostało ustawione jako administrator bazy danych.

  1. Naciśnij przycisk Uruchom w górnej części programu Visual Studio, aby uruchomić projekt interfejsu API.

  2. Na stronie Swagger UI rozwiń metodę POST i wybierz pozycję Wypróbuj.

  3. Zmodyfikuj przykładowy kod JSON, aby uwzględnić wartości dla pierwszego i nazwiska. Wybierz pozycję Wykonaj , aby dodać nowy rekord do bazy danych. Interfejs API zwraca pomyślną odpowiedź.

    A screenshot showing how to test the API.

  4. Rozwiń metodę GET na stronie interfejsu użytkownika programu Swagger i wybierz pozycję Wypróbuj. Wybierz pozycję Wykonaj, a utworzona osoba zostanie zwrócona.

Wdrażanie w usłudze Azure App Service

Aplikacja jest gotowa do wdrożenia na platformie Azure. Program Visual Studio może utworzyć usługę aplikacja systemu Azure i wdrożyć aplikację w jednym przepływie pracy.

  1. Upewnij się, że aplikacja została zatrzymana i została pomyślnie skompilowana.

  2. W oknie Eksplorator rozwiązań programu Visual Studio kliknij prawym przyciskiem myszy węzeł projektu najwyższego poziomu i wybierz pozycję Publikuj.

  3. W oknie dialogowym publikowania wybierz pozycję Azure jako element docelowy wdrożenia, a następnie wybierz pozycję Dalej.

  4. Dla określonego elementu docelowego wybierz pozycję aplikacja systemu Azure Service (Windows), a następnie wybierz przycisk Dalej.

  5. Wybierz zieloną + ikonę, aby utworzyć nową usługę App Service do wdrożenia, a następnie wprowadź następujące wartości:

    • Nazwa: pozostaw wartość domyślną.

    • Nazwa subskrypcji: wybierz subskrypcję do wdrożenia.

    • Grupa zasobów: wybierz pozycję Nowy i utwórz nową grupę zasobów o nazwie msdocs-dotnet-sql.

    • Plan hostingu: wybierz pozycję Nowy , aby otworzyć okno dialogowe planu hostingu. Pozostaw wartości domyślne i wybierz przycisk OK.

    • Wybierz pozycję Utwórz , aby zamknąć oryginalne okno dialogowe. Program Visual Studio tworzy zasób usługi App Service na platformie Azure.

      A screenshot showing how to deploy with Visual Studio.

  6. Po utworzeniu zasobu upewnij się, że został wybrany na liście usług app Services, a następnie wybierz pozycję Dalej.

  7. W kroku API Management zaznacz pole wyboru Pomiń ten krok u dołu, a następnie wybierz pozycję Zakończ.

  8. Wybierz pozycję Publikuj w prawym górnym rogu podsumowania profilu publikowania, aby wdrożyć aplikację na platformie Azure.

Po zakończeniu wdrażania program Visual Studio uruchamia przeglądarkę, aby wyświetlić hostowaną aplikację, ale w tym momencie aplikacja nie działa poprawnie na platformie Azure. Nadal musisz skonfigurować bezpieczne połączenie między usługą App Service i bazą danych SQL, aby pobrać dane.

Połączenie usługi App Service do usługi Azure SQL Database

Aby połączyć wystąpienie usługi App Service z usługą Azure SQL Database, wymagane są następujące kroki:

  1. Utwórz tożsamość zarządzaną dla usługi App Service. Biblioteka zawarta Microsoft.Data.SqlClient w aplikacji automatycznie odnajdzie tożsamość zarządzaną, podobnie jak w przypadku odnajdywania lokalnego użytkownika programu Visual Studio.
  2. Utwórz użytkownika bazy danych SQL i skojarz ją z tożsamością zarządzaną usługi App Service.
  3. Przypisz role SQL do użytkownika bazy danych, który zezwala na odczyt, zapis i potencjalnie inne uprawnienia.

Dostępnych jest wiele narzędzi do implementowania następujących kroków:

Usługa Połączenie or to narzędzie, które usprawnia uwierzytelnianie połączeń między różnymi usługami na platformie Azure. Usługa Połączenie or obsługuje obecnie łączenie usługi App Service z bazą danych SQL za pośrednictwem interfejsu az webapp connection create sql wiersza polecenia platformy Azure przy użyciu polecenia . To pojedyncze polecenie wykonuje trzy kroki wymienione powyżej.

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

Zmiany wprowadzone przez usługę Service Połączenie or można sprawdzić w ustawieniach usługi App Service.

  1. Przejdź do strony Tożsamość dla usługi App Service. Na karcie Przypisane przez system stan powinien być ustawiony na Włączone. Ta wartość oznacza, że tożsamość zarządzana przypisana przez system została włączona dla aplikacji.

  2. Przejdź do strony Konfiguracja usługi App Service. Na karcie Ciągi Połączenie ion powinny zostać wyświetlone parametry połączenia o nazwie AZURE_SQL_CONNECTIONSTRING. Wybierz pozycję Kliknij, aby wyświetlić tekst wartości, aby wyświetlić wygenerowany parametry połączenia bez hasła. Nazwa tej parametry połączenia jest zgodna z nazwą skonfigurowaną w aplikacji, więc zostanie ona odnaleziona automatycznie podczas uruchamiania na platformie Azure.

Ważne

Chociaż to rozwiązanie zapewnia proste podejście do rozpoczęcia pracy, nie jest to najlepsze rozwiązanie dla środowisk produkcyjnych przedsiębiorstwa. W tych scenariuszach aplikacja nie powinna wykonywać wszystkich operacji przy użyciu jednej tożsamości z podwyższonym poziomem uprawnień. Należy spróbować zaimplementować zasadę najniższych uprawnień, konfigurując wiele tożsamości z określonymi uprawnieniami dla określonych zadań.

Więcej informacji na temat konfigurowania ról bazy danych i zabezpieczeń można uzyskać w następujących zasobach:

Samouczek: zabezpieczanie bazy danych w usłudze Azure SQL Database

Autoryzowanie dostępu do bazy danych w usłudze SQL Database

Testowanie wdrożonej aplikacji

Przejdź do adresu URL aplikacji, aby sprawdzić, czy połączenie z usługą Azure SQL Database działa. Adres URL aplikacji można znaleźć na stronie przeglądu usługi App Service. Dołącz ścieżkę /person na końcu adresu URL, aby przejść do tego samego punktu końcowego, który przetestowano lokalnie.

Osoba utworzona lokalnie powinna być wyświetlana w przeglądarce. Gratulacje! Aplikacja jest teraz połączona z usługą Azure SQL Database zarówno w środowiskach lokalnych, jak i hostowanych.

Oczyszczanie zasobów

Po zakończeniu pracy z usługą Azure SQL Database usuń zasób, aby uniknąć niezamierzonych kosztów.

  1. Na pasku wyszukiwania w witrynie Azure Portal wyszukaj ciąg Azure SQL i wybierz pasujący wynik.

  2. Znajdź i wybierz bazę danych na liście baz danych.

  3. Na stronie Przegląd usługi Azure SQL Database wybierz pozycję Usuń.

  4. Na platformie Azure na pewno chcesz usunąć otwieraną stronę, wpisz nazwę bazy danych, aby potwierdzić, a następnie wybierz pozycję Usuń.

Następne kroki