Users/ajya/sql server module import m146 (#9360)

* Importing Sqlserver module

* updated task.json

Author: Ajay Kumar Yadav

Tasks/SqlAzureDacpacDeploymentV1/SqlAzureActions.ps1

@@ -270,10 +270,12 @@ function Run-SqlCmd {
       }
     }
     elseif ($authenticationType -eq "connectionString") {
+      Check-ConnectionString
       $commandToRun = "Invoke-Sqlcmd -connectionString `"$connectionString`" "
       $commandToLog = "Invoke-Sqlcmd -connectionString `"**********`" "
     }
     elseif ($authenticationType -eq "aadAuthenticationPassword" -or $authenticationType -eq "aadAuthenticationIntegrated") {
+      Check-connectionString
       $connectionString = Get-AADAuthenticationConnectionString -authenticationType $authenticationType -serverName $serverName -databaseName $databaseName -sqlUserName $sqlUserName -sqlPassword $sqlPassword
       $commandToRun = "Invoke-Sqlcmd -connectionString `"$connectionString`" "
       $commandToLog = "Invoke-Sqlcmd -connectionString `"$connectionString`" "
@@ -286,6 +288,14 @@ function Run-SqlCmd {
     Invoke-Expression $commandToRun
 }
 
+function Check-ConnectionString
+{
+   if(-not (CmdletHasMember -cmdlet Invoke-SQlCmd -memberName "connectionString"))
+   {
+     throw (Get-VstsLocString -Key "SAD_InvokeSQLCmdNotSupportingConnectionString")
+   }
+}
+
 function Get-AgentIPRange
 {
     param(

Tasks/SqlAzureDacpacDeploymentV1/Strings/resources.resjson/en-US/resources.resjson

@@ -76,5 +76,6 @@
   "loc.messages.SAD_DacpacFilePath": "DACPAC file path:",
   "loc.messages.SAD_BacpacFilePath": "BACPAC file path:",
   "loc.messages.SAD_PublishProfilePath": "Publish profile path:",
-  "loc.messages.SAD_DriftReportWarning": "While generating a Drift Report of the database, ensure that the database is registered as a Data-tier Application."
+  "loc.messages.SAD_DriftReportWarning": "While generating a Drift Report of the database, ensure that the database is registered as a Data-tier Application.",
+  "loc.messages.SAD_InvokeSQLCmdNotSupportingConnectionString": "Imported Invoke-Sqlcmd doesn't support connectionString. Install SQLServer PS module."
 }

Tasks/SqlAzureDacpacDeploymentV1/Utility.ps1

@@ -332,6 +332,33 @@ function EscapeSpecialChars
 # Function to import SqlPS module & avoid directory switch
 function Import-Sqlps {
     Push-Location
-    Import-Module SqlPS -ErrorAction 'SilentlyContinue' 3>&1 | Out-Null
+
+    $modules = Get-Module -Name SQLServer -ListAvailable
+    if ($modules)
+    {
+      Import-Module SQLServer -ErrorAction 'SilentlyContinue' 3>&1 | Out-Null
+      Write-Verbose "Imported SQLServer PS module."
+    } else {
+      Write-Verbose "SQLServer PS module is not installed. Importing SQLPS"
+      Import-Module SqlPS -ErrorAction 'SilentlyContinue' 3>&1 | Out-Null
+    }
+
     Pop-Location
 }
+
+function CmdletHasMember {
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory=$true)]
+        [string]$cmdlet,
+        [Parameter(Mandatory=$true)]
+        [string]$memberName)
+    try{
+        $hasMember = (gcm $cmdlet).Parameters.Keys.Contains($memberName)
+        return $hasMember
+    }
+    catch
+    {
+        return $false;
+    }
+}

Tasks/SqlAzureDacpacDeploymentV1/task.json

@@ -3,6 +3,7 @@
     "name": "SqlAzureDacpacDeployment",
     "friendlyName": "Azure SQL Database Deployment",
     "description": "Deploy Azure SQL DB using DACPAC or run scripts using SQLCMD",
+    "helpUrl": "https://aka.ms/sqlazuredeployreadme",
     "helpMarkDown": "[More Information](https://aka.ms/sqlazuredeployreadme)",
     "category": "Deploy",
     "visibility": [
@@ -16,7 +17,7 @@
     "version": {
         "Major": 1,
         "Minor": 3,
-        "Patch": 11
+        "Patch": 12
     },
     "demands": [
         "sqlpackage"
@@ -362,6 +363,7 @@
         "SAD_DacpacFilePath": "DACPAC file path:",
         "SAD_BacpacFilePath": "BACPAC file path:",
         "SAD_PublishProfilePath": "Publish profile path:",
-        "SAD_DriftReportWarning": "While generating a Drift Report of the database, ensure that the database is registered as a Data-tier Application."
+        "SAD_DriftReportWarning": "While generating a Drift Report of the database, ensure that the database is registered as a Data-tier Application.",
+        "SAD_InvokeSQLCmdNotSupportingConnectionString": "Imported Invoke-Sqlcmd doesn't support connectionString. Install SQLServer PS module."
     }
 }

Tasks/SqlAzureDacpacDeploymentV1/task.loc.json

@@ -3,6 +3,7 @@
   "name": "SqlAzureDacpacDeployment",
   "friendlyName": "ms-resource:loc.friendlyName",
   "description": "ms-resource:loc.description",
+  "helpUrl": "https://aka.ms/sqlazuredeployreadme",
   "helpMarkDown": "ms-resource:loc.helpMarkDown",
   "category": "Deploy",
   "visibility": [
@@ -16,7 +17,7 @@
   "version": {
     "Major": 1,
     "Minor": 3,
-    "Patch": 11
+    "Patch": 12
   },
   "demands": [
     "sqlpackage"
@@ -362,6 +363,7 @@
     "SAD_DacpacFilePath": "ms-resource:loc.messages.SAD_DacpacFilePath",
     "SAD_BacpacFilePath": "ms-resource:loc.messages.SAD_BacpacFilePath",
     "SAD_PublishProfilePath": "ms-resource:loc.messages.SAD_PublishProfilePath",
-    "SAD_DriftReportWarning": "ms-resource:loc.messages.SAD_DriftReportWarning"
+    "SAD_DriftReportWarning": "ms-resource:loc.messages.SAD_DriftReportWarning",
+    "SAD_InvokeSQLCmdNotSupportingConnectionString": "ms-resource:loc.messages.SAD_InvokeSQLCmdNotSupportingConnectionString"
   }
-}
+}