[AzureFileCopy] Pick up latest Azure PowerShell module on Hosted agent

Tasks/AzureCloudPowerShellDeploymentV1/task.json

@@ -17,7 +17,7 @@
     "version": {
         "Major": 1,
         "Minor": 167,
-        "Patch": 3
+        "Patch": 4
     },
     "demands": [
         "azureps"

Tasks/AzureCloudPowerShellDeploymentV1/task.loc.json

@@ -17,7 +17,7 @@
   "version": {
     "Major": 1,
     "Minor": 167,
-    "Patch": 3
+    "Patch": 4
   },
   "demands": [
     "azureps"

Tasks/AzureFileCopyV2/AzureFileCopy.ps1

@@ -65,6 +65,8 @@ Import-Module $PSScriptRoot\ps_modules\RemoteDeployer
 
 # Initialize Azure.
 Import-Module $PSScriptRoot\ps_modules\VstsAzureHelpers_
+$endpoint = Get-Endpoint -connectedServiceName $connectedServiceName
+Update-PSModulePathForHostedAgentWithLatestModule -Endpoint $endpoint
 Initialize-Azure
 
 # Import the loc strings.

Tasks/AzureFileCopyV2/task.json

@@ -14,7 +14,7 @@
     "version": {
         "Major": 2,
         "Minor": 167,
-        "Patch": 4
+        "Patch": 5
     },
     "demands": [
         "azureps"

Tasks/AzureFileCopyV2/task.loc.json

@@ -14,7 +14,7 @@
   "version": {
     "Major": 2,
     "Minor": 167,
-    "Patch": 4
+    "Patch": 5
   },
   "demands": [
     "azureps"

Tasks/AzureFileCopyV3/AzureFileCopy.ps1

@@ -68,6 +68,7 @@ if (Get-Module Az.Accounts -ListAvailable){
     Initialize-AzModule -Endpoint $endpoint
 }
 else{
+    Update-PSModulePathForHostedAgentWithLatestModule -Endpoint $endpoint
     Initialize-AzureRMModule -Endpoint $endpoint
 }
 

Tasks/AzureFileCopyV3/task.json

@@ -14,7 +14,7 @@
     "version": {
         "Major": 3,
         "Minor": 167,
-        "Patch": 4
+        "Patch": 5
     },
     "demands": [
         "azureps"

Tasks/AzureFileCopyV3/task.loc.json

@@ -14,7 +14,7 @@
   "version": {
     "Major": 3,
     "Minor": 167,
-    "Patch": 4
+    "Patch": 5
   },
   "demands": [
     "azureps"

Tasks/AzureFileCopyV4/task.json

@@ -14,7 +14,7 @@
     "version": {
         "Major": 4,
         "Minor": 170,
-        "Patch": 2
+        "Patch": 3
     },
     "demands": [
         "azureps"

Tasks/AzureFileCopyV4/task.loc.json

@@ -14,7 +14,7 @@
   "version": {
     "Major": 4,
     "Minor": 170,
-    "Patch": 2
+    "Patch": 3
   },
   "demands": [
     "azureps"

Tasks/AzurePowerShellV2/task.json

@@ -18,7 +18,7 @@
     "version": {
         "Major": 2,
         "Minor": 167,
-        "Patch": 3
+        "Patch": 4
     },
     "demands": [
         "azureps"

Tasks/AzurePowerShellV2/task.loc.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 2,
     "Minor": 167,
-    "Patch": 3
+    "Patch": 4
   },
   "demands": [
     "azureps"

Tasks/AzurePowerShellV3/task.json

@@ -18,7 +18,7 @@
     "version": {
         "Major": 3,
         "Minor": 167,
-        "Patch": 3
+        "Patch": 4
     },
     "releaseNotes": "Added support for Fail on standard error and ErrorActionPreference",
     "demands": [

Tasks/AzurePowerShellV3/task.loc.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 3,
     "Minor": 167,
-    "Patch": 3
+    "Patch": 4
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",
   "demands": [

Tasks/AzurePowerShellV4/task.json

@@ -18,7 +18,7 @@
     "version": {
         "Major": 4,
         "Minor": 168,
-        "Patch": 2
+        "Patch": 3
     },
     "releaseNotes": "Added support for Az Module and cross platform agents.",
     "groups": [

Tasks/AzurePowerShellV4/task.loc.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 4,
     "Minor": 168,
-    "Patch": 2
+    "Patch": 3
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",
   "groups": [

Tasks/AzurePowerShellV5/task.json

@@ -18,7 +18,7 @@
     "version": {
         "Major": 5,
         "Minor": 170,
-        "Patch": 1
+        "Patch": 2
     },
     "releaseNotes": "Added support for Az Module and cross platform agents.",
     "groups": [

Tasks/AzurePowerShellV5/task.loc.json

@@ -18,7 +18,7 @@
   "version": {
     "Major": 5,
     "Minor": 170,
-    "Patch": 1
+    "Patch": 2
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",
   "groups": [

Tasks/Common/VstsAzureHelpers_/PsModuleUtility.ps1

@@ -0,0 +1,91 @@
+function Update-PSModulePathForHostedAgentWithLatestModule
+{
+    [CmdletBinding()]
+    param(
+        [object] $Endpoint
+    )
+
+    Trace-VstsEnteringInvocation $MyInvocation
+    try
+    {
+        $authenticationScheme = $Endpoint.Auth.Scheme
+
+        if ($authenticationScheme -eq "ServicePrincipal" -or
+            $authenticationScheme -eq "ManagedServiceIdentity")
+        {
+            Write-Verbose "Updating PSModulePath with latest AzureRM module."
+            $latestAzureRmModulePath = Get-LatestAzureRmModulePath
+
+            if (![string]::IsNullOrEmpty($latestAzureRmModulePath))
+            {
+                $env:PSModulePath = "$latestAzureRmModulePath;$env:PSModulePath"
+            }
+            else
+            {
+                Write-Verbose "Latest AzureRM module path is null or empty."
+            }
+        }
+
+    } 
+    finally 
+    {
+        Write-Verbose "The updated value of the PSModulePath is: $($env:PSModulePath)"
+        Trace-VstsLeavingInvocation $MyInvocation
+    }
+}
+
+function Get-LatestAzureRmModulePath
+{
+    [CmdletBinding()]
+    param()
+
+    Trace-VstsEnteringInvocation $MyInvocation
+    $hostedAgentAzureModulesPath = Join-Path -Path $env:SystemDrive -ChildPath "modules"
+    $latestAzureRmModulePath = ""
+    try 
+    {
+        if ($(Test-Path $hostedAgentAzureModulesPath))
+        {
+            $regexToMatch = New-Object -TypeName System.Text.RegularExpressions.Regex -ArgumentList "^azurerm_[0-9]+\.[0-9]+\.[0-9]+$"
+            $regexToExtract = New-Object -TypeName System.Text.RegularExpressions.Regex -ArgumentList "[0-9]+\.[0-9]+\.[0-9]+$"
+            $maxVersion = [version] "0.0.0"
+
+            $moduleFolders = Get-ChildItem -Directory -Path $hostedAgentAzureModulesPath | Where-Object { $regexToMatch.IsMatch($_.Name) }
+
+            foreach ($moduleFolder in $moduleFolders) 
+            {
+                $moduleVersion = [version] $($regexToExtract.Match($moduleFolder.Name).Groups[0].Value)
+
+                if ($moduleVersion -gt $maxVersion) 
+                {
+                    $modulePath = [System.IO.Path]::Combine($moduleFolder.FullName,"AzureRM\$moduleVersion\AzureRM.psm1")
+
+                    if (Test-Path -LiteralPath $modulePath -PathType Leaf) 
+                    {
+                        $maxVersion = $moduleVersion
+                        $latestAzureRmModulePath = $moduleFolder.FullName
+                    } 
+                    else 
+                    {
+                        Write-Verbose "A folder matching the module folder pattern was found at $($moduleFolder.FullName) but didn't contain a valid module file"
+                    }
+                }
+            }
+        }   
+        else 
+        {
+            Write-Verbose "Hosted Agent Azure modules path '$hostedAgentAzureModulesPath' does not exist."
+        }
+
+        return $latestAzureRmModulePath
+    }
+    catch 
+    {
+        Write-Verbose "Get-LatestAzureRmModulePath: Exception: $($_.Exception.Message)"
+        $latestAzureRmModulePath = ""
+    }
+    finally
+    {
+        Trace-VstsLeavingInvocation $MyInvocation
+    }
+}

Tasks/Common/VstsAzureHelpers_/VstsAzureHelpers_.psm1

@@ -21,6 +21,7 @@ Add-Tls12InSession
 . $PSScriptRoot/ImportFunctions.ps1
 . $PSScriptRoot/InitializeAzureRMFunctions.ps1
 . $PSScriptRoot/InitializeAzModuleFunctions.ps1
+. $PSScriptRoot/PsModuleUtility.ps1
 
 # This is the only public function.
 function Initialize-Azure {
@@ -73,3 +74,5 @@ Export-ModuleMember -Function Remove-EndpointSecrets
 Export-ModuleMember -Function Initialize-AzureRMModule
 Export-ModuleMember -Function Initialize-AzModule
 Export-ModuleMember -Function Disconnect-AzureAndClearContext
+Export-ModuleMember -Function Update-PSModulePathForHostedAgentWithLatestModule
+

Tasks/SqlAzureDacpacDeploymentV1/task.json

@@ -17,7 +17,7 @@
     "version": {
         "Major": 1,
         "Minor": 167,
-        "Patch": 4
+        "Patch": 5
     },
     "demands": [
         "sqlpackage"

Tasks/SqlAzureDacpacDeploymentV1/task.loc.json

@@ -17,7 +17,7 @@
   "version": {
     "Major": 1,
     "Minor": 167,
-    "Patch": 4
+    "Patch": 5
   },
   "demands": [
     "sqlpackage"