Implementação da base de dados SQL do Azure

Serviços de DevOps do Azure | 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.

Pacote DAC

A maneira mais simples de implantar um banco de dados é criar um pacote de camada de dados ou DACPAC. Os DACPACs podem ser usados para 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.

YAML

Para implantar um DACPAC em um banco de dados SQL do Azure, adicione o seguinte trecho ao seu arquivo azure-pipelines.yml.

- 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 para seu projeto de banco de dados do Visual Studio, use o modelo de área de trabalho .NET. Este modelo adiciona automaticamente as tarefas para criar o projeto e publicar artefatos, incluindo o DACPAC.

Ao configurar um pipeline de versão, escolha Iniciar com um pipeline vazio, vincule os artefatos da compilação e adicione uma tarefa de Implantação do Banco de Dados SQL do Azure.

Consulte também as informações de autenticação ao usar a tarefa de Implantação do Banco de Dados SQL do Azure.

Scripts SQL

Em vez de usar um DACPAC, você também pode usar scripts SQL para implantar seu banco de dados. Aqui está um exemplo simples de um script SQL 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 como parte de um pipeline, você precisará de scripts do Azure PowerShell para criar e remover regras de firewall no Azure. Sem as regras de firewall, o agente do Azure Pipelines não pode se comunicar com o Banco de Dados SQL do Azure.

O script PowerShell a seguir cria regras de firewall. Você pode fazer check-in deste script como SetAzureFirewallRule.ps1 em 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

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
}

O script PowerShell a seguir remove regras de firewall. Você pode fazer check-in deste script como RemoveAzureFirewallRule.ps1 em 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

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
}

YAML

Adicione o seguinte ao seu arquivo azure-pipelines.yml para executar um script SQL.

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: 'Azure PowerShell script'
  inputs:
    azureSubscription: '$(AzureSubscription)'
    ScriptType: filePath
    ScriptPath: '$(Build.SourcesDirectory)\scripts\SetAzureFirewallRule.ps1'
    ScriptArguments: '-ServerName $(ServerName) -ResourceGroupName $(ResourceGroupName)'
    azurePowerShellVersion: LatestVersion

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

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

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

Clássico

Ao configurar um pipeline de compilação, verifique se o script SQL para implantar o banco de dados e os scripts do Azure PowerShell para configurar regras de firewall fazem parte do artefato de compilação.

Ao configurar um pipeline de liberação, escolha Iniciar com um processo vazio, vincule os artefatos da compilação e use as seguintes tarefas:

1. Use a tarefa do Azure PowerShell para adicionar uma regra de firewall no Azure para permitir 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 SQLCMD e executar seus scripts. Adicione o seguinte script embutido à sua tarefa:

   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.

   

Conexão de serviço do Azure

A tarefa 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.

Implantando condicionalmente

Você pode optar por implantar apenas determinadas compilações em seu banco de dados do Azure.

YAML

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

• Isole as etapas de implantação em um trabalho separado e adicione uma condição a esse trabalho.
• Adicione uma condição à etapa.

O exemplo a seguir mostra como usar condições de etapa para implantar somente as compilações que se originam da ramificação principal.

- 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>'

Para saber mais sobre condições, consulte Especificar condições.

Clássico

Em seu pipeline de liberação, você pode implementar várias verificações e condições para controlar a implantação.

Nota

Em algumas configurações, talvez seja necessário permitir a lista do intervalo de endereços IP para a região específica que é atualizada no arquivo JSON semanal. Saiba mais sobre a rede de agentes hospedados pela Microsoft.

• Defina filtros de ramificação para configurar o gatilho de implantação contínua no artefato do pipeline de liberação.
• Defina as aprovações de pré-implantação como uma pré-condição para a implantação em um estágio.
• Configure portas como uma pré-condição para a implantação em um estágio.
• Especifique as condições para que uma tarefa seja executada.

Para obter mais informações, consulte Gatilhos de liberação, ramificação e estágio, Controle de implantação de liberação usando aprovações, Controle de implantação de liberação usando portas e Especificar condições para executar uma tarefa.

Mais ações SQL

A Implantação do Dacpac do SQL Azure pode não dar suporte a todas as ações do SQL Server que você deseja executar. Nesses casos, você pode simplesmente usar o PowerShell ou scripts de linha de comando para executar os comandos necessários. Esta seção mostra alguns dos casos de uso comuns para invocar a ferramenta SqlPackage.exe. Como pré-requisito para executar essa ferramenta, você deve usar um agente auto-hospedado e ter a ferramenta instalada em seu agente.

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, dependendo da ação que deseja executar:

Extrair

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

Exportar

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

Relatório de deriva

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