SqlAzureDacpacDeployment@1 – Azure SQL-Datenbankbereitstellung v1-Aufgabe
Verwenden Sie diese Aufgabe, um eine Azure SQL-Datenbank mit DACPAC bereitzustellen oder Skripts mit SQLCMD auszuführen.
Syntax
# Azure SQL Database deployment v1
# Deploy an Azure SQL Database using DACPAC or run scripts using SQLCMD.
- task: SqlAzureDacpacDeployment@1
inputs:
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Service Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. Azure Subscription.
# SQL Database
AuthenticationType: 'server' # 'server' | 'aadAuthenticationPassword' | 'aadAuthenticationIntegrated' | 'connectionString' | 'servicePrincipal'. Required. Authentication Type. Default: server.
#ServerName: # string. Required when AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal. Azure SQL Server.
#DatabaseName: # string. Required when AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal. Database.
SqlUsername: # string. Required when AuthenticationType = server. Login.
SqlPassword: # string. Required when AuthenticationType = server. Password.
#aadSqlUsername: # string. Required when AuthenticationType = aadAuthenticationPassword. Login.
#aadSqlPassword: # string. Required when AuthenticationType = aadAuthenticationPassword. Password.
#ConnectionString: # string. Required when AuthenticationType = connectionString. Connection String.
# Deployment Package
deployType: 'DacpacTask' # 'DacpacTask' | 'SqlTask' | 'InlineSqlTask'. Alias: TaskNameSelector. Required. Deploy type. Default: DacpacTask.
DeploymentAction: 'Publish' # 'Publish' | 'Extract' | 'Export' | 'Import' | 'Script' | 'DriftReport' | 'DeployReport'. Required when TaskNameSelector = DacpacTask. Action. Default: Publish.
#DacpacFile: # string. Required when DeploymentAction = Publish || DeploymentAction = Script || DeploymentAction = DeployReport. DACPAC File.
#BacpacFile: # string. Required when DeploymentAction = Import. BACPAC File.
#SqlFile: # string. Required when TaskNameSelector = SqlTask. SQL Script.
#SqlInline: # string. Required when TaskNameSelector = InlineSqlTask. Inline SQL Script.
#PublishProfile: # string. Optional. Use when TaskNameSelector = DacpacTask || DeploymentAction = Script || DeploymentAction = DeployReport. Publish Profile.
#AdditionalArguments: # string. Optional. Use when TaskNameSelector = DacpacTask || DeploymentAction = Extract || DeploymentAction = Export || DeploymentAction = Import || DeploymentAction = Script || DeploymentAction = DeployReport || DeploymentAction = DriftReport. Additional SqlPackage.exe Arguments.
#SqlAdditionalArguments: # string. Optional. Use when TaskNameSelector = SqlTask. Additional Invoke-Sqlcmd Arguments.
#InlineAdditionalArguments: # string. Optional. Use when TaskNameSelector = InlineSqlTask. Additional Invoke-Sqlcmd Arguments.
# Firewall
IpDetectionMethod: 'AutoDetect' # 'AutoDetect' | 'IPAddressRange'. Required. Specify Firewall Rules Using. Default: AutoDetect.
#StartIpAddress: # string. Required when IpDetectionMethod = IPAddressRange. Start IP Address.
#EndIpAddress: # string. Required when IpDetectionMethod = IPAddressRange. End IP Address.
#DeleteFirewallRule: true # boolean. Delete Rule After Task Ends. Default: true.
# Azure SQL Database deployment v1
# Deploy an Azure SQL Database using DACPAC or run scripts using SQLCMD.
- task: SqlAzureDacpacDeployment@1
inputs:
#azureConnectionType: 'ConnectedServiceNameARM' # 'ConnectedServiceName' | 'ConnectedServiceNameARM'. Alias: ConnectedServiceNameSelector. Azure Service Connection Type. Default: ConnectedServiceNameARM.
#azureClassicSubscription: # string. Alias: ConnectedServiceName. Required when ConnectedServiceNameSelector = ConnectedServiceName. Azure Classic Subscription.
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required when ConnectedServiceNameSelector = ConnectedServiceNameARM. Azure Subscription.
# SQL Database
AuthenticationType: 'server' # 'server' | 'aadAuthenticationPassword' | 'aadAuthenticationIntegrated' | 'connectionString'. Required. Authentication Type. Default: server.
#ServerName: # string. Required when AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated. Azure SQL Server.
#DatabaseName: # string. Required when AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated. Database.
SqlUsername: # string. Required when AuthenticationType = server. Login.
SqlPassword: # string. Required when AuthenticationType = server. Password.
#aadSqlUsername: # string. Required when AuthenticationType = aadAuthenticationPassword. Login.
#aadSqlPassword: # string. Required when AuthenticationType = aadAuthenticationPassword. Password.
#ConnectionString: # string. Required when AuthenticationType = connectionString. Connection String.
# Deployment Package
deployType: 'DacpacTask' # 'DacpacTask' | 'SqlTask' | 'InlineSqlTask'. Alias: TaskNameSelector. Required. Deploy type. Default: DacpacTask.
DeploymentAction: 'Publish' # 'Publish' | 'Extract' | 'Export' | 'Import' | 'Script' | 'DriftReport' | 'DeployReport'. Required when TaskNameSelector = DacpacTask. Action. Default: Publish.
#DacpacFile: # string. Required when DeploymentAction = Publish || DeploymentAction = Script || DeploymentAction = DeployReport. DACPAC File.
#BacpacFile: # string. Required when DeploymentAction = Import. BACPAC File.
#SqlFile: # string. Required when TaskNameSelector = SqlTask. SQL Script.
#SqlInline: # string. Required when TaskNameSelector = InlineSqlTask. Inline SQL Script.
#PublishProfile: # string. Optional. Use when TaskNameSelector = DacpacTask || DeploymentAction = Script || DeploymentAction = DeployReport. Publish Profile.
#AdditionalArguments: # string. Optional. Use when TaskNameSelector = DacpacTask || DeploymentAction = Extract || DeploymentAction = Export || DeploymentAction = Import || DeploymentAction = Script || DeploymentAction = DeployReport || DeploymentAction = DriftReport. Additional SqlPackage.exe Arguments.
#SqlAdditionalArguments: # string. Optional. Use when TaskNameSelector = SqlTask. Additional Invoke-Sqlcmd Arguments.
#InlineAdditionalArguments: # string. Optional. Use when TaskNameSelector = InlineSqlTask. Additional Invoke-Sqlcmd Arguments.
# Firewall
IpDetectionMethod: 'AutoDetect' # 'AutoDetect' | 'IPAddressRange'. Required. Specify Firewall Rules Using. Default: AutoDetect.
#StartIpAddress: # string. Required when IpDetectionMethod = IPAddressRange. Start IP Address.
#EndIpAddress: # string. Required when IpDetectionMethod = IPAddressRange. End IP Address.
#DeleteFirewallRule: true # boolean. Delete Rule After Task Ends. Default: true.
Eingänge
azureConnectionType
-
Azure Service Connection Type
Eingabealias: ConnectedServiceNameSelector
.
string
. Zulässige Werte: ConnectedServiceName
(Azure Classic), ConnectedServiceNameARM
(Azure Resource Manager). Standardwert: ConnectedServiceNameARM
.
azureClassicSubscription
-
azure Classic-Abonnement
Eingabealias: ConnectedServiceName
.
string
. Erforderlich, wenn ConnectedServiceNameSelector = ConnectedServiceName
.
Gibt das klassische Azure-Zielabonnement für die Bereitstellung von SQL-Dateien an.
azureSubscription
-
Azure-Abonnement-
Eingabealias: ConnectedServiceNameARM
.
string
. Erforderlich, wenn ConnectedServiceNameSelector = ConnectedServiceNameARM
.
Gibt das Azure Resource Manager-Zielabonnement für die Bereitstellung von SQL-Dateien an.
AuthenticationType
-
Authentifizierungstyp
string
. Erforderlich. Zulässige Werte: server
(SQL Server-Authentifizierung), aadAuthenticationPassword
(Active Directory - Kennwort), aadAuthenticationIntegrated
(Active Directory - Integriert), connectionString
(Verbindungszeichenfolge), servicePrincipal
(Dienstprinzipal). Standardwert: server
.
Gibt den Datenbankauthentifizierungstyp an. Dabei kann es sich um eine SQL Server-, Active Directory-, Active Directory-(Kennwort-), Verbindungszeichenfolge oder Dienstprinzipalauthentifizierung handelt. Bei der integrierten Authentifizierung greift der Agent unter Verwendung des aktuellen Active Directory-Kontokontexts auf die Datenbank zu.
Geben Sie die Option zum Herstellen einer Verbindung mit der Azure SQL Server-Datenbank an. Sie können die Azure SQL Server-Datenbankdetails, die SQL Server-Verbindungszeichenfolge, die AD-Authentifizierung (Kennwort oder integriert) bereitstellen oder einen Dienstprinzipal verwenden. Verwenden Sie für die SQL Server-Authentifizierung die Benutzeranmeldeinformationen von SQL Server. Verwenden Sie für die AD-Authentifizierung die Anmeldeinformationen für den AD-Benutzer, der für den SQL Server konfiguriert ist.
AuthenticationType
-
Authentifizierungstyp
string
. Erforderlich. Zulässige Werte: server
(SQL Server-Authentifizierung), aadAuthenticationPassword
(Active Directory - Kennwort), aadAuthenticationIntegrated
(Active Directory - Integriert), connectionString
(Verbindungszeichenfolge). Standardwert: server
.
Gibt den Datenbankauthentifizierungstyp an. Dabei kann es sich um eine SQL Server-, Active Directory-, Active Directory-(Kennwort-), Verbindungszeichenfolge oder Dienstprinzipalauthentifizierung handelt. Bei der integrierten Authentifizierung greift der Agent unter Verwendung des aktuellen Active Directory-Kontokontexts auf die Datenbank zu.
Geben Sie die Option zum Herstellen einer Verbindung mit der Azure SQL Server-Datenbank an. Sie können die Azure SQL Server-Datenbankdetails, die SQL Server-Verbindungszeichenfolge, die AD-Authentifizierung (Kennwort oder integriert) bereitstellen oder einen Dienstprinzipal verwenden. Verwenden Sie für die SQL Server-Authentifizierung die Benutzeranmeldeinformationen von SQL Server. Verwenden Sie für die AD-Authentifizierung die Anmeldeinformationen für den AD-Benutzer, der für den SQL Server konfiguriert ist.
ServerName
-
Azure SQL Server-
string
. Erforderlich, wenn AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal
.
Gibt den Azure SQL Server-Namen an, z. B. Fabrikam.database.windows.net.placeholder,1433
oder Fabrikam.database.windows.net.placeholder
.
ServerName
-
Azure SQL Server-
string
. Erforderlich, wenn AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated
.
Gibt den Azure SQL Server-Namen an, z. B. Fabrikam.database.windows.net.placeholder,1433
oder Fabrikam.database.windows.net.placeholder
.
DatabaseName
-
Datenbank-
string
. Erforderlich, wenn AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal
.
Gibt den Namen der Azure SQL-Datenbank an, in der die Dateien bereitgestellt werden.
DatabaseName
-
Datenbank-
string
. Erforderlich, wenn AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated
.
Gibt den Namen der Azure SQL-Datenbank an, in der die Dateien bereitgestellt werden.
SqlUsername
-
anmelden
string
. Erforderlich, wenn AuthenticationType = server
.
Gibt die Azure SQL Server-Administratoranmeldung an.
SqlPassword
-
Kennwort
string
. Erforderlich, wenn AuthenticationType = server
.
Gibt das Kennwort für den Azure SQL Server-Administrator an. Variablen, die in den Build- oder Releasepipelines als $(passwordVariable)
definiert sind, werden akzeptiert. Sie können den Variablentyp als secret
markieren, um ihn zu sichern.
aadSqlUsername
-
anmelden
string
. Erforderlich, wenn AuthenticationType = aadAuthenticationPassword
.
Gibt den Active Directory-Benutzernamen an.
aadSqlPassword
-
Kennwort
string
. Erforderlich, wenn AuthenticationType = aadAuthenticationPassword
.
Gibt das Kennwort für den Active Directory-Benutzer an. Variablen, die in den Build- oder Releasepipelines als $(passwordVariable)
definiert sind, werden akzeptiert. Sie können den Variablentyp als secret
markieren, um ihn zu sichern.
ConnectionString
-
Verbindungszeichenfolge
string
. Erforderlich, wenn AuthenticationType = connectionString
.
Gibt die Azure SQL Server-Verbindungszeichenfolge an, z. B. Server=testServer.database.windows.net.placeholder;Database=testdb;User ID=AccountPlaceholder;Password=$(securePassword);
.
deployType
-
Bereitstellen des Typs
Eingabealias: TaskNameSelector
.
string
. Erforderlich. Zulässige Werte: DacpacTask
(SQL DACPAC-Datei), SqlTask
(SQL-Skriptdatei), InlineSqlTask
(Inline-SQL-Skript). Standardwert: DacpacTask
.
DeploymentAction
-
Aktion
string
. Erforderlich, wenn TaskNameSelector = DacpacTask
. Zulässige Werte: Publish
, Extract
, Export
, Import
, Script
, DriftReport
(Drift Report), DeployReport
(Deploy Report). Standardwert: Publish
.
Gibt eine der SQL-Aktionen aus der Liste an. Erfahren Sie mehr über die SQL-Aktionsliste.
DacpacFile
-
DACPAC-Datei
string
. Erforderlich, wenn DeploymentAction = Publish || DeploymentAction = Script || DeploymentAction = DeployReport
.
Gibt den Speicherort der DACPAC-Datei im Automatisierungs-Agent oder auf einem UNC-Pfad an, auf den der Automatisierungs-Agent zugreifen kann, z. B. \\BudgetIT\Web\Deploy\FabrikamDB.dacpac
. Vordefinierte Systemvariablen wie $(agent.releaseDirectory)
können ebenfalls verwendet werden.
BacpacFile
-
BACPAC-Datei
string
. Erforderlich, wenn DeploymentAction = Import
.
Gibt den Speicherort der BACPAC-Datei im Automatisierungs-Agent oder auf einem UNC-Pfad an, auf den der Automatisierungs-Agent zugreifen kann, z. B. \\BudgetIT\Web\Deploy\FabrikamDB.bacpac
. Vordefinierte Systemvariablen wie $(agent.releaseDirectory)
können ebenfalls verwendet werden.
SqlFile
-
SQL-Skript-
string
. Erforderlich, wenn TaskNameSelector = SqlTask
.
Gibt den Speicherort der SQL-Skriptdatei im Automatisierungs-Agent oder auf einem UNC-Pfad an, auf den der Automatisierungs-Agent zugreifen kann, z. B. \\BudgetIT\Web\Deploy\FabrikamDB.sql
. Vordefinierte Systemvariablen wie $(agent.releaseDirectory)
können ebenfalls verwendet werden.
SqlInline
-
Inline-SQL-Skript-
string
. Erforderlich, wenn TaskNameSelector = InlineSqlTask
.
Gibt das SQL-Skript an, das für die zuvor ausgewählte Datenbank ausgeführt werden soll.
PublishProfile
-
Profil veröffentlichen
string
. Wahlfrei. Wird verwendet, wenn TaskNameSelector = DacpacTask || DeploymentAction = Script || DeploymentAction = DeployReport
.
Bietet eine differenzierte Kontrolle über die Erstellung oder Upgrades der Azure SQL-Datenbank.
Gibt den Pfad zur Veröffentlichungsprofil-XML-Datei auf dem Automatisierungs-Agent-Computer oder auf einer UNC-Freigabe an. Wenn das Veröffentlichungsprofil geheime Schlüssel wie Anmeldeinformationen enthält, laden Sie es in die sicheren Dateien Bibliothek hoch, in der es sicher mit Verschlüsselung gespeichert ist. Verwenden Sie als Nächstes die Aufgabe "Sichere Datei herunterladen" Aufgabe zu Beginn der Pipeline, um sie beim Ausführen der Pipeline auf den Agentcomputer herunterzuladen. Löschen Sie sie, wenn die Pipeline abgeschlossen ist. Vordefinierte Systemvariablen wie $(agent.buildDirectory)
oder $(agent.releaseDirectory)
können ebenfalls verwendet werden.
AdditionalArguments
-
Zusätzliche SqlPackage.exe Argumente
string
. Wahlfrei. Wird verwendet, wenn TaskNameSelector = DacpacTask || DeploymentAction = Extract || DeploymentAction = Export || DeploymentAction = Import || DeploymentAction = Script || DeploymentAction = DeployReport || DeploymentAction = DriftReport
.
Gibt die zusätzlichen SqlPackage.exe
Argumente an, die beim Bereitstellen der Azure SQL-Datenbank angewendet werden, wenn die Option DACPAC ausgewählt ist, z. B. /p:IgnoreAnsiNulls=True /p:IgnoreComments=True
. Diese Argumente überschreiben die Einstellungen in der XML-Datei zum Veröffentlichen von Profilen (sofern angegeben).
SqlAdditionalArguments
-
Zusätzliche Invoke-Sqlcmd Argumente
string
. Wahlfrei. Wird verwendet, wenn TaskNameSelector = SqlTask
.
Gibt die zusätzlichen Invoke-Sqlcmd Argumente an, die beim Ausführen der angegebenen SQL-Abfrage in der Azure SQL-Datenbank wie -ConnectionTimeout 100 -OutputSqlErrors
angewendet werden.
InlineAdditionalArguments
-
Zusätzliche Invoke-Sqlcmd Argumente
string
. Wahlfrei. Wird verwendet, wenn TaskNameSelector = InlineSqlTask
.
Gibt die zusätzlichen Invoke-Sqlcmd Argumente an, die beim Ausführen der angegebenen SQL-Abfrage in der Azure SQL-Datenbank wie -ConnectionTimeout 100 -OutputSqlErrors
angewendet werden.
IpDetectionMethod
-
Firewallregeln mithilfe von angeben
string
. Erforderlich. Zulässige Werte: AutoDetect
, IPAddressRange
. Standardwert: AutoDetect
.
Damit die Aufgabe ausgeführt werden kann, muss die IP-Adresse des Automatisierungs-Agents der zulässigen IP-Adressen in der Firewall von Azure SQL Server hinzugefügt werden. Wählen Sie die automatische Erkennung aus, um die Firewallausnahme für den Bereich der möglichen IP-Adresse des Automatisierungs-Agents automatisch hinzuzufügen, oder geben Sie den Bereich explizit an.
StartIpAddress
-
START-IP-Adresse
string
. Erforderlich, wenn IpDetectionMethod = IPAddressRange
.
Gibt die Start-IP-Adresse des Automatisierungs-Agent-Computerpools an, z. B. 196.21.30.50
.
EndIpAddress
-
End-IP-Adresse
string
. Erforderlich, wenn IpDetectionMethod = IPAddressRange
.
Gibt die endende IP-Adresse des Automatisierungs-Agent-Computerpools an, z. B. 196.21.30.65
.
DeleteFirewallRule
-
Regel löschen, nachdem der Vorgang beendet
boolean
. Standardwert: true
.
Wenn diese Option ausgewählt ist, werden die hier angegebenen IP-Adressen aus der Liste zulässigen IP-Adressen in der Firewall von Azure SQL Server gelöscht.
Aufgabensteuerungsoptionen
Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.
Ausgabevariablen
Mit dieser Aufgabe werden die folgenden Ausgabevariablendefiniert, die Sie in nachgeschalteten Schritten, Aufträgen und Phasen verwenden können.
SqlDeploymentOutputFile
Der generierte Ausgabedateipfad, wenn die Bereitstellungspaketaktion Extract
, Export
, Script
, DriftReport
oder DeployReport
.
Bemerkungen
Verwenden Sie diese Aufgabe, um eine Azure SQL-Datenbank mithilfe eines DACPAC bereitzustellen oder Skripts mit SQLCMD auszuführen.
Wichtig
Diese Aufgabe wird nur in einer Windows-Umgebung unterstützt. Wenn Sie versuchen, die integrierte Azure Active Directory (Azure AD)-Authentifizierung zu verwenden, müssen Sie einen privaten Agent erstellen. Die integrierte Azure AD-Authentifizierung wird für gehostete Agents nicht unterstützt.
Anforderungen
Anforderung | BESCHREIBUNG |
---|---|
Pipelinetypen | YAML, Classic Build, Classic Release |
Läuft auf | Agent |
Anforderungen | Self-hosted agents must have capabilities that match the following anforderungen to run jobs that use this task: sqlpackage |
Funktionen | Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag. |
Befehlseinschränkungen | Jegliche |
Settable-Variablen | Jegliche |
Agentversion | 1.103.0 oder höher |
Vorgangskategorie | Einsetzen |