Merge pull request #9145 from Microsoft/users/raagra/azure-powershell-logout-m143

Rajat Agrawal · web-flow · commit 8d3cf6a7f9c7 · 2018-12-22T14:17:02.000+05:30
Logging out from Azure in powershell based tasks
diff --git a/Tasks/AzureCloudPowerShellDeploymentV1/Publish-AzureCloudDeployment.ps1 b/Tasks/AzureCloudPowerShellDeploymentV1/Publish-AzureCloudDeployment.ps1
@@ -176,6 +176,7 @@ try{
         Validate-AzureCloudServiceStatus -CloudServiceName $ServiceName -Slot $Slot
     }
 } finally {
+    Disconnect-AzureAndClearContext
 	Trace-VstsLeavingInvocation $MyInvocation
 }
 
diff --git a/Tasks/AzureCloudPowerShellDeploymentV1/task.json b/Tasks/AzureCloudPowerShellDeploymentV1/task.json
@@ -16,7 +16,7 @@
     "version": {
         "Major": 1,
         "Minor": 3,
-        "Patch": 11
+        "Patch": 12
     },
     "demands": [
         "azureps"
diff --git a/Tasks/AzureCloudPowerShellDeploymentV1/task.loc.json b/Tasks/AzureCloudPowerShellDeploymentV1/task.loc.json
@@ -16,7 +16,7 @@
   "version": {
     "Major": 1,
     "Minor": 3,
-    "Patch": 10
+    "Patch": 12
   },
   "demands": [
     "azureps"
diff --git a/Tasks/AzureFileCopyV1/AzureFileCopy.ps1 b/Tasks/AzureFileCopyV1/AzureFileCopy.ps1
@@ -197,6 +197,7 @@ finally
 {
     Remove-AzureContainer -containerName $containerName -storageContext $storageContext
     Remove-EndpointSecrets
+    Disconnect-AzureAndClearContext
     Write-Verbose "Completed Azure File Copy Task for Azure VMs Destination" -Verbose
     Trace-VstsLeavingInvocation $MyInvocation
 }
diff --git a/Tasks/AzureFileCopyV1/task.json b/Tasks/AzureFileCopyV1/task.json
@@ -13,7 +13,7 @@
     "version": {
         "Major": 1,
         "Minor": 0,
-        "Patch": 144
+        "Patch": 145
     },
     "demands": [
         "azureps"
diff --git a/Tasks/AzureFileCopyV1/task.loc.json b/Tasks/AzureFileCopyV1/task.loc.json
@@ -13,7 +13,7 @@
   "version": {
     "Major": 1,
     "Minor": 0,
-    "Patch": 143
+    "Patch": 145
   },
   "demands": [
     "azureps"
diff --git a/Tasks/AzureFileCopyV2/AzureFileCopy.ps1 b/Tasks/AzureFileCopyV2/AzureFileCopy.ps1
@@ -249,6 +249,7 @@ finally
 {
     Remove-AzureContainer -containerName $containerName -storageContext $storageContext
     Remove-EndpointSecrets
+    Disconnect-AzureAndClearContext
     Write-Verbose "Completed Azure File Copy Task for Azure VMs Destination" -Verbose
     Trace-VstsLeavingInvocation $MyInvocation
 }
diff --git a/Tasks/AzureFileCopyV2/task.json b/Tasks/AzureFileCopyV2/task.json
@@ -13,7 +13,7 @@
     "version": {
         "Major": 2,
         "Minor": 0,
-        "Patch": 15
+        "Patch": 16
     },
     "preview": true,
     "demands": [
diff --git a/Tasks/AzureFileCopyV2/task.loc.json b/Tasks/AzureFileCopyV2/task.loc.json
@@ -13,7 +13,7 @@
   "version": {
     "Major": 2,
     "Minor": 0,
-    "Patch": 14
+    "Patch": 16
   },
   "preview": true,
   "demands": [
diff --git a/Tasks/AzurePowerShellV2/AzurePowerShell.ps1 b/Tasks/AzurePowerShellV2/AzurePowerShell.ps1
@@ -139,4 +139,6 @@ finally {
     if ($__vstsAzPSInlineScriptPath -and (Test-Path -LiteralPath $__vstsAzPSInlineScriptPath) ) {
         Remove-Item -LiteralPath $__vstsAzPSInlineScriptPath -ErrorAction 'SilentlyContinue'
     }
+
+    Disconnect-AzureAndClearContext
 }
diff --git a/Tasks/AzurePowerShellV2/Tests/DoesNotUnravelOutput.ps1 b/Tasks/AzurePowerShellV2/Tests/DoesNotUnravelOutput.ps1
@@ -9,6 +9,7 @@ Register-Mock Get-VstsInput { "$PSScriptRoot/DoesNotUnravelOutput_TargetScript.p
 Register-Mock Get-VstsInput { $targetAzurePs } -- -Name TargetAzurePs
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV2/Tests/PerformsBasicFlow.ps1 b/Tasks/AzurePowerShellV2/Tests/PerformsBasicFlow.ps1
@@ -11,6 +11,7 @@ Register-Mock Get-VstsInput { 'arg1 arg2' } -- -Name ScriptArguments
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Get-VstsEndpoint { @{auth = @{ scheme = "ServicePrincipal" }} }
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = & $PSScriptRoot\..\AzurePowerShell.ps1
diff --git a/Tasks/AzurePowerShellV2/Tests/RedirectsErrors.ps1 b/Tasks/AzurePowerShellV2/Tests/RedirectsErrors.ps1
@@ -9,6 +9,7 @@ Register-Mock Get-VstsInput { "$PSScriptRoot/RedirectsErrors_TargetScript.ps1" }
 Register-Mock Get-VstsInput { $targetAzurePs } -- -Name TargetAzurePs
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV2/Tests/RemovesFunctionsAndVariables.ps1 b/Tasks/AzurePowerShellV2/Tests/RemovesFunctionsAndVariables.ps1
@@ -10,6 +10,7 @@ Register-Mock Get-VstsInput { "FilePath" } -- -Name ScriptType -Require
 Register-Mock Get-VstsInput { "$PSScriptRoot/RemovesFunctionsAndVariables_TargetScript.ps1" } -- -Name ScriptPath
 Register-Mock Get-VstsInput { $targetAzurePs } -- -Name TargetAzurePs
 Register-Mock Update-PSModulePathForHostedAgent
+Register-Mock Disconnect-AzureAndClearContext
 
 # Arrange the mock task SDK module.
 New-Module -Name VstsTaskSdk -ScriptBlock {
diff --git a/Tasks/AzurePowerShellV2/Tests/ValidateInlineScriptFlow.ps1 b/Tasks/AzurePowerShellV2/Tests/ValidateInlineScriptFlow.ps1
@@ -10,6 +10,7 @@ Register-Mock Get-VstsInput { ",@( 'item 1', 'item 2')" } -- -Name Inline
 Register-Mock Get-VstsInput { $targetAzurePs } -- -Name TargetAzurePs
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV2/task.json b/Tasks/AzurePowerShellV2/task.json
@@ -17,7 +17,7 @@
     "version": {
         "Major": 2,
         "Minor": 1,
-        "Patch": 2
+        "Patch": 3
     },
     "demands": [
         "azureps"
diff --git a/Tasks/AzurePowerShellV2/task.loc.json b/Tasks/AzurePowerShellV2/task.loc.json
@@ -17,7 +17,7 @@
   "version": {
     "Major": 2,
     "Minor": 1,
-    "Patch": 1
+    "Patch": 3
   },
   "demands": [
     "azureps"
diff --git a/Tasks/AzurePowerShellV3/AzurePowerShell.ps1 b/Tasks/AzurePowerShellV3/AzurePowerShell.ps1
@@ -158,4 +158,5 @@ finally {
 
     Import-Module $PSScriptRoot\ps_modules\VstsAzureHelpers_
     Remove-EndpointSecrets
+    Disconnect-AzureAndClearContext
 }
diff --git a/Tasks/AzurePowerShellV3/Tests/DoesNotFailOnStandardError.ps1 b/Tasks/AzurePowerShellV3/Tests/DoesNotFailOnStandardError.ps1
@@ -12,6 +12,7 @@ Register-Mock Get-VstsInput { $false } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV3/Tests/DoesNotThrowForNativeCommandError.ps1 b/Tasks/AzurePowerShellV3/Tests/DoesNotThrowForNativeCommandError.ps1
@@ -12,6 +12,7 @@ Register-Mock Get-VstsInput { $false } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV3/Tests/DoesNotUnravelOutput.ps1 b/Tasks/AzurePowerShellV3/Tests/DoesNotUnravelOutput.ps1
@@ -12,6 +12,7 @@ Register-Mock Get-VstsInput { $true } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV3/Tests/FailsForNativeCommandError.ps1 b/Tasks/AzurePowerShellV3/Tests/FailsForNativeCommandError.ps1
@@ -12,6 +12,7 @@ Register-Mock Get-VstsInput { $true } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV3/Tests/PerformsBasicFlow.ps1 b/Tasks/AzurePowerShellV3/Tests/PerformsBasicFlow.ps1
@@ -14,6 +14,7 @@ Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Get-VstsEndpoint { @{auth = @{ scheme = "ServicePrincipal" }} }
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = & $PSScriptRoot\..\AzurePowerShell.ps1
diff --git a/Tasks/AzurePowerShellV3/Tests/RedirectsErrors.ps1 b/Tasks/AzurePowerShellV3/Tests/RedirectsErrors.ps1
@@ -12,6 +12,7 @@ Register-Mock Get-VstsInput { $true } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV3/Tests/RemovesFunctionsAndVariables.ps1 b/Tasks/AzurePowerShellV3/Tests/RemovesFunctionsAndVariables.ps1
@@ -13,6 +13,7 @@ Register-Mock Get-VstsInput { "continue" } -- -Name errorActionPreference
 Register-Mock Get-VstsInput { $true } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Arrange the mock task SDK module.
 New-Module -Name VstsTaskSdk -ScriptBlock {
diff --git a/Tasks/AzurePowerShellV3/Tests/ValidateInlineScriptFlow.ps1 b/Tasks/AzurePowerShellV3/Tests/ValidateInlineScriptFlow.ps1
@@ -16,6 +16,7 @@ Register-Mock Get-VstsInput { $true } -- -Name FailOnStandardError
 Register-Mock Update-PSModulePathForHostedAgent
 Register-Mock Initialize-Azure
 Register-Mock Remove-EndpointSecrets
+Register-Mock Disconnect-AzureAndClearContext
 
 # Act.
 $actual = @( & $PSScriptRoot\..\AzurePowerShell.ps1 )
diff --git a/Tasks/AzurePowerShellV3/task.json b/Tasks/AzurePowerShellV3/task.json
@@ -17,7 +17,7 @@
     "version": {
         "Major": 3,
         "Minor": 1,
-        "Patch": 10
+        "Patch": 11
     },
     "releaseNotes": "Added support for Fail on standard error and ErrorActionPreference",
     "demands": [
diff --git a/Tasks/AzurePowerShellV3/task.loc.json b/Tasks/AzurePowerShellV3/task.loc.json
@@ -17,7 +17,7 @@
   "version": {
     "Major": 3,
     "Minor": 1,
-    "Patch": 9
+    "Patch": 11
   },
   "releaseNotes": "ms-resource:loc.releaseNotes",
   "demands": [
diff --git a/Tasks/Common/VstsAzureHelpers_/InitializeFunctions.ps1 b/Tasks/Common/VstsAzureHelpers_/InitializeFunctions.ps1
@@ -632,3 +632,40 @@ function Remove-EndpointSecrets {
         Write-Verbose "Removed certificate from certificate store."
     }
 }
+
+function Disconnect-AzureAndClearContext {
+    [CmdletBinding()]
+    param()
+
+    try {
+        Write-Verbose "Trying to disconnect from Azure and clear context"
+
+        if (Get-Command -Name "Disconnect-AzureRmAccount" -ErrorAction "SilentlyContinue") {
+            Write-Host "##[command]Disconnect-AzureRmAccount"
+            Disconnect-AzureRmAccount
+        }
+        elseif (Get-Command -Name "Remove-AzureRmAccount" -ErrorAction "SilentlyContinue") {
+            Write-Host "##[command]Remove-AzureRmAccount"
+            Remove-AzureRmAccount
+        }
+        elseif (Get-Command -Name "Logout-AzureRmAccount" -ErrorAction "SilentlyContinue") {
+            Write-Host "##[command]Logout-AzureRmAccount"
+            Logout-AzureRmAccount
+        }
+        else {
+            $noCommandMessage = "Unable to find a command to log out of Azure"
+            Write-Host "##vso[task.logissue type=warning;]$noCommandMessage"
+        }
+
+        if (Get-Command -Name "Clear-AzureRmContext" -ErrorAction "SilentlyContinue") {
+            Write-Host "##[command]Clear-AzureRmContext -Scope Process"
+            $null = Clear-AzureRmContext -Scope Process
+            Write-Host "##[command]Clear-AzureRmContext -Scope CurrentUser -Force -ErrorAction SilentlyContinue"
+            $null = Clear-AzureRmContext -Scope CurrentUser -Force -ErrorAction SilentlyContinue
+        }
+    } catch {
+        $error = $_.Exception.Message
+        Write-Verbose "Unable to disconnect and clear context: $error"
+        Write-Host "##vso[task.logissue type=warning;]$error"
+    }
+}
diff --git a/Tasks/Common/VstsAzureHelpers_/VstsAzureHelpers_.psm1 b/Tasks/Common/VstsAzureHelpers_/VstsAzureHelpers_.psm1
@@ -65,4 +65,5 @@ function Initialize-Azure {
 # Export only the public function.
 Export-ModuleMember -Function Initialize-Azure
 Export-ModuleMember -Function CmdletHasMember
-Export-ModuleMember -Function Remove-EndpointSecrets
+Export-ModuleMember -Function Remove-EndpointSecrets
+Export-ModuleMember -Function Disconnect-AzureAndClearContext

Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,7 @@ try{`
`176`	`176`	`Validate-AzureCloudServiceStatus -CloudServiceName $ServiceName -Slot $Slot`
`177`	`177`	`}`
`178`	`178`	`} finally {`
	`179`	`+ Disconnect-AzureAndClearContext`
`179`	`180`	`Trace-VstsLeavingInvocation $MyInvocation`
`180`	`181`	`}`
`181`	`182`
Original file line number	Diff line number	Diff line change
`@@ -197,6 +197,7 @@ finally`
`197`	`197`	`{`
`198`	`198`	`Remove-AzureContainer -containerName $containerName -storageContext $storageContext`
`199`	`199`	`Remove-EndpointSecrets`
	`200`	`+ Disconnect-AzureAndClearContext`
`200`	`201`	`Write-Verbose "Completed Azure File Copy Task for Azure VMs Destination" -Verbose`
`201`	`202`	`Trace-VstsLeavingInvocation $MyInvocation`
`202`	`203`	`}`
Original file line number	Diff line number	Diff line change
`@@ -249,6 +249,7 @@ finally`
`249`	`249`	`{`
`250`	`250`	`Remove-AzureContainer -containerName $containerName -storageContext $storageContext`
`251`	`251`	`Remove-EndpointSecrets`
	`252`	`+ Disconnect-AzureAndClearContext`
`252`	`253`	`Write-Verbose "Completed Azure File Copy Task for Azure VMs Destination" -Verbose`
`253`	`254`	`Trace-VstsLeavingInvocation $MyInvocation`
`254`	`255`	`}`
Original file line number	Diff line number	Diff line change
`@@ -139,4 +139,6 @@ finally {`
`139`	`139`	`if ($__vstsAzPSInlineScriptPath -and (Test-Path -LiteralPath $__vstsAzPSInlineScriptPath) ) {`
`140`	`140`	`Remove-Item -LiteralPath $__vstsAzPSInlineScriptPath -ErrorAction 'SilentlyContinue'`
`141`	`141`	`}`
	`142`	`+`
	`143`	`+ Disconnect-AzureAndClearContext`
`142`	`144`	`}`