Azure Sentinel内容包安装API问题排查与解决方案

问题背景

近期Azure Sentinel内容包安装API在升级至2024-09-01版本后，部分用户反馈原有的安装脚本出现400(Bad Request)错误。本文将从技术角度分析该问题的原因，并提供完整的解决方案。

问题现象

用户在使用PowerShell调用内容包安装API时，收到以下错误响应：

VERBOSE: Requested HTTP/1.1 PUT with 270-byte payload
VERBOSE: Received HTTP/1.1 96-byte response of content type application/json
Error occurred during API call:
Write-Error: Response status code does not indicate success: 400 (Bad Request)

请求体示例：

{
  "properties": {
    "contentProductId": "azuresentinel.azure-sentinel-solution-syslog-sl-2qhp35ywfuyrm",
    "displayName": "Syslog",
    "contentKind": "Solution",
    "contentId": "azuresentinel.azure-sentinel-solution-syslog",
    "version": "3.0.7"
  }
}

根本原因分析

经过深入排查，发现API版本2024-09-01引入了一个新的必填字段contentSchemaVersion，而该字段在之前的API版本中并非必需。文档更新未能及时反映这一变更，导致用户请求体缺少必要参数而触发400错误。

解决方案

完整请求体示例

修正后的请求体应包含contentSchemaVersion字段：

{
  "properties": {
    "contentProductId": "azuresentinel.azure-sentinel-solution-syslog-sl-2qhp35ywfuyrm",
    "displayName": "Syslog",
    "contentKind": "Solution",
    "contentId": "azuresentinel.azure-sentinel-solution-syslog",
    "version": "3.0.7",
    "contentSchemaVersion": "2.0"
  }
}

PowerShell实现代码

$newObject2 = New-Object PSObject -Property @{
    'properties' = @{
        'contentId' = $criterion.contentId
        'contentProductId' = $criterion.contentProductId
        'contentKind' = $criterion.contentKind
        'version' = $LatestVersion
        'displayName' = $criterion.displayName
        'contentSchemaVersion' = "2.0"  # 新增必填字段
    }
}
$body = $newObject2 | ConvertTo-Json
$url = "https://management.azure.com/subscriptions/$global:subscriptionId/resourceGroups/$global:resourceGroupName/providers/Microsoft.OperationalInsights/workspaces/$global:workspaceName/providers/Microsoft.SecurityInsights/contentPackages/azuresentinel.azure-sentinel-solution-syslog?api-version=2024-09-01"

Invoke-RestMethod -Method PUT -Uri $url -Headers $global:authHeader -Body $body -Verbose

最佳实践建议

1. API版本管理：当API升级时，应仔细阅读变更日志，了解新增的必填字段和废弃的参数。

2. 错误处理：在脚本中增加完善的错误处理逻辑，捕获并解析API返回的错误信息。

3. 参数验证：在发送请求前，验证请求体是否包含所有必填字段。

4. 文档参考：定期检查官方文档更新，特别是API版本变更时。

总结

Azure Sentinel内容包安装API在2024-09-01版本中引入了contentSchemaVersion作为必填字段。开发人员在使用新版API时，需要在请求体中添加该字段才能成功调用API。本文提供的解决方案已经过实际验证，可帮助用户快速解决400错误问题。建议开发团队关注API变更通知，及时调整集成代码。