Tarefa de implantação do banco de dados SQL do Azure

Azure DevOps Services | Servidor Azure DevOps | Azure DevOps Server 2022 | Azure DevOps Server 2020

Você pode implantar automaticamente suas atualizações de banco de dados em um banco de dados SQL do Azure após cada build bem-sucedido.

Pré-requisitos

Produto	Requisitos
Azure DevOps	- Um projeto do Azure DevOps. - Permissões: – Para criar conexões de serviço, você deve ter a função Administrador ou a função 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 dados e alterações de esquema. Você pode criar um DACPAC usando o Projeto do Banco de Dados SQL no Visual Studio.

A tarefa de implantação do Banco de Dados SQL do Azure é o principal mecanismo para implantar um banco de dados no Azure. Essa tarefa, assim como acontece com outras tarefas internas do Azure, requer uma conexã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 é estar conectado como um usuário que detém 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, confira Criar uma conexão de serviço do Azure.

Para saber como criar uma conexão de serviço do Azure, confira Criar uma conexão de serviço do Azure.

YAML
Clássico

Para implantar um DACPAC em um banco de dados SQL do Azure, use a tarefa de implantação do Banco de Dados SQL do Azure. Adicione o seguinte snippet ao 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>'

Scripts de SQL

Como alternativa, você pode usar scripts SQL em vez de DACPAC para implantar seu banco de dados. Veja abaixo 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 do pipeline, você precisará 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 do PowerShell a seguir cria regras de firewall. Salve-o como SetAzureFirewallRule.ps1 e adicione-o ao repositório:

BRAÇO
ASM (Clássico)

[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

[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 do PowerShell a seguir remove as regras de firewall. Salve-o como RemoveAzureFirewallRule.ps1 e adicione-o ao repositório:

BRAÇO
ASM (Clássico)

[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

[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, em seguida, remover as regras de firewall:

YAML
Clássico

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
  displayName: 'Install SqlServer module if not present'
  inputs:
    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

Para pipelines clássicos, verifique se o script SQL para implantar o banco de dados e os scripts do Azure PowerShell para configurar regras de firewall estão incluídos como parte do artefato de build.

Para pipelines de versões clássicas, selecione Iniciar com um pipeline vazio, vincule os artefatos a partir do pipeline de build e adicione as seguintes tarefas:

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 SQL Server que você criou.

Use a tarefa do PowerShell para invocar o SQLCMD e executar 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)

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 somente builds específicos em seu banco de dados do Azure, oferecendo mais controle sobre quais alterações são aplicadas com base em critérios como o branch de origem ou o status de build.

YAML
Clássico

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 a seguir mostra como implantar somente builds do ramo 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>'

Mais ações do SQL

A tarefa implantação do SQL Azure Dacpac 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.

Observação

Se você executar o SQLPackage na pasta em que ele está instalado, deverá prefixar o caminho com & e encapsulá-lo entre 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:

Cria um arquivo (.dacpac) de instantâneo de um banco de dados do SQL Server dinâmico ou do Banco de Dados SQL do Microsoft Azure.

Sintaxe de comando:

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

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 /?

atualiza um esquema de banco de dados incrementalmente para que corresponda 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, será atualizado um banco de dados existente.

Sintaxe de 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 /?

exporta um banco de dados dinâmico – incluindo o esquema e os dados de usuário do banco de dados – do SQL Server ou do Banco de Dados SQL do Microsoft Azure para um pacote BACPAC (arquivo .bacpac).

Sintaxe de 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 /?

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

Sintaxe de 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 /?

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

Sintaxe de 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 /?

cria um relatório XML das alterações que teriam sido feitas a um banco de dados registrado desde o último registro.

Sintaxe de 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 /?

cria um script de atualização incremental Transact-SQL que atualiza o esquema de um destino para que corresponda ao esquema de origem.

Sintaxe de 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 /?

Comentários

Esta página foi útil?

Last updated on 2025-12-17

Compartilhar via

Tarefa de implantação do banco de dados SQL do Azure

Pré-requisitos

DACPAC

Scripts de SQL

Definir regras de firewall do Azure

Remover regras de firewall do Azure

Implantar banco de dados com scripts SQL

Implantar o banco de dados condicionalmente

Mais ações do SQL

Sintaxe básica

Conteúdo relacionado

Comentários

Recursos adicionais