Azure SQL-databasdistribution

Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019

Du kan automatiskt distribuera dina databasuppdateringar till Azure SQL-databasen efter varje lyckad version.

DACPAC

Det enklaste sättet att distribuera en databas är att skapa datanivåpaket eller DACPAC. DACPACs kan användas för att paketera och distribuera schemaändringar och data. Du kan skapa en DACPAC med hjälp av SQL-databasprojektet i Visual Studio.

YAML

Om du vill distribuera en DACPAC till en Azure SQL-databas lägger du till följande kodfragment i din azure-pipelines.yml-fil.

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

Klassisk

När du konfigurerar en byggpipeline för ditt Visual Studio-databasprojekt använder du .NET-skrivbordsmallen. Den här mallen lägger automatiskt till uppgifter för att skapa projektet och publicera artefakter, inklusive DACPAC.

När du konfigurerar en versionspipeline väljer du Starta med en tom pipeline, länkar artefakterna från bygget och lägger sedan till en Azure SQL Database-distributionsuppgift .

Se även autentiseringsinformation när du använder azure SQL Database-distributionsuppgiften.

SQL-skript

I stället för att använda en DACPAC kan du även använda SQL-skript för att distribuera databasen. Här är ett enkelt exempel på ett SQL-skript som skapar en tom databas.

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

Om du vill köra SQL-skript som en del av en pipeline behöver du Azure PowerShell-skript för att skapa och ta bort brandväggsregler i Azure. Utan brandväggsreglerna kan Azure Pipelines-agenten inte kommunicera med Azure SQL Database.

Följande PowerShell-skript skapar brandväggsregler. Du kan checka in det här skriptet på SetAzureFirewallRule.ps1 din lagringsplats.

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

Klassisk

[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
}

Följande PowerShell-skript tar bort brandväggsregler. Du kan checka in det här skriptet på RemoveAzureFirewallRule.ps1 din lagringsplats.

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

Klassisk

[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

Lägg till följande i din azure-pipelines.yml-fil för att köra ett SQL-skript.

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: CmdLine@2
  displayName: Run Sqlcmd
  inputs:
    filename: sqlcmd
    arguments: '-S $(ServerFqdn) -U $(AdminUser) -P $(AdminPassword) -d $(DatabaseName) -i $(SQLFile)'

- 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

Klassisk

När du konfigurerar en bygg-pipeline kontrollerar du att SQL-skriptet för att distribuera databasen och Azure PowerShell-skripten för att konfigurera brandväggsregler ingår i kompileringsartefakten.

När du konfigurerar en versionspipeline väljer du Starta med en tom process, länkar artefakterna från bygget och använder sedan följande uppgifter:

• Använd först en Azure PowerShell-uppgift för att lägga till en brandväggsregel i Azure så att Azure Pipelines-agenten kan ansluta till Azure SQL Database. Skriptet kräver ett argument – namnet på den SQL-server som du skapade.
• För det andra använder du en kommandoradsaktivitet för att köra SQL-skriptet med hjälp av SQLCMD-verktyget . Argumenten för det här verktyget är -S {database-server-name}.database.windows.net -U {username}@{database-server-name} -P {password} -d {database-name} -i {SQL file} till exempel när SQL-skriptet kommer från en artefaktkälla, {SQL-fil} kommer att vara av formuläret: $(System.DefaultWorkingDirectory)/contoso-repo/DatabaseExample.sql.
• För det tredje använder du en annan Azure PowerShell-uppgift för att ta bort brandväggsregeln i Azure.

Azure-tjänstanslutning

Azure SQL Database-distributionsuppgiften är den primära mekanismen för att distribuera en databas till Azure. Den här uppgiften, precis som med andra inbyggda Azure-uppgifter, kräver en Azure-tjänstanslutning som indata. Azure-tjänstanslutningen lagrar autentiseringsuppgifterna för att ansluta från Azure Pipelines till Azure.

Det enklaste sättet att komma igång med den här uppgiften är att loggas in som en användare som äger både Azure DevOps-organisationen och Azure-prenumerationen. I det här fallet behöver du inte skapa tjänstanslutningen manuellt. Om du vill lära dig hur du skapar en Azure-tjänstanslutning kan du läsa Skapa en Azure-tjänstanslutning.

Distribuera villkorligt

Du kan välja att endast distribuera vissa versioner till din Azure-databas.

YAML

Om du vill göra detta i YAML kan du använda någon av följande tekniker:

• Isolera distributionsstegen till ett separat jobb och lägg till ett villkor i jobbet.
• Lägg till ett villkor i steget.

I följande exempel visas hur du använder stegvillkor för att endast distribuera de byggen som kommer från huvudgrenen.

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

Mer information om villkor finns i Ange villkor.

Klassisk

I versionspipelinen kan du implementera olika kontroller och villkor för att styra distributionen.

Kommentar

I vissa installationer kan du behöva tillåtalistning av ip-adressintervallet för den specifika region som uppdateras i den veckovisa JSON-filen. Läs mer om nätverk av Microsoft-värdbaserade agenter.

• Ange grenfilter för att konfigurera utlösaren för kontinuerlig distribution på artefakten i versionspipelinen.
• Ange förhandsdistributionsgodkännanden som ett förhandsvillkor för distribution till en fas.
• Konfigurera grindar som ett förhandsvillkor för distribution till en fas.
• Ange villkor för en aktivitet som ska köras.

Mer information finns i Utlösare för version, gren och fas, Distributionskontroll för versionsdistribution med godkännanden, Versionsdistributionskontroll med grindar och Ange villkor för att köra en uppgift.

Fler SQL-åtgärder

SQL Azure Dacpac-distribution kanske inte stöder alla SQL Server-åtgärder som du vill utföra. I dessa fall kan du helt enkelt använda PowerShell- eller kommandoradsskript för att köra de kommandon du behöver. Det här avsnittet visar några vanliga användningsfall för att anropa verktyget SqlPackage.exe. Som en förutsättning för att köra det här verktyget måste du använda en lokalt installerad agent och ha verktyget installerat på din agent.

Kommentar

Om du kör SQLPackage från mappen där den är installerad måste du prefixa sökvägen med & och omsluta den med dubbla citattecken.

Grundläggande syntax

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

Du kan använda något av följande SQL-skript beroende på vilken åtgärd du vill utföra

Extrahera

Skapar en databasögonblicksbildfil (.dacpac) från en live SQL-server eller Microsoft Azure SQL Database.

Kommandosyntax:

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

eller

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

Exempel:

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

Hjälp:

sqlpackage.exe /Action:Extract /?

Publicera

Uppdaterar ett databasschema stegvis så att det matchar schemat för en .dacpac-källfil. Om databasen inte finns på servern skapar publiceringsåtgärden den. Annars uppdateras en befintlig databas.

Kommandosyntax:

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

Exempel:

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

Hjälp:

sqlpackage.exe /Action:Publish /?

Export

Exporterar en livedatabas, inklusive databasschema och användardata, från SQL Server eller Microsoft Azure SQL Database till ett BACPAC-paket (.bacpac-fil).

Kommandosyntax:

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

Exempel:

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

Hjälp:

sqlpackage.exe /Action:Export /?

Importera

Importerar schema- och tabelldata från ett BACPAC-paket till en ny användardatabas i en instans av SQL Server eller Microsoft Azure SQL Database.

Kommandosyntax:

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

Exempel:

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

Hjälp:

sqlpackage.exe /Action:Import /?

DeployReport

Skapar en XML-rapport över de ändringar som skulle göras av en publiceringsåtgärd.

Kommandosyntax:

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

Exempel:

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" 

Hjälp:

sqlpackage.exe /Action:DeployReport /?

DriftReport

Skapar en XML-rapport över de ändringar som har gjorts i en registrerad databas sedan den senast registrerades.

Kommandosyntax:

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

Exempel:

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

Hjälp:

sqlpackage.exe /Action:DriftReport /?

Skript

Skapar ett transact-SQL-inkrementellt uppdateringsskript som uppdaterar schemat för ett mål så att det matchar schemat för en källa.

Kommandosyntax:

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

Exempel:

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"

Hjälp:

sqlpackage.exe /Action:Script /?