SqlAzureDacpacDeployment@1 - tâche déploiement de base de données Azure SQL v1

Utilisez cette tâche pour déployer une base de données Azure SQL à l’aide de DACPAC ou exécuter des scripts à l’aide de SQLCMD.

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.

Entrées

azureConnectionType - Type de connexion de service Azure
Alias d’entrée : ConnectedServiceNameSelector. string. Valeurs autorisées : ConnectedServiceName (Azure Classic), ConnectedServiceNameARM (Azure Resource Manager). Valeur par défaut : ConnectedServiceNameARM.

azureClassicSubscription - Abonnement Azure Classic
Alias d’entrée : ConnectedServiceName. string. Nécessaire lorsque ConnectedServiceNameSelector = ConnectedServiceName.

Spécifie l’abonnement Azure Classic cible pour le déploiement de fichiers SQL.

azureSubscription - Abonnement Azure
Alias d’entrée : ConnectedServiceNameARM. string. Nécessaire lorsque ConnectedServiceNameSelector = ConnectedServiceNameARM.

Spécifie l’abonnement Azure Resource Manager cible pour le déploiement de fichiers SQL.

AuthenticationType - Type d’authentification
string. Obligatoire. Valeurs autorisées : server (SQL Server Authentification), aadAuthenticationPassword (Active Directory - Mot de passe), aadAuthenticationIntegrated (Active Directory - Intégré), connectionString (Chaîne de connexion), servicePrincipal (Principal du service). Valeur par défaut : server.

Spécifie le type d’authentification de base de données. Il peut s’agir d’une SQL Server, d’Active Directory (intégré), d’Active Directory (mot de passe), d’chaîne de connexion ou d’une authentification de principal de service. L’authentification intégrée signifie que l’agent accède à la base de données à l’aide de son contexte de compte Active Directory actuel.

Spécifiez l’option permettant de se connecter à la base de données Azure SQL Server. Vous pouvez fournir les détails de la base de données du serveur Azure SQL, le SQL Server chaîne de connexion, l’authentification AD (mot de passe ou intégré) ou utiliser un principal de service. Pour l’authentification SQL Server, utilisez les informations d’identification utilisateur du SQL Server. Pour l’authentification AD, utilisez les informations d’identification de l’utilisateur AD configuré sur le SQL Server.

ServerName - serveur Azure SQL
string. Nécessaire lorsque AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal.

Spécifie le nom du serveur Azure SQL, par exemple Fabrikam.database.windows.net,1433 ou Fabrikam.database.windows.net.

DatabaseName - Base
string. Nécessaire lorsque AuthenticationType = server || AuthenticationType = aadAuthenticationPassword || AuthenticationType = aadAuthenticationIntegrated || AuthenticationType = servicePrincipal.

Spécifie le nom de la base de données Azure SQL dans laquelle les fichiers sont déployés.

SqlUsername - Connectez-vous
string. Nécessaire lorsque AuthenticationType = server.

Spécifie la connexion administrateur du serveur Azure SQL.

SqlPassword - Mot de passe
string. Nécessaire lorsque AuthenticationType = server.

Spécifie le mot de passe de l’administrateur du serveur Azure SQL. Les variables définies dans les pipelines de build ou de mise en production sont $(passwordVariable) acceptées. Vous pouvez marquer le type de variable comme secret pour le sécuriser.

aadSqlUsername - Connectez-vous
string. Nécessaire lorsque AuthenticationType = aadAuthenticationPassword.

Spécifie le nom d’utilisateur Active Directory.

aadSqlPassword - Mot de passe
string. Nécessaire lorsque AuthenticationType = aadAuthenticationPassword.

Spécifie le mot de passe de l’utilisateur Active Directory. Les variables définies dans les pipelines de build ou de mise en production sont $(passwordVariable) acceptées. Vous pouvez marquer le type de variable comme secret pour le sécuriser.

ConnectionString - Chaîne de connexion
string. Nécessaire lorsque AuthenticationType = connectionString.

Spécifie le chaîne de connexion de serveur Azure SQL, comme Server=testServer.database.windows.net;Database=testdb;User ID=AccountPlaceholder;Password=$(securePassword);.

deployType - Type de déploiement
Alias d’entrée : TaskNameSelector. string. Obligatoire. Valeurs autorisées : DacpacTask (fichier DACPAC SQL), SqlTask (fichier de script SQL), InlineSqlTask (script SQL inline). Valeur par défaut : DacpacTask.

DeploymentAction - Action
string. Nécessaire lorsque TaskNameSelector = DacpacTask. Valeurs autorisées : Publish, Extract, ImportExport, , Script( DriftReport Rapport de dérive), DeployReport (Déployer le rapport). Valeur par défaut : Publish.

Spécifie l’une des actions SQL de la liste. En savoir plus sur la liste d’actions SQL.

DacpacFile - Fichier DACPAC
string. Nécessaire lorsque DeploymentAction = Publish || DeploymentAction = Script || DeploymentAction = DeployReport.

Spécifie l’emplacement du fichier DACPAC sur l’agent Automation ou sur un chemin UNC accessible à l’agent Automation, comme \\BudgetIT\Web\Deploy\FabrikamDB.dacpac. Les variables système prédéfinies, telles que $(agent.releaseDirectory), peuvent également être utilisées.

BacpacFile - Fichier BACPAC
string. Nécessaire lorsque DeploymentAction = Import.

Spécifie l’emplacement du fichier BACPAC sur l’agent Automation ou sur un chemin UNC accessible à l’agent Automation, comme \\BudgetIT\Web\Deploy\FabrikamDB.bacpac. Les variables système prédéfinies, telles que $(agent.releaseDirectory), peuvent également être utilisées.

SqlFile - SQL Script
string. Nécessaire lorsque TaskNameSelector = SqlTask.

Spécifie l’emplacement du fichier de script SQL sur l’agent Automation ou sur un chemin UNC accessible à l’agent Automation, comme \\BudgetIT\Web\Deploy\FabrikamDB.sql. Les variables système prédéfinies, telles que $(agent.releaseDirectory), peuvent également être utilisées.

SqlInline - Inline SQL Script
string. Nécessaire lorsque TaskNameSelector = InlineSqlTask.

Spécifie le script SQL à exécuter sur la base de données sélectionnée précédemment.

PublishProfile - Publier un profil
string. facultatif. Utilisez quand TaskNameSelector = DacpacTask || DeploymentAction = Script || DeploymentAction = DeployReport.

Fournit un contrôle affiné sur Azure SQL création ou mise à niveau de base de données.
Spécifie le chemin d’accès au fichier XML de profil de publication sur l’ordinateur de l’agent Automation ou sur un partage UNC. Si le profil de publication contient des secrets, tels que des informations d’identification, chargez-le dans la bibliothèque de fichiers sécurisés où il est stocké de manière sécurisée avec chiffrement. Ensuite, utilisez la tâche Télécharger un fichier sécurisé au début de votre pipeline pour le télécharger sur l’ordinateur de l’agent lorsque le pipeline s’exécute. Supprimez-le une fois le pipeline terminé. Des variables système prédéfinies, telles que $(agent.buildDirectory) ou $(agent.releaseDirectory), peuvent également être utilisées.

AdditionalArguments - Arguments SqlPackage.exe supplémentaires
string. facultatif. Utilisez quand TaskNameSelector = DacpacTask || DeploymentAction = Extract || DeploymentAction = Export || DeploymentAction = Import || DeploymentAction = Script || DeploymentAction = DeployReport || DeploymentAction = DriftReport.

Spécifie les arguments supplémentaires SqlPackage.exe qui seront appliqués lors du déploiement de la base de données Azure SQL si l’option DACPAC est sélectionnée, comme /p:IgnoreAnsiNulls=True /p:IgnoreComments=True. Ces arguments remplacent les paramètres dans le fichier XML du profil de publication (le cas échéant).

SqlAdditionalArguments - Arguments Invoke-Sqlcmd supplémentaires
string. facultatif. Utilisez quand TaskNameSelector = SqlTask.

Spécifie les arguments Invoke-Sqlcmd supplémentaires appliqués lors de l’exécution de la requête SQL donnée sur la base de données Azure SQL, comme -ConnectionTimeout 100 -OutputSqlErrors.

InlineAdditionalArguments - Arguments Invoke-Sqlcmd supplémentaires
string. facultatif. Utilisez quand TaskNameSelector = InlineSqlTask.

Spécifie les arguments de Invoke-Sqlcmd supplémentaires qui sont appliqués lors de l’exécution de la requête SQL donnée sur la base de données Azure SQL, comme -ConnectionTimeout 100 -OutputSqlErrors.

IpDetectionMethod - Spécifier des règles de pare-feu à l’aide de
string. Obligatoire. Valeurs autorisées : AutoDetect, IPAddressRange. Valeur par défaut : AutoDetect.

Pour que la tâche s’exécute, l’adresse IP de l’agent Automation doit être ajoutée aux adresses IP autorisées dans le pare-feu du serveur Azure SQL. Sélectionnez Détection automatique pour ajouter automatiquement l’exception de pare-feu pour la plage de l’adresse IP possible de l’agent Automation, ou spécifiez explicitement la plage.

StartIpAddress - Adresse IP de démarrage
string. Nécessaire lorsque IpDetectionMethod = IPAddressRange.

Spécifie l’adresse IP de départ du pool de machines de l’agent Automation, comme 196.21.30.50.

EndIpAddress - Adresse IP de fin
string. Nécessaire lorsque IpDetectionMethod = IPAddressRange.

Spécifie l’adresse IP de fin du pool d’ordinateurs de l’agent Automation, comme 196.21.30.65.

DeleteFirewallRule - Supprimer une règle après la fin de la tâche
boolean. Valeur par défaut : true.

Si cette option est sélectionnée, une fois la tâche terminée, les adresses IP spécifiées ici sont supprimées de la liste Adresses IP autorisées dans le pare-feu du serveur Azure SQL.

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Cette tâche définit les variables de sortie suivantes, que vous pouvez utiliser dans les étapes, les travaux et les étapes en aval.

SqlDeploymentOutputFile
Chemin du fichier de sortie généré lorsque l’action du package de déploiement est Extract, Export, Script, DriftReportou DeployReport.

Remarques

Utilisez cette tâche pour déployer une base de données Azure SQL à l’aide d’un DACPAC ou exécuter des scripts à l’aide de SQLCMD.

Important

Cette tâche est uniquement prise en charge dans un environnement Windows. Si vous souhaitez utiliser l’authentification intégrée Azure Active Directory (Azure AD), vous devez créer un agent privé. L’authentification intégrée Azure AD n’est pas prise en charge par les agents hébergés.

Configuration requise

Condition requise	Description
Types de pipelines	YAML, build classique, version classique
S’exécute sur	Agent
Demandes	Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : sqlpackage
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes	Quelconque
Variables settables	Quelconque
Version de l’agent	1.103.0 ou supérieur
Catégorie de la tâche	Déployer