Implementação da base de dados SQL do Azure

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Você pode implantar automaticamente suas atualizações de banco de dados no banco de dados SQL do Azure após cada compilação bem-sucedida.

Pré-requisitos

Produto	Requisitos
Azure DevOps	- Um projeto Azure DevOps. - Permissões:     - Para criar conexões de serviço, você deve ter a função Administrador ou Criador para conexões de serviço .

DACPAC

A maneira mais simples de implantar um banco de dados é usando um pacote de camada de dados ou DACPAC. Os DACPACs permitem empacotar e implantar alterações de esquema e dados. Você pode criar um DACPAC usando o projeto de banco de dados SQL no Visual Studio.

A tarefa de implantação do Banco de Dados SQL do Azure é o mecanismo principal para implantar um banco de dados no Azure. Esta tarefa, tal como acontece com outras tarefas internas do Azure, requer uma ligação de serviço do Azure como entrada. A conexão de serviço do Azure armazena as credenciais para se conectar do Azure Pipelines ao Azure.

A maneira mais fácil de começar com essa tarefa é entrar como um usuário que possui a organização do Azure DevOps e a assinatura do Azure. Nesse caso, você não precisará criar manualmente a conexão de serviço. Caso contrário, para saber como criar uma conexão de serviço do Azure, consulte Criar uma conexão de serviço do Azure.

YAML

Para implantar um DACPAC em uma base de dados SQL do Azure, use a tarefa de implementação do Banco de Dados SQL do Azure. Adicione o seguinte trecho ao seu arquivo YAML:

- task: SqlAzureDacpacDeployment@1
  displayName: Execute Azure SQL : DacpacTask
  inputs:
    azureSubscription: '<Azure service connection>'
    ServerName: '<Database server name>'
    DatabaseName: '<Database name>'
    SqlUsername: '<SQL user name>'
    SqlPassword: '<SQL user password>'
    DacpacFile: '<Location of Dacpac file in $(Build.SourcesDirectory) after compilation>'

Clássico

Ao configurar um pipeline de compilação, use o modelo de área de trabalho .NET . Este modelo adiciona automaticamente as tarefas para criar o projeto e publicar artefatos, incluindo o DACPAC.

Para pipelines de lançamento clássicos, selecione Iniciar com um pipeline vazio, vincule os artefatos do pipeline de compilação e adicione a tarefa de Implantação de Base de Dados Azure SQL.

Scripts de SQL

Como alternativa, você pode usar scripts SQL em vez de DACPAC para implantar seu banco de dados. Abaixo está um script SQL simples que cria um banco de dados vazio:

  USE [main]
  GO
  IF NOT EXISTS (SELECT name FROM main.sys.databases WHERE name = N'DatabaseExample')
  CREATE DATABASE [DatabaseExample]
  GO

Para executar scripts SQL a partir do seu pipeline, terá de adicionar e remover regras de firewall no Azure. Sem essas regras, o agente do Azure Pipelines não pode se comunicar com o Banco de Dados SQL do Azure.

Definir regras de firewall do Azure

O script PowerShell a seguir cria regras de firewall. Salve-o como SetAzureFirewallRule.ps1 e adicione-o ao seu repositório:

ARM

[CmdletBinding(DefaultParameterSetName = 'None')]
param
(
  [String] [Parameter(Mandatory = $true)] $ServerName,
  [String] [Parameter(Mandatory = $true)] $ResourceGroupName,
  [String] $FirewallRuleName = "AzureWebAppFirewall"
)
$agentIP = (New-Object net.webclient).downloadstring("https://api.ipify.org")
New-AzSqlServerFirewallRule -ResourceGroupName $ResourceGroupName -ServerName $ServerName -FirewallRuleName $FirewallRuleName -StartIPAddress $agentIP -EndIPAddress $agentIP

ASM (Clássico)

[CmdletBinding(DefaultParameterSetName = 'None')]
param
(
  [String] [Parameter(Mandatory = $true)] $ServerName,
  [String] [Parameter(Mandatory = $true)] $ResourceGroupName,
  [String] $FirewallRuleName = "AzureWebAppFirewall"
)

$ErrorActionPreference = 'Stop'

function New-AzureSQLServerFirewallRule {
  $agentIP = (New-Object net.webclient).downloadstring("https://api.ipify.org")
  New-AzureSqlDatabaseServerFirewallRule -StartIPAddress $agentIP -EndIPAddress $agentIP -RuleName $FirewallRuleName -ServerName $ServerName
}

function Update-AzureSQLServerFirewallRule{
  $agentIP= (New-Object net.webclient).downloadstring("https://api.ipify.org")
  Set-AzureSqlDatabaseServerFirewallRule -StartIPAddress $agentIP -EndIPAddress $agentIP -RuleName $FirewallRuleName -ServerName $ServerName
}

if ((Get-AzureSqlDatabaseServerFirewallRule -ServerName $ServerName -RuleName $FirewallRuleName -ErrorAction SilentlyContinue) -eq $null)
{
  New-AzureSQLServerFirewallRule
}
else
{
  Update-AzureSQLServerFirewallRule
}

Remover regras de firewall do Azure

O script PowerShell a seguir remove regras de firewall. Salve-o como RemoveAzureFirewallRule.ps1 e adicione-o ao seu repositório:

ARM

[CmdletBinding(DefaultParameterSetName = 'None')]
param
(
  [String] [Parameter(Mandatory = $true)] $ServerName,
  [String] [Parameter(Mandatory = $true)] $ResourceGroupName,
  [String] $FirewallRuleName = "AzureWebAppFirewall"
)
Remove-AzSqlServerFirewallRule -ServerName $ServerName -FirewallRuleName $FirewallRuleName -ResourceGroupName $ResourceGroupName

ASM (Clássico)

[CmdletBinding(DefaultParameterSetName = 'None')]
param
(
  [String] [Parameter(Mandatory = $true)] $ServerName,
  [String] [Parameter(Mandatory = $true)] $ResourceGroupName,
  [String] $FirewallRuleName = "AzureWebAppFirewall"
)

$ErrorActionPreference = 'Stop'

if ((Get-AzureSqlDatabaseServerFirewallRule -ServerName $ServerName -RuleName $FirewallRuleName -ErrorAction SilentlyContinue))
{
  Remove-AzureSqlDatabaseServerFirewallRule -RuleName $FirewallRuleName -ServerName $ServerName
}

Implantar banco de dados com scripts SQL

O exemplo a seguir descreve as etapas para adicionar regras de firewall, implantar seu banco de dados usando scripts SQL e remover as regras de firewall:

YAML

variables:
  AzureSubscription: '<SERVICE_CONNECTION_NAME>'
  ResourceGroupName: '<RESOURCE_GROUP_NAME>'
  ServerName: '<DATABASE_SERVER_NAME>'
  ServerFqdn: '<DATABASE_FQDN>'
  DatabaseName: '<DATABASE_NAME>'
  AdminUser: '<DATABASE_USERNAME>'
  AdminPassword: '<DATABASE_PASSWORD>'
  SQLFile: '<LOCATION_OF_SQL_FILE_IN_$(Build.SourcesDirectory)>'

steps:
- task: AzurePowerShell@5
  displayName: 'Set Azure firewall rules'
  inputs:
    azureSubscription: '$(AzureSubscription)'
    ScriptType: filePath
    ScriptPath: '$(Build.SourcesDirectory)\scripts\SetAzureFirewallRule.ps1'
    ScriptArguments: '-ServerName $(ServerName) -ResourceGroupName $(ResourceGroupName)'
    azurePowerShellVersion: LatestVersion

- task: PowerShell@2
  inputs:
  displayName: 'Install SqlServer module if not present'
    targetType: 'inline'
    script: |
      if (-not (Get-Module -ListAvailable -Name SqlServer)) {
          Install-Module -Name SqlServer -Force -AllowClobber
      }

- task: PowerShell@2
  displayName: 'Deploy database'
  inputs:
    targetType: 'inline'
    script: |
      Invoke-Sqlcmd -InputFile $(SQLFile) -ServerInstance $(ServerFqdn) -Database $(DatabaseName) -Username $(AdminUser) -Password $(AdminPassword)

- task: AzurePowerShell@5
  displayName: 'Remove Azure firewall rules'
  inputs:
    azureSubscription: '$(AzureSubscription)'
    ScriptType: filePath
    ScriptPath: '$(Build.SourcesDirectory)\scripts\RemoveAzureFirewallRule.ps1'
    ScriptArguments: '-ServerName $(ServerName) -ResourceGroupName $(ResourceGroupName)'
    azurePowerShellVersion: LatestVersion

Clássico

Para pipelines clássicos, certifique-se de que o script SQL para implantar o banco de dados e os scripts do Azure PowerShell para configurar regras de firewall sejam incluídos como parte do artefato de compilação.

Para pipelines de lançamento clássicos, selecione Iniciar com um pipeline vazio, vincule os artefatos do seu pipeline de build e depois adicione as seguintes tarefas:

1. Use a tarefa do Azure PowerShell para adicionar uma regra de firewall no Azure, permitindo que o agente do Azure Pipelines se conecte ao Banco de Dados SQL do Azure. O script requer um argumento - o nome do servidor SQL que você criou.

2. Use a tarefa PowerShell para invocar o SQLCMD e executar os seus scripts. Use o seguinte script embutido:

   if (-not (Get-Module -ListAvailable -Name SqlServer)) {
     Install-Module -Name SqlServer -Force -AllowClobber
   }
   
   Invoke-Sqlcmd -InputFile $(SQLFile) -ServerInstance $(ServerFqdn) -Database $(DatabaseName) -Username $(AdminUser) -Password $(AdminPassword)
   

3. Use outra tarefa do Azure PowerShell para remover a regra de firewall no Azure.

   

Implantar o banco de dados condicionalmente

Você pode optar por implantar apenas compilações específicas em seu banco de dados do Azure, oferecendo mais controle sobre quais alterações são aplicadas com base em critérios como a ramificação de origem ou o status da compilação.

YAML

Para fazer isso no YAML, você pode usar uma destas técnicas:

• Isole as etapas de implantação em um trabalho separado e aplique uma condição a esse trabalho.

• Adicione uma condição diretamente à etapa.

O exemplo abaixo mostra como implantar apenas compilações da ramificação principal usando condições:

- task: SqlAzureDacpacDeployment@1
  condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
  inputs:
    azureSubscription: '<Azure service connection>'
    ServerName: '<Database server name>'
    DatabaseName: '<Database name>'
    SqlUsername: '<SQL user name>'
    SqlPassword: '<SQL user password>'
    DacpacFile: '<Location of Dacpac file in $(Build.SourcesDirectory) after compilation>'

Clássico

Com os pipelines de lançamento clássicos, pode-se implementar várias verificações e condições para controlar quando e quais implementações são ativadas. Aqui estão algumas estratégias que você pode usar:

• Use filtros de ramificação para configurar seus gatilhos de implantação contínua para disparar uma versão sempre que uma nova compilação de uma ramificação específica estiver disponível.

• Utilize aprovações de pré-implantação para designar aprovadores que podem aprovar ou rejeitar a implantação numa fase específica.

• Defina um conjunto de portas para garantir que o pipeline de liberação atenda a critérios específicos antes da implantação sem exigir a intervenção do usuário.

Nota

Em alguns cenários, talvez seja necessário permitir intervalos de endereços IP para uma região específica. Esses intervalos são atualizados semanalmente e podem ser baixados como um arquivo JSON. Consulte Rede de agentes hospedados pela Microsoft para obter mais detalhes.

Mais ações SQL

A tarefa Implantação do Dacpac do SQL Azure pode não abranger todas as ações do SQL Server que você precisa executar. Nesses casos, você pode usar o PowerShell ou scripts de linha de comando para executar os comandos necessários.

Esta seção aborda casos de uso comuns para invocar a ferramentaSqlPackage.exe. Antes de executar essa ferramenta, verifique se você está usando um agente auto-hospedado com a ferramenta instalada.

Nota

Se você executar SQLPackage a partir da pasta onde ele está instalado, você deve prefixar o caminho com & e envolvê-lo em aspas duplas.

Sintaxe básica

<Path of SQLPackage.exe> <Arguments to SQLPackage.exe>

Você pode usar qualquer um dos seguintes scripts SQL com base na ação que deseja executar:

Extrato

Cria um arquivo de instantâneo de banco de dados (.dacpac) a partir de um servidor SQL ativo ou do Banco de Dados SQL do Microsoft Azure.

Sintaxe do comando:

SqlPackage.exe /TargetFile:"<Target location of dacpac file>" /Action:Extract
/SourceServerName:"<ServerName>.database.windows.net"
/SourceDatabaseName:"<DatabaseName>" /SourceUser:"<Username>" /SourcePassword:"<Password>"

ou

SqlPackage.exe /action:Extract /tf:"<Target location of dacpac file>"
/SourceConnectionString:"Data Source=ServerName;Initial Catalog=DatabaseName;Integrated Security=SSPI;Persist Security Info=False;"

Exemplo:

SqlPackage.exe /TargetFile:"C:\temp\test.dacpac" /Action:Extract /SourceServerName:"DemoSqlServer.database.windows.net.placeholder"
 /SourceDatabaseName:"Testdb" /SourceUser:"ajay" /SourcePassword:"SQLPassword"

Ajuda:

sqlpackage.exe /Action:Extract /?

Publicar

Atualiza incrementalmente um esquema de banco de dados para corresponder ao esquema de um arquivo .dacpac de origem. Se o banco de dados não existir no servidor, a operação de publicação o criará. Caso contrário, um banco de dados existente será atualizado.

Sintaxe do comando:

SqlPackage.exe /SourceFile:"<Dacpac file location>" /Action:Publish /TargetServerName:"<ServerName>.database.windows.net"
/TargetDatabaseName:"<DatabaseName>" /TargetUser:"<Username>" /TargetPassword:"<Password> "

Exemplo:

SqlPackage.exe /SourceFile:"E:\dacpac\ajyadb.dacpac" /Action:Publish /TargetServerName:"DemoSqlServer.database.windows.net.placeholder"
/TargetDatabaseName:"Testdb4" /TargetUser:"ajay" /TargetPassword:"SQLPassword"

Ajuda:

sqlpackage.exe /Action:Publish /?

Export

Exporta um banco de dados ativo, incluindo esquema de banco de dados e dados do usuário, do SQL Server ou do Banco de Dados SQL do Microsoft Azure para um pacote BACPAC (arquivo .bacpac).

Sintaxe do comando:

SqlPackage.exe /TargetFile:"<Target location for bacpac file>" /Action:Export /SourceServerName:"<ServerName>.database.windows.net"
/SourceDatabaseName:"<DatabaseName>" /SourceUser:"<Username>" /SourcePassword:"<Password>"

Exemplo:

SqlPackage.exe /TargetFile:"C:\temp\test.bacpac" /Action:Export /SourceServerName:"DemoSqlServer.database.windows.net.placeholder"
/SourceDatabaseName:"Testdb" /SourceUser:"ajay" /SourcePassword:"SQLPassword"

Ajuda:

sqlpackage.exe /Action:Export /?

Importar

Importa os dados de esquema e tabela de um pacote BACPAC para um novo banco de dados de usuário em uma instância do SQL Server ou do Banco de dados SQL do Microsoft Azure.

Sintaxe do comando:

SqlPackage.exe /SourceFile:"<Bacpac file location>" /Action:Import /TargetServerName:"<ServerName>.database.windows.net"
/TargetDatabaseName:"<DatabaseName>" /TargetUser:"<Username>" /TargetPassword:"<Password>"

Exemplo:

SqlPackage.exe /SourceFile:"C:\temp\test.bacpac" /Action:Import /TargetServerName:"DemoSqlServer.database.windows.net.placeholder"
/TargetDatabaseName:"Testdb" /TargetUser:"ajay" /TargetPassword:"SQLPassword"

Ajuda:

sqlpackage.exe /Action:Import /?

DeployReport

Cria um relatório XML das alterações que seriam feitas por uma ação de publicação.

Sintaxe do comando:

SqlPackage.exe /SourceFile:"<Dacpac file location>" /Action:DeployReport /TargetServerName:"<ServerName>.database.windows.net"
/TargetDatabaseName:"<DatabaseName>" /TargetUser:"<Username>" /TargetPassword:"<Password>" /OutputPath:"<Output XML file path for deploy report>"

Exemplo:

SqlPackage.exe /SourceFile:"E: \dacpac\ajyadb.dacpac" /Action:DeployReport /TargetServerName:"DemoSqlServer.database.windows.net.placeholder"
/TargetDatabaseName:"Testdb" /TargetUser:"ajay" /TargetPassword:"SQLPassword" /OutputPath:"C:\temp\deployReport.xml" 

Ajuda:

sqlpackage.exe /Action:DeployReport /?

DriftReport

Cria um relatório XML das alterações feitas em um banco de dados registrado desde que ele foi registrado pela última vez.

Sintaxe do comando:

SqlPackage.exe /Action:DriftReport /TargetServerName:"<ServerName>.database.windows.net" /TargetDatabaseName:"<DatabaseName>"
/TargetUser:"<Username>" /TargetPassword:"<Password>" /OutputPath:"<Output XML file path for drift report>"

Exemplo:

SqlPackage.exe /Action:DriftReport /TargetServerName:"DemoSqlServer.database.windows.net.placeholder" /TargetDatabaseName:"Testdb"
/TargetUser:"ajay" /TargetPassword:"SQLPassword" /OutputPath:"C:\temp\driftReport.xml"

Ajuda:

sqlpackage.exe /Action:DriftReport /?

Script

Cria um script de atualização incremental Transact-SQL que atualiza o esquema de um destino para corresponder ao esquema de uma origem.

Sintaxe do comando:

SqlPackage.exe /SourceFile:"<Dacpac file location>" /Action:Script /TargetServerName:"<ServerName>.database.windows.net"
/TargetDatabaseName:"<DatabaseName>" /TargetUser:"<Username>" /TargetPassword:"<Password>" /OutputPath:"<Output SQL script file path>"

Exemplo:

SqlPackage.exe /Action:Script /SourceFile:"E:\dacpac\ajyadb.dacpac" /TargetServerName:"DemoSqlServer.database.windows.net.placeholder"
/TargetDatabaseName:"Testdb" /TargetUser:"ajay" /TargetPassword:"SQLPassword" /OutputPath:"C:\temp\test.sql"
/Variables:StagingDatabase="Staging DB Variable value"

Ajuda:

sqlpackage.exe /Action:Script /?

Conteúdo relacionado

• Conexões de serviço do Azure Resource Manager

• Resolução de problemas em execuções de pipeline

• Resolver problemas com conexões de serviço ARM