Merge pull request #284224 from JeffreyWolford/patch-21

v-shils · web-flow · commit 7233b4dd84f2 · 2024-08-09T12:08:28.000-07:00
Update azure-monitor-agent-mma-removal-tool.md
diff --git a/articles/azure-monitor/agents/azure-monitor-agent-mma-removal-tool.md b/articles/azure-monitor/agents/azure-monitor-agent-mma-removal-tool.md
@@ -50,11 +50,11 @@ You'll use the following script for agent removal. Open a file in your local dir
 # az login
 # az account set --subscription <subscription_id/subscription_name>
 # This script uses parallel processing, modify the $parallelThrottleLimit parameter to either increase or decrease the number of parallel processes
-# PS> .\MMAUnistallUtilityScript.ps1 GetInventory
-# The above command will generate a csv file with the details of Vm's and Vmss that has MMA extension installed. 
+# PS> .\LogAnalyticsAgentUninstallUtilityScript.ps1 GetInventory
+# The above command will generate a csv file with the details of Vm's and Vmss and Arc servers that has MMA/OMS extension installed. 
 # The customer can modify the the csv by adding/removing rows if needed
-# Remove the MMA by running the script again as shown below:
-# PS> .\MMAUnistallUtilityScript.ps1 UninstallMMAExtension
+# Remove the MMA/OMS by running the script again as shown below:
+# PS> .\LogAnalyticsAgentUninstallUtilityScript.ps1 UninstallExtension
 
 # This version of the script requires Powershell version >= 7 in order to improve performance via ForEach-Object -Parallel
 # https://docs.microsoft.com/en-us/powershell/scripting/whats-new/migrating-from-windows-powershell-51-to-powershell-7?view=powershell-7.1
@@ -66,13 +66,96 @@ if ($PSVersionTable.PSVersion.Major -lt 7)
 
 $parallelThrottleLimit = 16
 
-function GetVmsWithMMAExtensionInstalled
+function GetArcServersWithLogAnalyticsAgentExtensionInstalled {
+    param (
+        $fileName
+    )
+    
+    $serverList = az connectedmachine list --query "[].{ResourceId:id, ResourceGroup:resourceGroup, ServerName:name}" | ConvertFrom-Json
+    if(!$serverList)
+    {
+        Write-Host "Cannot get the Arc server list"
+        return
+    }
+
+    $serversCount = $serverList.Length
+    $vmParallelThrottleLimit = $parallelThrottleLimit
+    if ($serversCount -lt $vmParallelThrottleLimit) 
+    {
+        $serverParallelThrottleLimit = $serversCount
+    }
+
+    if($serversCount -eq 1)
+    {
+        $serverGroups += ,($serverList[0])
+    }
+    else
+    {
+        # split the list into batches to do parallel processing
+        for ($i = 0; $i -lt $serversCount; $i += $vmParallelThrottleLimit) 
+        { 
+            $serverGroups += , ($serverList[$i..($i + $serverParallelThrottleLimit - 1)]) 
+        }
+    }
+
+    Write-Host "Detected $serversCount Arc servers in this subscription."
+    $hash = [hashtable]::Synchronized(@{})
+    $hash.One = 1
+
+    $serverGroups | Foreach-Object -ThrottleLimit $parallelThrottleLimit -Parallel {
+        $len = $using:serversCount
+        $hash = $using:hash
+        $_ | ForEach-Object {
+            $percent = 100 * $hash.One++ / $len
+            Write-Progress -Activity "Getting Arc server extensions Inventory" -PercentComplete $percent
+            $serverName = $_.ServerName
+            $resourceGroup = $_.ResourceGroup
+            $resourceId = $_.ResourceId
+            Write-Debug "Getting extensions for Arc server: $serverName"
+            $extensions = az connectedmachine extension list -g $resourceGroup --machine-name $serverName --query "[?contains(['MicrosoftMonitoringAgent', 'OmsAgentForLinux', 'AzureMonitorLinuxAgent', 'AzureMonitorWindowsAgent'], properties.type)].{type: properties.type, name: name}" | ConvertFrom-Json
+
+            if (!$extensions) {
+                return
+            }
+            $extensionMap = @{}
+            foreach ($ext in $extensions) {
+                $extensionMap[$ext.type] = $ext.name
+            }
+            if ($extensionMap.ContainsKey("MicrosoftMonitoringAgent")) {
+                $extensionName = $extensionMap["MicrosoftMonitoringAgent"]
+            }
+            elseif ($extensionMap.ContainsKey("OmsAgentForLinux")) {
+                $extensionName = $extensionMap["OmsAgentForLinux"]
+            }
+            if ($extensionName) {
+                $amaExtensionInstalled = "False"
+                if ($extensionMap.ContainsKey("AzureMonitorWindowsAgent") -or $extensionMap.ContainsKey("AzureMonitorLinuxAgent")) {
+                    $amaExtensionInstalled = "True"
+                }
+                $csvObj = New-Object -TypeName PSObject -Property @{
+                    'ResourceId'              = $resourceId
+                    'Name'                    = $serverName
+                    'Resource_Group'          = $resourceGroup
+                    'Resource_Type'           = "ArcServer"
+                    'Install_Type'            = "Extension"
+                    'Extension_Name'          = $extensionName
+                    'AMA_Extension_Installed' = $amaExtensionInstalled
+                }
+                $csvObj | Export-Csv $using:fileName -Append -Force | Out-Null
+            }
+            # az cli sometime cannot handle many requests at same time, so delaying next request by 2 milliseconds
+            Start-Sleep -Milliseconds 2
+        }
+    }
+}
+
+function GetVmsWithLogAnalyticsAgentExtensionInstalled
 {
     param(
         $fileName
     )
     
-    $vmList = az vm list --query "[].{ResourceGroup:resourceGroup, VmName:name}" | ConvertFrom-Json
+    $vmList = az vm list --query "[].{ResourceId:id, ResourceGroup:resourceGroup, VmName:name}" | ConvertFrom-Json
      
     if(!$vmList)
     {
@@ -81,7 +164,6 @@ function GetVmsWithMMAExtensionInstalled
     }
 
     $vmsCount = $vmList.Length
-    
     $vmParallelThrottleLimit = $parallelThrottleLimit
     if ($vmsCount -lt $vmParallelThrottleLimit) 
     {
@@ -101,7 +183,7 @@ function GetVmsWithMMAExtensionInstalled
         }
     }
 
-    Write-Host "Detected $vmsCount Vm's running in this subscription."
+    Write-Host "Detected $vmsCount Vm's in this subscription."
     $hash = [hashtable]::Synchronized(@{})
     $hash.One = 1
 
@@ -110,109 +192,164 @@ function GetVmsWithMMAExtensionInstalled
         $hash = $using:hash
         $_ | ForEach-Object {
             $percent = 100 * $hash.One++ / $len
-            Write-Progress -Activity "Getting VM Inventory" -PercentComplete $percent
+            Write-Progress -Activity "Getting VM extensions Inventory" -PercentComplete $percent
+            $resourceId = $_.ResourceId
             $vmName = $_.VmName
             $resourceGroup = $_.ResourceGroup
-            $extensionName = az vm extension list -g $resourceGroup --vm-name $vmName --query "[?name == 'MicrosoftMonitoringAgent' || name == 'OmsAgentForLinux'].name" | ConvertFrom-Json
-            if ($extensionName) 
-            {
+            Write-Debug "Getting extensions for VM: $vmName"
+            $extensions = az vm extension list -g $resourceGroup --vm-name $vmName --query "[?contains(['MicrosoftMonitoringAgent', 'OmsAgentForLinux', 'AzureMonitorLinuxAgent', 'AzureMonitorWindowsAgent'], typePropertiesType)].{type: typePropertiesType, name: name}" | ConvertFrom-Json
+            
+            if (!$extensions) {
+                return
+            }
+            $extensionMap = @{}
+            foreach ($ext in $extensions) {
+                $extensionMap[$ext.type] = $ext.name
+            }
+            if ($extensionMap.ContainsKey("MicrosoftMonitoringAgent")) {
+                $extensionName = $extensionMap["MicrosoftMonitoringAgent"]
+            }
+            elseif ($extensionMap.ContainsKey("OmsAgentForLinux")) {
+                $extensionName = $extensionMap["OmsAgentForLinux"]
+            }
+            if ($extensionName) {
+                $amaExtensionInstalled = "False"
+                if ($extensionMap.ContainsKey("AzureMonitorWindowsAgent") -or $extensionMap.ContainsKey("AzureMonitorLinuxAgent")) {
+                    $amaExtensionInstalled = "True"
+                }
                 $csvObj = New-Object -TypeName PSObject -Property @{
-                    'Name'           = $vmName
-                    'Resource_Group' = $resourceGroup
-                    'Resource_Type'  = "VM"
-                    'Install_Type'   = "Extension"
-                    'Extension_Name' = $extensionName
+                    'ResourceId'              = $resourceId
+                    'Name'                    = $vmName
+                    'Resource_Group'          = $resourceGroup
+                    'Resource_Type'           = "VM"
+                    'Install_Type'            = "Extension"
+                    'Extension_Name'          = $extensionName
+                    'AMA_Extension_Installed' = $amaExtensionInstalled
                 }
                 $csvObj | Export-Csv $using:fileName -Append -Force | Out-Null
             }
+            # az cli sometime cannot handle many requests at same time, so delaying next request by 2 milliseconds
+            Start-Sleep -Milliseconds 2
         }
     }
 }
 
-function GetVmssWithMMAExtensionInstalled
+function GetVmssWithLogAnalyticsAgentExtensionInstalled
 {
     param(
         $fileName
     )
 
     # get the vmss list which are successfully provisioned
-    $vmssList = az vmss list --query "[?provisioningState=='Succeeded'].{ResourceGroup:resourceGroup, VmssName:name}" | ConvertFrom-Json   
+    $vmssList = az vmss list --query "[?provisioningState=='Succeeded'].{ResourceId:id, ResourceGroup:resourceGroup, VmssName:name}" | ConvertFrom-Json   
 
     $vmssCount = $vmssList.Length
-    Write-Host "Detected $vmssCount Vmss running in this subscription."
+    Write-Host "Detected $vmssCount Vmss in this subscription."
     $hash = [hashtable]::Synchronized(@{})
     $hash.One = 1
 
     $vmssList | Foreach-Object -ThrottleLimit $parallelThrottleLimit -Parallel {
         $len = $using:vmssCount
         $hash = $using:hash
         $percent = 100 * $hash.One++ / $len
-        Write-Progress -Activity "Getting VMSS Inventory" -PercentComplete $percent
+        Write-Progress -Activity "Getting VMSS extensions Inventory" -PercentComplete $percent
+        $resourceId = $_.ResourceId
         $vmssName = $_.VmssName
         $resourceGroup = $_.ResourceGroup
-
-        $extensionName = az vmss extension list -g $resourceGroup --vmss-name $vmssName --query "[?name == 'MicrosoftMonitoringAgent' || name == 'OmsAgentForLinux'].name" | ConvertFrom-Json
-        if ($extensionName)
-        {
+        Write-Debug "Getting extensions for VMSS: $vmssName"
+        $extensions = az vmss extension list -g $resourceGroup --vmss-name $vmssName --query "[?contains(['MicrosoftMonitoringAgent', 'OmsAgentForLinux', 'AzureMonitorLinuxAgent', 'AzureMonitorWindowsAgent'], typePropertiesType)].{type: typePropertiesType, name: name}" | ConvertFrom-Json
+        
+        if (!$extensions) {
+            return
+        }
+        $extensionMap = @{}
+        foreach ($ext in $extensions) {
+            $extensionMap[$ext.type] = $ext.name
+        }
+        if ($extensionMap.ContainsKey("MicrosoftMonitoringAgent")) {
+            $extensionName = $extensionMap["MicrosoftMonitoringAgent"]
+        }
+        elseif ($extensionMap.ContainsKey("OmsAgentForLinux")) {
+            $extensionName = $extensionMap["OmsAgentForLinux"]
+        }
+        if ($extensionName) {
+            $amaExtensionInstalled = "False"
+            if ($extensionMap.ContainsKey("AzureMonitorWindowsAgent") -or $extensionMap.ContainsKey("AzureMonitorLinuxAgent")) {
+                $amaExtensionInstalled = "True"
+            }
             $csvObj = New-Object -TypeName PSObject -Property @{
-                'Name'           = $vmssName
-                'Resource_Group' = $resourceGroup
-                'Resource_Type'  = "VMSS"
-                'Install_Type'   = "Extension"
-                'Extension_Name' = $extensionName
+                'ResourceId'              = $resourceId
+                'Name'                    = $vmssName
+                'Resource_Group'          = $resourceGroup
+                'Resource_Type'           = "VMSS"
+                'Install_Type'            = "Extension"
+                'Extension_Name'          = $extensionName
+                'AMA_Extension_Installed' = $amaExtensionInstalled
             }
             $csvObj | Export-Csv $using:fileName -Append -Force | Out-Null
-        }    
+        }
+        # az cli sometime cannot handle many requests at same time, so delaying next request by 2 milliseconds
+        Start-Sleep -Milliseconds 2
     }
 }
 
 function GetInventory
 {
     param(
-        $fileName = "MMAInventory.csv"
+        $fileName = "LogAnalyticsAgentExtensionInventory.csv"
     )
 
     # create a new file 
     New-Item -Name $fileName -ItemType File -Force
 
     Start-Transcript -Path $logFileName -Append
-    GetVmsWithMMAExtensionInstalled $fileName
-    GetVmssWithMMAExtensionInstalled $fileName
+    GetVmsWithLogAnalyticsAgentExtensionInstalled $fileName
+    GetVmssWithLogAnalyticsAgentExtensionInstalled $fileName
+    GetArcServersWithLogAnalyticsAgentExtensionInstalled $fileName
     Stop-Transcript
 }
 
-function UninstallMMAExtension
+function UninstallExtension
 {
     param(
-        $fileName = "MMAInventory.csv"
+        $fileName = "LogAnalyticsAgentExtensionInventory.csv"
     )
     Start-Transcript -Path $logFileName -Append
     Import-Csv $fileName | ForEach-Object -ThrottleLimit $parallelThrottleLimit -Parallel {
         if ($_.Install_Type -eq "Extension") 
         {
+            $extensionName = $_.Extension_Name
+            $resourceName = $_.Name
+            Write-Debug "Uninstalling extension: $extensionName from $resourceName"
             if ($_.Resource_Type -eq "VMSS") 
             {
                 # if the extension is installed with a custom name, provide the name using the flag: --extension-instance-name <extension name>
-                az vmss extension delete --name $_.Extension_Name --vmss-name $_.Name --resource-group $_.Resource_Group --output none --no-wait
+                az vmss extension delete --name $extensionName --vmss-name $resourceName --resource-group $_.Resource_Group --output none --no-wait
             }
-            else 
+            elseif($_.Resource_Type -eq "VM")
             {
                 # if the extension is installed with a custom name, provide the name using the flag: --extension-instance-name <extension name>
-                az vm extension delete --name $_.Extension_Name --vm-name $_.Name --resource-group $_.Resource_Group --output none --no-wait
+                az vm extension delete --name $extensionName --vm-name $resourceName --resource-group $_.Resource_Group --output none --no-wait
+            }
+            elseif($_.Resource_Type -eq "ArcServer")
+            {
+                az connectedmachine extension delete --name $extensionName --machine-name $resourceName --resource-group $_.Resource_Group --no-wait --output none --yes -y
             }
+            # az cli sometime cannot handle many requests at same time, so delaying next delete request by 2 milliseconds
+            Start-Sleep -Milliseconds 2
         }
     }
     Stop-Transcript
 }
 
-$logFileName = "MMAUninstallUtilityScriptLog.log"
+$logFileName = "LogAnalyticsAgentUninstallUtilityScriptLog.log"
 
 switch ($args.Count)
 {
     0 {
         Write-Host "The arguments provided are incorrect."
-        Write-Host "To get the Inventory: Run the script as: PS> .\MMAUnistallUtilityScript.ps1 GetInventory"
-        Write-Host "To uninstall MMA from Inventory: Run the script as: PS> .\MMAUnistallUtilityScript.ps1 UninstallMMAExtension"
+        Write-Host "To get the Inventory: Run the script as: PS> .\LogAnalyticsAgentUninstallUtilityScript.ps1 GetInventory"
+        Write-Host "To uninstall MMA/OMS from Inventory: Run the script as: PS> .\LogAnalyticsAgentUninstallUtilityScript.ps1 UninstallExtension"
     }
     1 {
         if (-Not (Test-Path $logFileName)) {
@@ -240,10 +377,10 @@ You'll  collect a list of all legacy agents, both MMA and OMS, on all VM, VMSSs
    ```
 The script reports the total VM, VMSSs, or Arc enables servers seen in the subscription. It takes several minutes to run. You see a progress bar in the console window. Once complete, you are able to see a CSV file called MMAInventory.csv in the local directory with the following format.
 
-|Resource_Group | Resource_Type | Name | Install_Type |Extension_Name |
-|---|---|---|---|---|
-| Linux-AMA-E2E | VM | Linux-ama-e2e-debian9 | Extension | OmsAgentForLinux         |
-|AMA-ADMIN        | VM | test2012-r2-da                    | Extension | MicrosoftMonitorAgent |
+| Resource_ID | Name | Resource_Group | Resource_Type | Install_Type | Extension_Name | AMA_Extension_Installed |  
+|---|---|---|---|---|---|---|
+| 012cb5cf-e1a8-49ee-a484-d40673167c9c | Linux-ama-e2e-debian9  | Linux-AMA-E2E           | VM  | Extension | OmsAgentForLinux      | True  |
+| 8acae35a-454f-4869-bf4f-658189d98516 | test2012-r2-da         | test2012-r2-daAMA-ADMIN | VM  | Extension | MicrosoftMonitorAgent | False |
 
 ## Step 4 Uninstall inventory
 This script iterates through the list of VM, Virtual Machine Scale Sets, and Arc enabled servers and uninstalls the legacy agent. If the VM, Virtual Machine Scale Sets, or Arc enabled server is not running you won't be able to remove the agent. 
