使用ForEach-Object -AsJob -Parallel时如何输出调试信息并单步调试？

一、让并行任务输出调试/日志消息 #

-AsJob会把任务放到后台作业，默认的Write-Host、Write-Verbose无法直接输出到控制台，可通过以下方式处理：

1. 捕获作业输出流收集消息 #

后台作业的输出会被存在作业对象里，用Receive-Job就能获取，加上-Keep还能保留输出供后续查看。并行块里用Write-Output输出日志，就能被作业流捕获。

修改你的代码如下：

$appPermissionsJob = $servicePrincipals | ForEach-Object -AsJob -ThrottleLimit $ThrottleLimit -Parallel {
  $spApplicationPermissions = $using:spApplicationPermissions
  $MSGraphServicePrincipalId = $using:MSGraphServicePrincipalId
  $dictFailed = $using:dictFailed
  $servicePrincipalId = $_.Id

  try {
    $applicationPermissions = Get-MgServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipalId -All -PageSize 999

    if ($applicationPermissions -ne $null) {
      $applicationPermissions | ForEach-Object {
        # 用Write-Output输出处理日志，会被作业捕获
        Write-Output "Processing service principal ${servicePrincipalId} with app role $($_.ResourceId)"
        if ($_.ResourceId -eq $MSGraphServicePrincipalId) {
          $item = [PSCustomObject]@{
              ServicePrincipalId     = $servicePrincipalId
              ApplicationPermissions = $applicationPermissions
            }
          $spApplicationPermissions.TryAdd($servicePrincipalId, $item)
        }
      }
    }
  }
  catch {
    # 直接输出错误信息，同样会被作业捕获
    $errorMsg = "Failed to download delegated permissions for service principal ${servicePrincipalId}: $($_.Exception.Message)"
    Write-Output $errorMsg
    $dictFailed.TryAdd($servicePrincipalId, $_.Exception.Message)
  }
}

# 等待作业完成并获取输出
Wait-Job $appPermissionsJob
Receive-Job $appPermissionsJob -Keep

2. 实时查看作业输出 #

如果不想等作业完成再看日志，用循环实时检查并接收输出：

while ($appPermissionsJob.State -eq 'Running') {
  Receive-Job $appPermissionsJob
  Start-Sleep -Seconds 1
}
# 接收剩余输出
Receive-Job $appPermissionsJob -Keep

二、单步调试并行代码 #

-AsJob和-Parallel本质是创建后台子进程，没法直接在主进程单步调试，可用以下两种方法：

1. 用变量控制并行开关 #

不用每次手动删参数，通过全局变量切换并行/调试模式：

$EnableParallel = $false # 调试时设为$false，上线设为$true

if ($EnableParallel) {
  $appPermissionsJob = $servicePrincipals | ForEach-Object -AsJob -ThrottleLimit $ThrottleLimit -Parallel {
    $spApplicationPermissions = $using:spApplicationPermissions
    $MSGraphServicePrincipalId = $using:MSGraphServicePrincipalId
    $dictFailed = $using:dictFailed
    $servicePrincipalId = $_.Id

    try {
      $applicationPermissions = Get-MgServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipalId -All -PageSize 999

      if ($applicationPermissions -ne $null) {
        $applicationPermissions | ForEach-Object {
          Write-Output "Processing service principal ${servicePrincipalId} with app role $($_.ResourceId)"
          if ($_.ResourceId -eq $MSGraphServicePrincipalId) {
            $item = [PSCustomObject]@{
                ServicePrincipalId     = $servicePrincipalId
                ApplicationPermissions = $applicationPermissions
              }
            $spApplicationPermissions.TryAdd($servicePrincipalId, $item)
          }
        }
      }
    }
    catch {
      $errorMsg = "Failed to download delegated permissions for service principal ${servicePrincipalId}: $($_.Exception.Message)"
      Write-Output $errorMsg
      $dictFailed.TryAdd($servicePrincipalId, $_.Exception.Message)
    }
  }
  Wait-Job $appPermissionsJob
  Receive-Job $appPermissionsJob -Keep
} else {
  # 非并行模式，直接执行，方便单步调试
  $servicePrincipals | ForEach-Object {
    $servicePrincipalId = $_.Id

    try {
      $applicationPermissions = Get-MgServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipalId -All -PageSize 999

      if ($applicationPermissions -ne $null) {
        $applicationPermissions | ForEach-Object {
          Write-Host "Processing service principal ${servicePrincipalId} with app role $($_.ResourceId)"
          if ($_.ResourceId -eq $MSGraphServicePrincipalId) {
            $item = [PSCustomObject]@{
                ServicePrincipalId     = $servicePrincipalId
                ApplicationPermissions = $applicationPermissions
              }
            $spApplicationPermissions.TryAdd($servicePrincipalId, $item)
          }
        }
      }
    }
    catch {
      Write-Verbose "Failed to download delegated permissions for service principal ${servicePrincipalId}: $($_.Exception.Message)" -Verbose
      $dictFailed.TryAdd($servicePrincipalId, $_.Exception.Message)
    }
  }
}

2. 封装并行逻辑为独立函数 #

把并行块代码抽成函数，先在非并行环境调试函数，确认逻辑没问题再放到并行块里：

# 先定义可单独调试的函数
function Process-ServicePrincipal {
  param(
    [Parameter(Mandatory)]$ServicePrincipal,
    [Parameter(Mandatory)]$SpApplicationPermissions,
    [Parameter(Mandatory)]$MSGraphServicePrincipalId,
    [Parameter(Mandatory)]$DictFailed
  )

  $servicePrincipalId = $ServicePrincipal.Id
  try {
    $applicationPermissions = Get-MgServicePrincipalAppRoleAssignedTo -ServicePrincipalId $servicePrincipalId -All -PageSize 999

    if ($applicationPermissions -ne $null) {
      $applicationPermissions | ForEach-Object {
        Write-Host "Processing service principal ${servicePrincipalId} with app role $($_.ResourceId)"
        if ($_.ResourceId -eq $MSGraphServicePrincipalId) {
          $item = [PSCustomObject]@{
              ServicePrincipalId     = $servicePrincipalId
              ApplicationPermissions = $applicationPermissions
            }
          $SpApplicationPermissions.TryAdd($servicePrincipalId, $item)
        }
      }
    }
  }
  catch {
    Write-Verbose "Failed to download delegated permissions for service principal ${servicePrincipalId}: $($_.Exception.Message)" -Verbose
    $DictFailed.TryAdd($servicePrincipalId, $_.Exception.Message)
  }
}

# 调试时，单独调用函数测试单个对象
$testSp = $servicePrincipals[0]
Process-ServicePrincipal -ServicePrincipal $testSp -SpApplicationPermissions $spApplicationPermissions -MSGraphServicePrincipalId $MSGraphServicePrincipalId -DictFailed $dictFailed

# 上线时，用并行执行
$appPermissionsJob = $servicePrincipals | ForEach-Object -AsJob -ThrottleLimit $ThrottleLimit -Parallel {
  Process-ServicePrincipal -ServicePrincipal $_ -SpApplicationPermissions $using:spApplicationPermissions -MSGraphServicePrincipalId $using:MSGraphServicePrincipalId -DictFailed $using:dictFailed
}
Wait-Job $appPermissionsJob
Receive-Job $appPermissionsJob -Keep

三、批量并行任务的扩展方案 #

如果有数百个类似的并行循环，建议统一做以下处理：

• 全局定义$EnableParallel变量，所有并行任务都根据这个变量切换模式
• 封装统一的日志输出函数，并行/非并行模式用相同逻辑输出，减少重复代码
• 每个并行块的逻辑都抽成独立函数，方便单独调试和维护

内容的提问来源于stack exchange，提问作者Shuzheng