通过批处理提高 Microsoft Graph PowerShell 性能

批处理（也称为 JSON 批处理）可与 Microsoft Graph PowerShell 结合使用，以提高需要与 Microsoft 365、Microsoft Entra 或 Microsoft Intune 中的服务交互的现有脚本的性能。

批处理的概念非常简单。您收集信息以发出多个请求，然后将它们作为“批量”提交到 Microsoft Graph API。这允许您同时发出多个请求，从而缩短脚本的总时间。

什么是请求批处理？

请求批处理使应用程序能够将多个请求组合到 Microsoft Graph，以提高性能并减少延迟。它还可以在 Microsoft Graph PowerShell 中使用，帮助管理员提高管理任务和脚本的性能。

请求批次是单个 JSON 对象内的请求集合，在 PowerShell 中，可以将其存储在变量中。 JSON 对象可以通过多种方式生成，包括：

• 通过在此处字符串之间手动定义它。
• 通过定义哈希表并将其转换为 JSON。
• 通过代码构建对象并将其转换为 JSON（最有效）

然后，可以使用 Invoke-RestMethod 或 Invoke-MgGraphRequest cmdlet 以及 POST 方法将该批次提交到 Microsoft Graph。

什么时候应该使用批量请求？

使用 Microsoft Graph 中的请求批处理机制会增加脚本的复杂性。因此，虽然它可以提高代码的性能和“输出时间”，但它通常会降低您的代码对于可能需要阅读或继承它的其他人的可读性。因此，我仅建议当您必须向 Microsoft Graph 发出大量请求（超过 20 个）时才对请求进行批处理。

例如，如果您要从环境中删除许多用户或设备，它可能会给您带来好处。虽然使用 Microsoft Graph 进行筛选来检索对象列表很容易，但删除它们将需要单独的删除请求。假设您需要从目录中删除 100 个对象，而不是向 Microsoft Graph 发送 100 个单独的请求并等待每个请求执行后再开始下一个。在这种情况下，它们可以以 20 个为一组进行批处理，因此您只需向 Microsoft Graph 发出 5 个请求。

PowerShell 中批处理的性能优势

我已经对使用批处理及其性能优势进行了一些实际测试。为此，我在 Microsoft Entra 中创建了 2000 个测试用户（这些用户未获得许可或配置）。我已将 1000 个用户存储在 $1to1000 变量中，另外 1000 个用户存储在 $1001to2000 变量中。

这是下面第一个用于删除 1000 个用户的脚本。该脚本发送了删除每个用户的单独请求。

Foreach ($user in $1to1000){
        Remove-MgUser -UserId $user.id
}

使用 Measure-Command cmdlet，完成删除用户的总时间为 33 秒

然后，我运行以下脚本，该脚本将请求以 20 个为一组进行批处理，然后将它们作为单个请求提交。

for($i=0;$i -lt $1001to2000.count;$i+=20){
    $batch = @{}
    $batch['requests'] = ($1001to2000[$i..($i+19)] | select @{n='id';e={$_.id}},@{n='method';e={'DELETE'}},`
    @{n='url';e={"/users/$($_.id)"}})
    Invoke-mggraphrequest -Method POST -URI "https://graph.microsoft.com/v1.0/`$batch" -body ($batch | convertto-json) -OutputType PSObject
}

您可以看到完成的总时间为 12 秒，这是一个显着的改进。

批处理请求示例

下面是 Microsoft Graph 的 JSON 批量请求示例。您可以看到请求的正文被此处字符串 (@’ ‘@) 包围。

Here-strings 可以用单引号指定（如下所示），也可以使用双引号。不同之处在于单引号按字面意思读取文本并且不会扩展变量。但是，双引号将允许可扩展变量。

然后，将 Invoke-MgGraphRequest cmdlet 与 POST 方法结合使用。我还在 URI Web 路径中使用了反引号 ( ` )。这可确保 $batch 字符串按字面意思处理，而不是扩展为变量，这是批量请求所必需的。

然后，包含请求正文的 $batch 变量与-body 变量一起使用来提交请求。

$batch = @'
{
  "requests": [
    {
      "id": "1",
      "method": "GET",
      "url": "/users/[email "
    },
    {
      "id": "2",
      "method": "GET",
      "url": "/users/[email "
    },
    {
      "id": "3",
      "method": "GET",
      "url": "/users/[email "
    }
  ]
}
'@

$response = Invoke-MgGraphRequest `
-Method POST `
-URI "https://graph.microsoft.com/beta/`$batch" `
-body $batch `
-OutputType PSObject

将响应保存到变量可确保您可以使用点表示法引用数据。您可以使用下面的示例来提取批处理请求中定义的用户的用户名和电子邮件地址。

$response.responses.body | Select UserPrincipalName, proxyaddresses | ft

生成批量请求

在前面的示例中，我演示了使用批量请求的性能优势。这样，我使用 PowerShell For 循环为每个请求生成 JSON 批处理，其中重要的是，每个请求都是针对相同类型的不同对象的重复。这使您能够通过 PowerShell 有效地使用批处理，否则将是不切实际的。这是模板代码：

for($i=0;$i -lt $objects.count;$i+=20){
    $batch = @{}
    $batch['requests'] = ($objects[$i..($i+19)] | select @{n='id';e={$_.id}},@{n='method';e={'DELETE'}},`
	@{n='url';e={"/users/$($_.id)"}})
    invoke-mggraphrequest -Method POST -URI "https://graph.microsoft.com/v1.0/`$batch" -body ($batch | convertto-json) -OutputType PSObject
}

为了分解其背后的逻辑，For 循环（或 For 语句）在其语法中包含三个关键信息，我在下图中的第一行中突出显示了这些信息。

$i=0。该命令将在循环开始之前运行。它用于创建并初始化一个起始值为 0 的变量。

$i -lt $obects.count。该语句是条件（或规则），它表示当初始变量$i小于集合（或数组）中的对象总数时继续执行此循环。

$i+=20。这是返回语句。这将在每个循环中执行，并将 20 添加到 $i 的值上。因此，在第一个循环中 $i=0，然后在下一个循环中 $i=20，然后是 40，依此类推。

这允许代码循环，同时在每个循环上向 $i 添加 20，这在下一步中至关重要。

$objects 数组在下面突出显示，然后方括号中是范围选择器。在循环的第一遍 $i=0 和 $i+19=19 中，这将选择数组中的前 20 个对象，将其包含在第一个循环中批量请求。

然后 return 语句会将 20 添加到 $i 中，为第二次循环做好准备；在第二个循环中，$i=20 和 $i+19=39，从数组中选择接下来的 20 个项目并将它们添加到下一个批量请求中。这将一直持续到 $i 小于数组中的对象总数为止。结果是数组中的所有对象都将在批处理请求中提交到 Microsoft Graph。

包起来

虽然批处理请求可以极大地提高脚本的性能，但请明智地使用它们，因为在协作处理脚本时，增加的复杂性可能会成为一个问题，特别是在总体性能影响很小的情况下。

您还可以通过多种不同的方式生成批量请求。上面我演示了如何使用 PowerShell 中的 For 语句以编程方式生成请求。这适用于重复请求类型。但是，另一种方法可能是将请求信息存储在脚本之外（例如在 CSV 文件中），然后通过代码导入。