Verbinding maken met en query's uitvoeren op Azure SQL Database met behulp van .NET en Entity Framework Core

Van toepassing op:Azure SQL Database

In deze quickstart wordt beschreven hoe u een toepassing verbindt met een database in Azure SQL Database en query's uitvoert met behulp van .NET en Entity Framework Core. Deze quickstart volgt de aanbevolen benadering zonder wachtwoord om verbinding te maken met de database. Meer informatie over verbindingen zonder wachtwoord vindt u op de hub zonder wachtwoord.

Vereiste voorwaarden

• Een Azure-abonnement.
• Een SQL-database die is geconfigureerd voor verificatie met Microsoft Entra ID (voorheen Azure Active Directory). U kunt er een maken met behulp van de quickstart: Een individuele database maken - Azure SQL Database.
• .NET 9.0 of hoger.
• Visual Studio of hoger met de workload ASP.NET en webontwikkeling .
• De nieuwste versie van de Azure CLI.
• De nieuwste versie van de Entity Framework Core-hulpprogramma's:
  • Visual Studio-gebruikers moeten de Package Manager Console-hulpprogramma's voor Entity Framework Core installeren.
  • .NET CLI-gebruikers moeten de .NET CLI-hulpprogramma's voor Entity Framework Core installeren.

De databaseserver configureren

Voor beveiligde, wachtwoordloze verbindingen met Azure SQL Database zijn bepaalde databaseconfiguraties vereist. Controleer de volgende instellingen op uw logische server in Azure om verbinding te maken met Azure SQL Database in zowel lokale als gehoste omgevingen:

1. Voor lokale ontwikkelingsverbindingen moet u ervoor zorgen dat uw logische server zo is geconfigureerd dat het IP-adres van uw lokale computer en andere Azure-services verbinding kunnen maken:

   • Navigeer naar de pagina Netwerken van uw server.

   • Schakel het keuzerondje Geselecteerde netwerken in om extra configuratieopties weer te geven.

   • Selecteer Voeg uw IPv4-clientadres (xx.xx.xx.xx) toe om een firewallregel toe te voegen waarmee verbindingen vanaf het IPv4-adres van uw lokale computer worden ingeschakeld. U kunt ook + Een firewallregel toevoegen selecteren om een specifiek IP-adres van uw keuze in te voeren.

   • Zorg ervoor dat het selectievakje Azure-services en -resources toegang geven tot deze server is ingeschakeld.

     

     Waarschuwing

     Het inschakelen van de Toestaan dat Azure-services en -resources toegang krijgen tot deze server instelling is geen aanbevolen beveiligingspraktijk voor productiescenario's. Echte toepassingen moeten veiligere benaderingen implementeren, zoals sterkere firewallbeperkingen of configuraties van virtuele netwerken.

     Meer informatie over databasebeveiligingsconfiguraties vindt u in de volgende bronnen:

     • Firewallregels voor Azure SQL Database configureren.
     • een virtueel netwerk configureren met privé-eindpunten.

2. Op de server moet ook Microsoft Entra-verificatie zijn ingeschakeld en moet een Microsoft Entra-beheerdersaccount zijn toegewezen. Voor lokale ontwikkelingsverbindingen moet het Microsoft Entra-beheerdersaccount een account zijn waarmee u zich ook lokaal kunt aanmelden bij Visual Studio of de Azure CLI. U kunt controleren of Microsoft Entra-verificatie is ingeschakeld op de Microsoft Entra ID pagina van uw logische server.

   

3. Als u een persoonlijk Azure-account gebruikt, moet u ervoor zorgen dat u Microsoft Entra hebt ingesteld en geconfigureerd voor Azure SQL Database om uw account toe te wijzen als serverbeheerder. Als u een bedrijfsaccount gebruikt, wordt de Microsoft Entra-id waarschijnlijk al voor u geconfigureerd.

Het project maken

Met de stappen in deze sectie maakt u een .NET Minimal Web API met behulp van de .NET CLI of Visual Studio 2022.

Entity Framework Core toevoegen aan het project

Als u verbinding wilt maken met Azure SQL Database met behulp van .NET en Entity Framework Core, moet u drie NuGet-pakketten toevoegen aan uw project met behulp van een van de volgende methoden:

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

De code toevoegen om verbinding te maken met Azure SQL Database

De Entity Framework Core-bibliotheken zijn afhankelijk van de en Azure.Identity bibliotheken voor het Microsoft.Data.SqlClient implementeren van verbindingen zonder wachtwoord met Azure SQL Database. De Azure.Identity bibliotheek biedt een klasse met de naam DefaultAzureCredential die verificatie zonder wachtwoord naar Azure afhandelt.

DefaultAzureCredential ondersteunt meerdere verificatiemethoden en bepaalt welke u tijdens runtime moet gebruiken. Met deze aanpak kan uw app verschillende verificatiemethoden gebruiken in verschillende omgevingen (lokaal versus productie) zonder omgevingsspecifieke code te implementeren. In het overzicht van de Azure Identity-bibliotheek worden de volgorde en locaties uitgelegd waarin DefaultAzureCredential wordt gezocht naar referenties.

Voer de volgende stappen uit om verbinding te maken met Azure SQL Database met behulp van Entity Framework Core en de onderliggende DefaultAzureCredential klasse:

1. Voeg een ConnectionStrings sectie toe aan het appsettings.Development.json bestand, zodat deze overeenkomt met de volgende code. Vervang <server>.database.windows.net door de naam van de databaseserver zonder wachtwoord waarmee u verbinding wilt maken en <database> door de naam van de 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;"
       }
   }
   

   Opmerking

   Vergeet niet om de <your database-server-name> tijdelijke <your-database-name> aanduidingen in de databaseverbindingsreeks bij te werken. Verbindingsreeksen zonder wachtwoord kunnen veilig worden doorgevoerd in broncodebeheer, omdat ze geen geheimen bevatten, zoals gebruikersnamen, wachtwoorden of toegangssleutels.

   De verbindingsreeks zonder wachtwoord bevat een configuratiewaarde van Authentication=Active Directory Default, waarmee Entity Framework Core verbinding kan maken DefaultAzureCredential met Azure-services. Wanneer de app lokaal wordt uitgevoerd, wordt deze geverifieerd met de gebruiker waarmee u bent aangemeld bij Visual Studio. Zodra de app in Azure wordt geïmplementeerd, detecteert en past dezelfde code de beheerde identiteit toe die is gekoppeld aan de gehoste app, die u later configureert.

2. Vervang de inhoud van het bestand Program.cs door de volgende code:

   using Microsoft.AspNetCore.Mvc;
   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) =>
   {
       return 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 : DbContext
   {
       public PersonDbContext(DbContextOptions<PersonDbContext> options)
           : base(options)
       {
       }
   
       public DbSet<Person> Person { get; set; }
   }
   

   De voorgaande code verwerkt de volgende stappen:

   • Haalt de verbindingsreeks voor de database zonder wachtwoord op uit het appsettings.Development.json bestand voor lokale ontwikkeling of uit de omgevingsvariabelen voor gehoste productiescenario's.
   • Registreert de Entity Framework Core-klasse DbContext met de .NET-afhankelijkheidsinjectiecontainer. Meer informatie vindt DbContext u in de aan de slag-documentatie voor Entity Framework Core.
   • Configureert .NET 9.0 OpenAPI-ondersteuning met SwaggerUI om een gebruikersinterface te bieden die u kunt gebruiken om te communiceren met de app-eindpunten en -database.
   • Voegt eindpunten toe om entiteiten in de database op te halen en toe te voegen.
   • Definieert een Person klasse die één record in de Persons databasetabel vertegenwoordigt en de PersonDbContext klasse die is geregistreerd bij de .NET-afhankelijkheidsinjectiecontainer.

De migraties uitvoeren om de database te maken

Als u het databaseschema wilt bijwerken zodat het overeenkomt met uw gegevensmodel met behulp van Entity Framework Core, moet u een migratie gebruiken. Migraties kunnen een databaseschema maken en incrementeel bijwerken om dit gesynchroniseerd te houden met het gegevensmodel van uw toepassing. Meer informatie over dit patroon vindt u in het overzicht van migraties.

1. Open een terminalvenster naar de hoofdmap van uw project.

2. Voer de volgende opdracht uit om een initiële migratie te genereren waarmee de database kan worden gemaakt:

   • Visual Studio
   • .NET CLI

   Add-Migration InitialCreate
   

3. Er moet een Migrations map worden weergegeven in de projectmap, samen met een bestand InitialCreate met unieke nummers dat vooraf is gegaan. Voer de migratie uit om de database te maken met behulp van de volgende opdracht en de Entity Framework Core-hulpprogramma's maken het databaseschema in Azure dat is gedefinieerd door de PersonDbContext klasse.

   • Visual Studio
   • .NET CLI

   Update-Database
   

De app lokaal testen

De app is gereed om lokaal te worden getest. Zorg ervoor dat u bent aangemeld bij Visual Studio of de Azure CLI met hetzelfde account dat u hebt ingesteld als de beheerder voor uw database.

1. Druk boven aan Visual Studio op de knop Uitvoeren om het API-project te starten.

2. Vouw op de pagina Swagger UI de POST-methode uit en selecteer Probeer het.

3. Wijzig de voorbeeld-JSON om waarden op te nemen voor de voornaam en familienaam. Selecteer uitvoeren om een nieuwe record toe te voegen aan de database. De API retourneert een geslaagd antwoord.

   

4. Vouw de GET methode uit op de pagina Swagger UI en selecteer Uitproberen. Selecteer uitvoeren en de persoon die u zojuist hebt gemaakt, wordt geretourneerd.

Implementeren in Azure App Service

De app is klaar om te worden geïmplementeerd in Azure. Visual Studio kan een Azure App Service maken en uw toepassing in één werkstroom implementeren.

1. Zorg ervoor dat de app is gestopt en bouwt.

2. Klik in het Venster Solution Explorer van Visual Studio met de rechtermuisknop op het projectknooppunt op het hoogste niveau en selecteer Publiceren.

3. Selecteer In het publicatiedialoogvenster Azure als het implementatiedoel en selecteer vervolgens Volgende.

4. Voor het specifieke doel selecteert u Azure App Service (Windows) en selecteert u vervolgens Volgende.

5. Selecteer het groene + pictogram om een nieuwe App Service te maken waarop u wilt implementeren en voer de volgende waarden in:

   • naam: laat de standaardwaarde staan.
   • abonnementsnaam: selecteer het abonnement waarnaar u wilt implementeren.
   • Resourcegroep: Selecteer Nieuw en maak een nieuwe resourcegroep met de naam msdocs-dotnet-sql.
   • Hostingabonnement: Selecteer Nieuw om het dialoogvenster hostingabonnement te openen. Laat de standaardwaarden staan en selecteer OK.
   • Selecteer Maken om het oorspronkelijke dialoogvenster te sluiten. Visual Studio maakt de App Service-resource in Azure.

   

6. Zodra de resource is gemaakt, moet u in de lijst met app-services selecteren en vervolgens Volgende selecteren.

7. Schakel in de STAP API Management het selectievakje Deze stap overslaan onderaan in en selecteer Voltooien.

8. Selecteer Publiceren in de rechterbovenhoek van het overzicht van het publicatieprofiel om de app in Azure te implementeren.

Wanneer de implementatie is voltooid, start Visual Studio de browser om de gehoste app weer te geven. U ziet het Hello world bericht van het standaardeindpunt. Op dit moment werken de database-eindpunten echter niet correct in Azure. U moet nog steeds de beveiligde verbinding tussen de App Service en de SQL-database configureren om uw gegevens op te halen.

De App Service verbinden met Azure SQL Database

De volgende stappen zijn vereist om het App Service-exemplaar te verbinden met Azure SQL Database:

1. Maak een beheerde identiteit voor de App Service. De Microsoft.Data.SqlClient bibliotheek die in uw app is opgenomen, detecteert automatisch de beheerde identiteit, net zoals uw lokale Visual Studio-gebruiker.
2. Maak een SQL-databasegebruiker en koppel deze aan de door App Service beheerde identiteit.
3. Wijs SQL-rollen toe aan de databasegebruiker die lees-, schrijf- en mogelijk andere machtigingen toestaat.

Er zijn meerdere hulpprogramma's beschikbaar om deze stappen te implementeren:

De geïmplementeerde toepassing testen

Blader naar de URL van de app om te testen of de verbinding met Azure SQL Database werkt. U kunt de URL van uw app vinden op de overzichtspagina van App Service. Voeg het /person pad toe aan het einde van de URL om naar hetzelfde eindpunt te bladeren dat u lokaal hebt getest.

De persoon die u lokaal hebt gemaakt, moet worden weergegeven in de browser. Gefeliciteerd, uw toepassing is nu verbonden met Azure SQL Database in zowel lokale als gehoste omgevingen.

De middelen opschonen

Wanneer u klaar bent met het werken met de Azure SQL Database, verwijdert u de resource om onbedoelde kosten te voorkomen.

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

Verwante inhoud

• Zelfstudie: Een database beveiligen in Azure SQL Database
• databasetoegang tot SQL Database, SQL Managed Instance en Azure Synapse Analytics autoriseren
• Een overzicht van de beveiligingsmogelijkheden van Azure SQL Database en SQL Managed Instance
• Playbook voor het aanpakken van algemene beveiligingsvereisten met Azure SQL Database en Azure SQL Managed Instance