Share via

Conectar-se e consultar o Banco de Dados SQL do Azure usando o .NET e a biblioteca Microsoft.Data.SqlClient

  • Artigo

Aplica-se a:Banco de Dados SQL do Azure

Este guia de início rápido descreve como conectar um aplicativo a um banco de dados no Banco de Dados SQL do Azure e executar consultas usando o .NET e a biblioteca Microsoft.Data.SqlClient . Este início rápido segue a abordagem sem senha recomendada para se conectar ao banco de dados. Você pode saber mais sobre conexões sem senha no hub sem senha.

Pré-requisitos

Configurar o banco de dados

Conexões seguras e sem senha com o Banco de Dados SQL do Azure exigem determinadas configurações de banco de dados. Verifique as seguintes configurações em seu servidor lógico no Azure para se conectar corretamente ao Banco de Dados SQL do Azure em ambientes locais e hospedados:

  1. Para conexões de desenvolvimento local, verifique se o servidor lógico está configurado para permitir que o endereço IP da máquina local e outros serviços do Azure se conectem:

    • Navegue até a página Rede do seu servidor.

    • Alterne o botão de opção Redes selecionadas para mostrar opções de configuração adicionais.

    • Selecione Adicionar o endereço IPv4 do cliente (xx.xx.xx.xx) para adicionar uma regra de firewall que habilitará conexões do endereço IPv4 da máquina local. Como alternativa, você também pode selecionar + Adicionar uma regra de firewall para inserir um endereço IP específico de sua escolha.

    • Verifique se a caixa de seleção Permitir que os serviços e recursos do Azure acessem este servidor está marcada.

      A screenshot showing how to configure firewall rules.

      Aviso

      Habilitar a configuração Permitir que os serviços e recursos do Azure acessem esse servidor não é uma prática de segurança recomendada para cenários de produção. Aplicativos reais devem implementar abordagens mais seguras, como restrições de firewall mais fortes ou configurações de rede virtual.

      Você pode ler mais sobre configurações de segurança de banco de dados nos seguintes recursos:

  2. O servidor também deve ter a autenticação do Microsoft Entra habilitada e ter uma conta de administrador do Microsoft Entra atribuída. Para conexões de desenvolvimento local, a conta de administrador do Microsoft Entra deve ser uma conta com a qual você também pode fazer logon no Visual Studio ou na CLI do Azure localmente. Você pode verificar se o servidor tem a autenticação do Microsoft Entra habilitada na página ID do Microsoft Entra do servidor lógico.

    A screenshot showing how to enable Microsoft Entra authentication.

  3. Se estiver a utilizar uma conta pessoal do Azure, certifique-se de que tem a configuração do Microsoft Entra e configurada para a Base de Dados SQL do Azure para atribuir a sua conta como administrador de servidor. Se você estiver usando uma conta corporativa, o Microsoft Entra ID provavelmente já estará configurado para você.

Criar o projeto

Para as etapas futuras, crie uma API Web Mínima do .NET usando a CLI do .NET ou o Visual Studio 2022.

  1. No menu Visual Studio, navegue até Arquivo>Novo>Projeto...

  2. Na janela de diálogo, digite ASP.NET na caixa de pesquisa do modelo de projeto e selecione o resultado da API Web ASP.NET Core. Escolha Avançar na parte inferior da caixa de diálogo.

  3. Para o Nome do projeto, digite DotNetSQL. Deixe os valores padrão para o restante dos campos e selecione Avançar.

  4. Para o Framework, selecione .NET 7.0 e desmarque Usar controladores (desmarque para usar APIs mínimas). Este guia de início rápido usa um modelo de API mínima para simplificar a criação e a configuração de pontos finais.

  5. Selecione Criar. O novo projeto é aberto dentro do ambiente do Visual Studio.

Adicione a biblioteca Microsoft.Data.SqlClient

Para se conectar ao Banco de Dados SQL do Azure usando o .NET, instale o Microsoft.Data.SqlClient. Este pacote atua como um provedor de dados para se conectar a bancos de dados, executar comandos e recuperar resultados.

Nota

Certifique-se de instalar Microsoft.Data.SqlClient e não System.Data.SqlClient. Microsoft.Data.SqlClient é uma versão mais recente da biblioteca de cliente SQL que fornece recursos adicionais.

  1. Na janela Gerenciador de Soluções, clique com o botão direito do mouse no nó Dependênciasdo projeto e selecione Gerenciar Pacotes NuGet.

  2. Na janela resultante, procure SqlClient. Localize o Microsoft.Data.SqlClient resultado e selecione Instalar.

Configurar a cadeia de ligação

Para desenvolvimento local com conexões sem senha ao Banco de Dados SQL do Azure, adicione a seção a seguir ConnectionStrings ao appsettings.json arquivo. Substitua os espaços reservados e <database-name> pelos <database-server-name> seus próprios valores.

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

A cadeia de conexão sem senha define um valor de configuração de , que instrui a biblioteca a Microsoft.Data.SqlClient se conectar ao Banco de Authentication="Active Directory Default"Dados SQL do Azure usando uma classe chamada DefaultAzureCredential. DefaultAzureCredential habilita conexões sem senha para serviços do Azure e é fornecido pela biblioteca de Identidade do Azure da qual a biblioteca de cliente SQL depende. DefaultAzureCredential Suporta vários métodos de autenticação e determina quais usar em tempo de execução para diferentes ambientes.

Por exemplo, quando o aplicativo é executado localmente, autentica por meio do usuário com quem você está conectado ao Visual Studio ou de outras ferramentas locais, DefaultAzureCredential como a CLI do Azure. Depois que o aplicativo é implantado no Azure, o mesmo código descobre e aplica a identidade gerenciada associada ao aplicativo hospedado, que você configurará posteriormente. A visão geral da Biblioteca de Identidades do Azure explica a ordem e os locais em que DefaultAzureCredential as credenciais são procuradas.

Nota

Cadeias de conexão sem senha são seguras para confirmar o controle do código-fonte, pois não contêm segredos como nomes de usuário, senhas ou chaves de acesso.

Adicionar o código para se conectar ao Banco de Dados SQL do Azure

Substitua o Program.cs conteúdo do arquivo pelo código a seguir, que executa as seguintes etapas importantes:

  • Recupera a cadeia de conexão sem senha de appsettings.json
  • Cria uma Persons tabela no banco de dados durante a inicialização (somente para cenários de teste)
  • Cria um ponto de extremidade HTTP GET para recuperar todos os registros armazenados na Persons tabela
  • Cria um ponto de extremidade HTTP POST para adicionar novos registros à Persons tabela
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();

Finalmente, adicione a Person classe à parte inferior do Program.cs arquivo. Essa classe representa um único registro na tabela do Persons banco de dados.

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

Executar e testar o aplicativo localmente

O aplicativo está pronto para ser testado localmente. Verifique se você está conectado ao Visual Studio ou à CLI do Azure com a mesma conta definida como administrador para seu banco de dados.

  1. Pressione o botão Executar na parte superior do Visual Studio para iniciar o projeto de API.

  2. Na página Swagger UI, expanda o método POST e selecione Experimentar.

  3. Modifique o JSON de exemplo para incluir valores para o nome e o sobrenome. Selecione Executar para adicionar um novo registro ao banco de dados. A API retorna uma resposta bem-sucedida.

    A screenshot showing how to test the API.

  4. Expanda o método GET na página Swagger UI e selecione Experimentar. Escolha Executar e a pessoa que você acabou de criar será retornada.

Implementar no Serviço de Aplicações do Azure

O aplicativo está pronto para ser implantado no Azure. O Visual Studio pode criar um Serviço de Aplicativo do Azure e implantar seu aplicativo em um único fluxo de trabalho.

  1. Verifique se o aplicativo foi interrompido e compilado com êxito.

  2. Na janela Gerenciador de Soluções do Visual Studio, clique com o botão direito do mouse no nó do projeto de nível superior e selecione Publicar.

  3. Na caixa de diálogo de publicação, selecione Azure como o destino de implantação e, em seguida, selecione Avançar.

  4. Para o destino específico, selecione Serviço de Aplicativo do Azure (Windows) e selecione Avançar.

  5. Selecione o + ícone para criar um novo Serviço de Aplicativo para implantar e insira os seguintes valores:

    • Nome: Deixe o valor padrão.

    • Nome da assinatura: selecione a assinatura na qual implantar.

    • Grupo de recursos: Selecione Novo e crie um novo grupo de recursos chamado msdocs-dotnet-sql.

    • Plano de hospedagem: Selecione Novo para abrir a caixa de diálogo do plano de hospedagem. Deixe os valores padrão e selecione OK.

    • Selecione Criar para fechar a caixa de diálogo original. O Visual Studio cria o recurso Serviço de Aplicativo no Azure.

      A screenshot showing how to deploy with Visual Studio.

  6. Depois que o recurso for criado, verifique se ele está selecionado na lista de serviços de aplicativo e selecione Avançar.

  7. Na etapa Gerenciamento de API, marque a caixa de seleção Ignorar esta etapa na parte inferior e escolha Concluir.

  8. Na etapa Concluir, selecione Fechar se a caixa de diálogo não fechar automaticamente.

  9. Selecione Publicar no canto superior direito do resumo do perfil de publicação para implantar o aplicativo no Azure.

Quando a implantação termina, o Visual Studio inicia o navegador para exibir o aplicativo hospedado, mas neste momento o aplicativo não funciona corretamente no Azure. Você ainda precisa configurar a conexão segura entre o Serviço de Aplicativo e o banco de dados SQL para recuperar seus dados.

Conectar o Serviço de Aplicativo ao Banco de Dados SQL do Azure

As etapas a seguir são necessárias para criar uma conexão sem senha entre a instância do Serviço de Aplicativo e o Banco de Dados SQL do Azure:

  1. Crie uma identidade gerenciada para o Serviço de Aplicativo. A Microsoft.Data.SqlClient biblioteca incluída em seu aplicativo descobrirá automaticamente a identidade gerenciada, assim como descobriu seu usuário local do Visual Studio.
  2. Crie um usuário do banco de dados SQL e associe-o à identidade gerenciada do Serviço de Aplicativo.
  3. Atribua funções SQL ao usuário do banco de dados que permitam leitura, gravação e potencialmente outras permissões.

Há várias ferramentas disponíveis para implementar essas etapas:

O Service Connector é uma ferramenta que simplifica conexões autenticadas entre diferentes serviços no Azure. Atualmente, o Service Connector dá suporte à conexão de um Serviço de Aplicativo a um banco de dados SQL por meio da CLI do Azure usando o az webapp connection create sql comando. Este único comando completa as três etapas mencionadas acima para você.

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

Você pode verificar as alterações feitas pelo Service Connector nas configurações do Serviço de Aplicativo.

  1. Navegue até a página Identidade do seu Serviço de Aplicativo. Na guia Sistema atribuído, o Status deve ser definido como Ativado. Esse valor significa que uma identidade gerenciada atribuída ao sistema foi habilitada para seu aplicativo.

  2. Navegue até a página Configuração do seu Serviço de Aplicativo. Na guia Cadeias de conexão, você verá uma cadeia de conexão chamada AZURE_SQL_CONNECTIONSTRING. Selecione o texto Clique para mostrar o valor para exibir a cadeia de conexão sem senha gerada. O nome dessa cadeia de conexão corresponde àquela que você configurou em seu aplicativo, portanto, ela será descoberta automaticamente ao ser executada no Azure.

Importante

Embora essa solução forneça uma abordagem simples para começar, ela não é uma prática recomendada para ambientes de nível de produção. Nesses cenários, o aplicativo não deve executar todas as operações usando uma única identidade elevada. Você deve tentar implementar o princípio de menor privilégio configurando várias identidades com permissões específicas para tarefas específicas.

Você pode ler mais sobre como configurar funções de banco de dados e segurança nos seguintes recursos:

Testar o aplicativo implantado

  1. Selecione o botão Procurar na parte superior da página de visão geral do Serviço de Aplicativo para iniciar a URL raiz do seu aplicativo.

  2. Anexe o /swagger/index.html caminho à URL para carregar a mesma página de teste do Swagger usada localmente.

  3. Execute solicitações GET e POST de teste para verificar se os pontos de extremidade funcionam conforme o esperado.

Gorjeta

Se você receber um erro 500 Internal Server durante o teste, pode ser devido às configurações de rede do banco de dados. Verifique se o servidor lógico está configurado com as configurações descritas na seção Configurar o banco de dados .

Parabéns! Seu aplicativo agora está conectado ao Banco de Dados SQL do Azure em ambientes locais e hospedados.

Limpar os recursos

Quando terminar de trabalhar com o Banco de Dados SQL do Azure, exclua o recurso para evitar custos não intencionais.

  1. Na barra de pesquisa do portal do Azure, procure SQL do Azure e selecione o resultado correspondente.

  2. Localize e selecione seu banco de dados na lista de bancos de dados.

  3. Na página Visão Geral do Banco de Dados SQL do Azure, selecione Excluir.

  4. Na página Azure que você tem certeza de que deseja excluir... que é aberta, digite o nome do seu banco de dados para confirmar e selecione Excluir.