Merge pull request #259894 from Farha-Bano/Ad-hoc-updates-VMware-Nov30

Removed the deboarding PS script and added the download link

Author: American-Dipper

articles/azure-arc/vmware-vsphere/remove-vcenter-from-arc-vmware.md

@@ -4,7 +4,7 @@ description: This article explains the steps to cleanly remove your VMware vCent
 author: snehithm
 ms.author: snmuvva
 ms.topic: how-to 
-ms.date: 11/06/2023
+ms.date: 11/30/2023
 ms.service: azure-arc
 ms.subservice: azure-arc-vmware-vsphere
 ms.custom: devx-track-azurecli
@@ -95,246 +95,8 @@ You can remove your VMware vSphere resources from Azure Arc using either the deb
 
 ### Remove VMware vSphere resources from Azure Arc using deboarding script
 
-Use the deboarding script to do a full cleanup of all the Arc-enabled VMware resources. The script removes all the Azure resources, including vCenter, custom location, virtual machines, virtual templates, hosts, clusters, resource pools, datastores, virtual networks, Azure Resource Manager (ARM) resource of Appliance, and the appliance VM running on vCenter.
+Download the [deboarding script](https://aka.ms/arcvmwaredeboard) to do a full cleanup of all the Arc-enabled VMware resources. The script removes all the Azure resources, including vCenter, custom location, virtual machines, virtual templates, hosts, clusters, resource pools, datastores, virtual networks, Azure Resource Manager (ARM) resource of Appliance, and the appliance VM running on vCenter.
 
-```powershell
-[CmdletBinding()]
-Param(
-  [string] $vCenterId,
-  [string] $AVSId,
-  [string] $ApplianceConfigFilePath,
-  [switch] $Force
-)
-
-$DeleteFailedThreshold = 20
-$AVS_API_Version = "2022-05-01"
-
-$logFile = Join-Path $PSScriptRoot "arcvmware-deboard.log"
-
-function logText($msg) {
-  $msgFull = "$(Get-Date -UFormat '%T') $msg"
-  Write-Host $msgFull
-  Write-Output $msgFull >> $logFile
-}
-
-function fail($msg) {
-  $msgFull = @"
-  $(Get-Date -UFormat '%T') Script execution failed with error: $msg
-  $(Get-Date -UFormat '%T') Debug logs have been dumped to $logFile
-  $(Get-Date -UFormat '%T') The script will terminate shortly
-"@
-  Write-Host -ForegroundColor Red $msgFull >> $logFile
-  Write-Output $msgFull >> $logFile
-  Start-Sleep -Seconds 5
-  exit 1
-}
-
-if (!($PSBoundParameters.ContainsKey('vCenterId') -xor $PSBoundParameters.ContainsKey('AVSId'))) {
-  fail "Please specify either vCenterId or AVSId, not both."
-}
-
-
-logText "Writing debug logs to $logFile"
-
-logText "Installing az cli extensions for Arc"
-az extension add --upgrade --name arcappliance
-az extension add --upgrade --name k8s-extension
-az extension add --upgrade --name customlocation
-$vmware_ext_ver = az version --query 'extensions.connectedvmware' -o tsv 2>> $logFile
-if ($vmware_ext_ver -and [System.Version]$vmware_ext_ver -gt [System.Version]"0.1.12") {
-  logText "Removing the connectedvmware extension and pinning it to 0.1.12"
-  az extension remove --name connectedvmware --debug 2>> $logFile
-}
-az extension add --upgrade --name connectedvmware --version 0.1.12
-az extension add --upgrade --name resource-graph
-
-logText "Fetching some information related to the vCenter..."
-if ($PSBoundParameters.ContainsKey('AVSId')) {
-  $vCenterId = az rest --method get --url "$AVSId/addons/arc?api-version=$AVS_API_Version" --query "properties.vCenter" -o tsv --debug 2>> $logFile
-  if ($null -eq $vCenterId) {
-    fail "Unable to find vCenter ID for AVS $AVSId"
-  }
-  logText "vCenterId is $vCenterId"
-}
-else {
-  $exists = az connectedvmware vcenter show --ids $vCenterId --debug 2>> $logFile
-  if ($null -eq $exists) {
-    fail "Unable to find vCenter ID $vCenterId"
-  }
-}
-
-$customLocationID = az resource show --ids $vCenterId --query extendedLocation.name -o tsv --debug 2>> $logFile
-$customLocation = az resource show --ids $customLocationID --debug 2>> $logFile | ConvertFrom-Json
-
-if ($null -ne $customLocation) {
-  $clusterExtensionIds = $customLocation.properties.clusterExtensionIds
-  $applianceId = $customLocation.properties.hostResourceId
-}
-
-$otherCustomLocationsInAppliance = $(az graph query -q @"
-  Resources
-  | where type =~ 'Microsoft.ExtendedLocation/customLocations'
-  | where id !~ '$customLocationID'
-  | where properties.hostResourceId =~ '$applianceId'
-  | project id
-"@.Replace("`r`n", " ").Replace("`n", " ") --debug 2>> $logFile | ConvertFrom-Json).data.id
-
-$resourceTypes = [PSCustomObject]@(
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/VirtualMachines"; InventoryType = "VirtualMachine"; AzSubCommand = "vm"; AzArgs = @("--retain") },
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/VirtualMachineTemplates"; InventoryType = "VirtualMachineTemplate"; AzSubCommand = "vm-template" },
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/Hosts"; InventoryType = "Host"; AzSubCommand = "host" },
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/Clusters"; InventoryType = "Cluster"; AzSubCommand = "cluster" },
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/ResourcePools"; InventoryType = "ResourcePool"; AzSubCommand = "resource-pool" },
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/Datastores"; InventoryType = "Datastore"; AzSubCommand = "datastore" },
-  @{ Type = "Microsoft.ConnectedVMwareVsphere/VirtualNetworks"; InventoryType = "VirtualNetwork"; AzSubCommand = "virtual-network" }
-)
-
-foreach ($resourceType in $resourceTypes) {
-  $resourceIds = @()
-  $skipToken = $null
-  $query = @"
-( 
-  Resources
-  | where type =~ '$($resourceType.Type)'
-  | where properties.vCenterId =~ '$vCenterId'
-  | project id=tolower(id)
-  | union (
-    ConnectedVMwareVsphereResources
-    | where type =~ 'Microsoft.ConnectedVMwareVsphere/VCenters/InventoryItems' and kind =~ '$($resourceType.InventoryType)'
-    | where id startswith '$vCenterId/InventoryItems'
-    | where properties.managedResourceId != ''
-    | extend id=tolower(tostring(properties.managedResourceId))
-    | project id
-  )
-) | distinct id
-"@.Replace("`r`n", " ").Replace("`n", " ")
-  logText "Searching $($resourceType.Type)..."
-  $deleteFailed = @()
-  while ($true) {
-    if ($skipToken) {
-      $page = az graph query --skip-token $skipToken -q $query --debug 2>> $logFile | ConvertFrom-Json
-    }
-    else {
-      $page = az graph query -q $query --debug 2>> $logFile | ConvertFrom-Json
-    }
-    $page.data | ForEach-Object {
-      $resourceIds += $_.id
-    }
-    if ($null -eq $page.skip_token) {
-      break
-    }
-    $skipToken = $page.skip_token
-  }
-  logText "Found $($resourceIds.Count) $($resourceType.Type)"
-
-  $azArgs = $resourceType.AzArgs
-  if ($Force) {
-    $azArgs = @("--force")
-  }
-  $width = $resourceIds.Count.ToString().Length
-  for ($i = 0; $i -lt $resourceIds.Count; $i++) {
-    $resourceId = $resourceIds[$i]
-    logText $("({0,$width}/$($resourceIds.Count)) Deleting $resourceId" -f $($i + 1))
-    az connectedvmware $resourceType.AzSubCommand delete --debug --yes --ids $resourceId $azArgs 2>> $logFile
-    if ($LASTEXITCODE -ne 0) {
-      logText "Failed to delete $resourceId"
-      $deleteFailed += $resourceId
-    }
-    if ($deleteFailed.Count -gt $DeleteFailedThreshold) {
-      fail @"
-  Failed to delete $($deleteFailed.Count) resources. Skipping the deletion of the rest of the resources in the vCenter.
-  The resource ID of these resources are:
-`t$($deleteFailed -join "`n`t")
-
-  Skipping vCenter deletion.
-"@
-    }
-  }
-}
-
-if ($deleteFailed.Count -gt 0) {
-  fail @"
-  Failed to delete $($deleteFailed.Count) resources. The resource ID of these resources are:
-`t$($deleteFailed -join "`n`t")
-
-  Skipping vCenter deletion.
-"@
-}
-
-Write-Host ""
-logText "Successfully deleted all the resources in the vCenter"
-logText "Deleting the vCenter: $vCenterId"
-$azArgs = @()
-if ($Force) {
-  $azArgs = @("--force")
-}
-az connectedvmware vcenter delete --debug --yes --ids $vCenterId $azArgs 2>> $logFile
-if ($LASTEXITCODE -ne 0) {
-  fail "Failed to delete $vCenterId"
-}
-if ($PSBoundParameters.ContainsKey('AVSId')) {
-  logText "Deleting the arc addon for the AVS $AVSId"
-  az rest --method delete --debug --url "$AVSId/addons/arc?api-version=$AVS_API_Version" 2>> $logFile
-  if ($LASTEXITCODE -ne 0) {
-    fail "Failed to delete $AVSId/addons/arc"
-  }
-}
-
-function extractPartsFromID($id) {
-  $id -match "/+subscriptions/+([^/]+)/+resourceGroups/+([^/]+)/+providers/+([^/]+)/+([^/]+)/+([^/]+)"
-  return @{
-    SubscriptionId = $Matches[1]
-    ResourceGroup  = $Matches[2]
-    Provider       = $Matches[3]
-    Type           = $Matches[4]
-    Name           = $Matches[5]
-  }
-}
-
-if ($null -ne $clusterExtensionIds -and $clusterExtensionIds.Count -gt 1) {
-  logText "Skipping the deletion of custom location and appliance because there are multiple cluster extensions enabled in the custom location"
-  logText "The cluster extension IDs are:"
-  logText "  $($clusterExtensionIds -join "`n  ")"
-  exit 0
-}
-if ($null -eq $customLocation) {
-  logText "The custom location '$customLocationID' is not found. Skipping the deletion of the custom location."
-}
-else {
-  logText "Deleting the custom location: $customLocationID"
-  $clInfo = extractPartsFromID $customLocationID
-  az customlocation delete --debug --yes --subscription $clInfo.SubscriptionId --resource-group $clInfo.ResourceGroup --name $clInfo.Name 2>> $logFile
-  # The command above is returning error when the cluster is not reachable, so $LASTEXITCODE is not reliable.
-  # Instead, check if resource is not found after delete, else throw error.
-  $cl = az resource show --ids $customLocationID --debug 2>> $logFile
-  if ($cl) {
-    fail "Failed to delete $customLocationID"
-  }
-}
-if ($otherCustomLocationsInAppliance.Count -gt 0) {
-  logText "Skipping the deletion of the appliance because there are other custom locations in the appliance"
-  logText "The custom location IDs of these custom locations are:"
-  logText "  $($otherCustomLocationsInAppliance -join "`n  ")"
-  exit 0
-}
-
-if ($PSBoundParameters.ContainsKey('ApplianceConfigFilePath')) {
-  logText "Deleting the appliance: $applianceId"
-  az arcappliance delete vmware --debug --yes --config-file $ApplianceConfigFilePath 2>> $logFile
-  if ($LASTEXITCODE -ne 0) {
-    fail "Failed to delete $applianceId"
-  }
-}
-else {
-  logText "Skipping the deletion of the appliance VM on the VCenter because the appliance config file path is not provided"
-  logText "Just deleting the ARM resource of the appliance: $applianceId"
-  az resource delete --debug --ids $applianceId 2>> $logFile
-  if ($LASTEXITCODE -ne 0) {
-    fail "Failed to delete $applianceId"
-  }
-}
-logText "Cleanup Complete!"
-```
 #### Run the script
 To run the deboarding script, follow these steps: