Ansluta till och fråga Azure SQL Database med hjälp av .NET och biblioteket Microsoft.Data.SqlClient

gäller för:Azure SQL Database

Den här snabbstarten beskriver hur du ansluter ett program till en databas i Azure SQL Database och utför frågor med hjälp av .NET och biblioteket Microsoft.Data.SqlClient . Den här snabbstarten följer den rekommenderade metoden för lösenordsfri anslutning till databasen. Du kan lära dig mer om lösenordslösa anslutningar på lösenordsfri hubb.

Förutsättningar

• En prenumeration för Azure.
• En Azure SQL-databas som konfigurerats för autentisering med Microsoft Entra-ID (tidigare Azure Active Directory). Du kan skapa en med hjälp av snabbstarten Skapa databas.
• Den senaste versionen av Azure CLI.
• Visual Studio eller senare med arbetsbelastningen ASP.NET och webbutveckling.
• .NET 7.0 eller senare.

Konfigurera databasen

Säkra, lösenordslösa anslutningar till Azure SQL Database kräver vissa databaskonfigurationer. Kontrollera följande inställningar på din logiska servern i Azure för att ansluta korrekt till Azure SQL Database i både lokala och värdbaserade miljöer:

1. För lokala utvecklingsanslutningar kontrollerar du att den logiska servern är konfigurerad så att din lokala dators IP-adress och andra Azure-tjänster kan ansluta:

   • Gå till sidan Nätverk på din server.

   • Använd Valda nätverk radioknapp för att visa de ytterligare konfigurationsalternativen.

   • Välj Lägg till din klient-IPv4-adress (xx.xx.xx.xx.xx) för att lägga till en brandväggsregel som aktiverar anslutningar från din lokala IPv4-adress. Du kan också välja + Lägg till en brandväggsregel för att ange en specifik IP-adress.

   • Kontrollera att kryssrutan Tillåt Att Azure-tjänster och resurser får åtkomst till den här servern är markerad.

     

     Varning

     Att aktivera inställningen Tillåt Azure-tjänster och resurser att komma åt den här servern är inte en rekommenderad säkerhetspraxis för produktionsscenarier. Verkliga program bör implementera säkrare metoder, till exempel starkare brandväggsbegränsningar eller konfigurationer av virtuella nätverk.

     Du kan läsa mer om databassäkerhetskonfigurationer på följande resurser:

     • Konfigurera Azure SQL Database-brandväggsregler.
     • Konfigurera ett virtuellt nätverk med privata slutpunkter.

2. Servern måste också ha Microsoft Entra-autentisering aktiverat och ha ett Microsoft Entra-administratörskonto tilldelat. För lokala utvecklingsanslutningar ska Microsoft Entra-administratörskontot vara ett konto som du också kan logga in på Visual Studio eller Azure CLI med lokalt. Du kan kontrollera om din server har Microsoft Entra-autentisering aktiverat på sidan Microsoft Entra-ID på den logiska servern.

   

3. Om du använder ett personligt Azure-konto kontrollerar du att du har Microsoft Entra-konfiguration och konfigurerat för Azure SQL Database för att tilldela ditt konto som serveradministratör. Om du använder ett företagskonto är Microsoft Entra-ID förmodligen redan konfigurerat åt dig.

Skapa projektet

För stegen framåt skapar du ett .NET Minimalt webb-API med antingen .NET CLI eller Visual Studio 2022.

Lägg till biblioteket Microsoft.Data.SqlClient

Om du vill ansluta till Azure SQL Database med hjälp av .NET installerar du Microsoft.Data.SqlClient. Det här paketet fungerar som en dataprovider för att ansluta till databaser, köra kommandon och hämta resultat.

dotnet add package Microsoft.Data.SqlClient

Konfigurera anslutningssträngen

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

"ConnectionStrings": {
    "AZURE_SQL_CONNECTIONSTRING": "Server=tcp:<database-server-name>.database.windows.net,1433;Initial Catalog=<database-name>;Persist Security Info=False;User ID=<user-id>;Password=<password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=False;"
}

Lägg till koden för att ansluta till Azure SQL Database

Ersätt innehållet i Program.cs filen med följande kod, som utför följande viktiga steg:

• Hämtar den lösenordslösa anslutningssträngen från appsettings.json
• Skapar en Persons tabell i databasen under start (endast för testningsscenarier)
• Skapar en HTTP GET slutpunkt för att hämta alla poster som lagras i Persons tabellen
• Skapar en HTTP POST-slutpunkt för att lägga till nya poster i Persons tabellen

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

Lägg slutligen till Person klassen längst ned i Program.cs filen. Den här klassen representerar en enskild post i databasens Persons tabell.

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

Köra och testa appen lokalt

Appen är redo att testas lokalt. Kontrollera att du är inloggad i Visual Studio eller Azure CLI med samma konto som du angav som administratör för databasen.

1. Tryck på körningsknappen överst i Visual Studio för att starta API-projektet.

2. På sidan Swagger-användargränssnitt expanderar du POST-metoden och väljer Prova.

3. Ändra JSON-exemplet så att det first innehåller värden för och-namnet last . Välj Kör för att lägga till en ny post i databasen. API:et returnerar ett lyckat svar.

   

4. GET Expandera metoden på swagger-användargränssnittssidan och välj Prova. Välj Köroch den person som du nyss skapade returneras.

Distribuera till Azure App Service

Appen är redo att distribueras till Azure. Visual Studio kan skapa en Azure App Service och distribuera ditt program i ett enda arbetsflöde.

1. Kontrollera att appen har stoppats och att den byggs framgångsrikt.

2. Högerklicka på projektnoden på den översta nivån i Solution Explorer i Visual Studio och välj Publicera.

3. I publiceringsdialogrutan väljer du Azure som distributionsmål och väljer sedan Nästa.

4. För det specifika målet väljer du Azure App Service (Windows)och väljer sedan Nästa.

5. Välj ikonen + för att skapa en ny App Service att distribuera till och ange följande värden:

   • Namn: Lämna standardvärdet.
   • Prenumerationsnamn: Välj den prenumeration som du vill distribuera till.
   • Resursgrupp: Välj Ny och skapa en ny resursgrupp med namnet msdocs-dotnet-sql.
   • Värdplan: Välj Ny för att öppna dialogrutan värdplan. Lämna standardvärdena och välj OK.
   • Välj Skapa för att stänga den ursprungliga dialogrutan. Visual Studio skapar App Service-resursen i Azure.

   

6. När resursen har skapats kontrollerar du att den är markerad i listan över apptjänster och väljer sedan Nästa.

7. I API Management-steget markerar du kryssrutan Hoppa över det här steget längst ned och väljer sedan Slutför.

8. I steget Slutför väljer du Stäng om dialogrutan inte stängs automatiskt.

9. Välj Publicera längst upp till höger i sammanfattningen av publiceringsprofilen för att distribuera appen till Azure.

När distributionen är klar startar Visual Studio webbläsaren för att visa den värdbaserade appen, men i det här läget fungerar inte appen korrekt i Azure. Du måste fortfarande konfigurera den säkra anslutningen mellan App Service och SQL-databasen för att hämta dina data.

Ansluta App Service till Azure SQL Database

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

Testa det distribuerade programmet

1. Välj knappen Bläddra överst på apptjänstens översiktssida för att starta appens rot-URL.

2. /swagger/index.html Lägg till sökvägen till URL:en för att läsa in samma Swagger-testsida som du använde lokalt.

3. Kör test GET - och POST-begäranden för att kontrollera att slutpunkterna fungerar som förväntat.

   Tips/Råd

   Om du får ett 500 internt serverfel under testningen kan det bero på databasnätverkskonfigurationerna. Kontrollera att den logiska servern har konfigurerats med de inställningar som beskrivs i avsnittet Konfigurera databasen.

Ditt program är nu anslutet till Azure SQL Database i både lokala och värdbaserade miljöer.

Rensa resurserna

När du är klar med arbetet med Azure SQL Database tar du bort resursen för att undvika oavsiktliga kostnader.

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

Relaterat innehåll

• Snabbstart: Skapa en enkel databas – Azure SQL Database