适用于 Windows 的 Log Analytics 代理虚拟机扩展

Azure Monitor 日志提供跨云和本地资产的监视功能。 Microsoft 发布并支持适用于 Windows 的 Log Analytics 代理虚拟机 (VM) 扩展。 该扩展将在 Azure VM 上安装 Log Analytics 代理，并将 VM 注册到现有 Log Analytics 工作区。 本文介绍了适用于 Windows 的 Log Analytics 代理 VM 扩展支持的平台、配置和部署选项。

先决条件

请查看使用适用于 Windows 的 Log Analytics 代理 VM 扩展的以下先决条件：

操作系统

有关支持的 Windows 操作系统的详细信息，请参阅 Azure Monitor 代理概述一文。

代理和 VM 扩展版本

下表提供了每次发布的 Windows Log Analytics VM 扩展和 Log Analytics 代理的版本映射。

Microsoft Defender for Cloud

Microsoft Defender for Cloud 自动预配 Log Analytics 代理并将其连接到 Azure 订阅的默认 Log Analytics 工作区。

Azure Arc

你可以利用已启用 Azure Arc 的服务器将 Log Analytics 代理 VM 扩展部署到非 Azure Windows 和 Linux 计算机，以及移除和更新该扩展。 此方法简化了混合计算机的整个生命周期的管理。 有关详细信息，请参阅使用已启用 Azure Arc 的服务器进行 VM 管理。

Internet 连接

适用于 Windows 的 Log Analytics 代理扩展要求目标 VM 已连接到 Internet。

扩展架构

以下 JSON 显示了适用于 Windows 的 Log Analytics 代理 VM 扩展的架构。 此扩展需要目标 Log Analytics 工作区的工作区 ID 和工作区密钥。 这些内容可在 Azure 门户的工作区设置中找到。

由于工作区密钥应视为敏感数据，因此将它存储在受保护的设置配置中。 Azure VM 扩展保护的设置数据已加密，并且只能在目标 VM 上解密。

{
    "type": "extensions",
    "name": "OMSExtension",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.EnterpriseCloud.Monitoring",
        "type": "MicrosoftMonitoringAgent",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "workspaceId": "myWorkSpaceId"
        },
        "protectedSettings": {
            "workspaceKey": "myWorkspaceKey"
        }
    }
}

属性值

JSON 架构包括以下属性。

*workspaceId 架构属性将被指定为 Log Analytics API 中的 consumerId 属性。

模板部署

可使用 Azure 资源管理器 (ARM) 模板部署 Azure VM 扩展。 上一部分中详细介绍的 JSON 架构可以在 ARM 模板中使用，以便在 ARM 模板部署过程中运行 Log Analytics 代理 VM 扩展。 包含 Log Analytics 代理 VM 扩展的示例模板可以在 Azure 快速入门库中找到。

VM 扩展的 JSON 配置可以嵌套在 VM 资源内，或放置在 JSON ARM 模板的根部或顶层。 JSON 的位置会影响资源名称和类型的值。 有关详细信息，请参阅设置子资源的名称和类型。

以下示例假定 Log Analytics 代理 VM 扩展嵌套在 VM 资源内。 嵌套扩展资源时，JSON 放置在 VM 的 "resources": [] 对象中。

{
    "type": "extensions",
    "name": "OMSExtension",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.EnterpriseCloud.Monitoring",
        "type": "MicrosoftMonitoringAgent",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "workspaceId": "myWorkSpaceId"
        },
        "protectedSettings": {
            "workspaceKey": "myWorkspaceKey"
        }
    }
}

将扩展 JSON 放置在 ARM 模板的根部时，资源 name 将包括对父 VM 的引用，并且 type 反映了嵌套的配置。

{
    "type": "Microsoft.Compute/virtualMachines/extensions",
    "name": "<parentVmResource>/OMSExtension",
    "apiVersion": "[variables('apiVersion')]",
    "location": "[resourceGroup().location]",
    "dependsOn": [
        "[concat('Microsoft.Compute/virtualMachines/', variables('vmName'))]"
    ],
    "properties": {
        "publisher": "Microsoft.EnterpriseCloud.Monitoring",
        "type": "MicrosoftMonitoringAgent",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": {
            "workspaceId": "myWorkSpaceId"
        },
        "protectedSettings": {
            "workspaceKey": "myWorkspaceKey"
        }
    }
}

PowerShell 部署

Set-AzVMExtension 命令可用于将 Log Analytics 代理 VM 扩展部署到现有的 VM。 运行该命令之前，请将公共和专用配置存储在 PowerShell 哈希表中。

$PublicSettings = @{"workspaceId" = "myWorkspaceId"}
$ProtectedSettings = @{"workspaceKey" = "myWorkspaceKey"}

Set-AzVMExtension -ExtensionName "MicrosoftMonitoringAgent" `
    -ResourceGroupName "myResourceGroup" `
    -VMName "myVM" `
    -Publisher "Microsoft.EnterpriseCloud.Monitoring" `
    -ExtensionType "MicrosoftMonitoringAgent" `
    -TypeHandlerVersion 1.0 `
    -Settings $PublicSettings `
    -ProtectedSettings $ProtectedSettings `
    -Location ChinaNorth 

排查问题

下面是有关如何排查部署问题的一些建议。

查看扩展状态

在 Azure 门户中通过使用 PowerShell 或 Azure CLI 来检查扩展部署的状态。

若要查看给定 VM 的扩展部署状态，请运行以下命令。

• Azure PowerShell：

  Get-AzVMExtension -ResourceGroupName <myResourceGroup> -VMName <myVM> -Name <myExtensionName>
  

• Azure CLI：

  az vm get-instance-view --resource-group <myResourceGroup> --name <myVM> --query "instanceView.extensions"
  

查看输出日志

请在 C:\WindowsAzure\Logs\Plugins\Microsoft.EnterpriseCloud.Monitoring.MicrosoftMonitoringAgent\ 下查看适用于 Windows 的 Log Analytics 代理 VM 扩展的输出日志。

获取支持

如果对本文中的任何观点存在疑问，可以联系 Azure 支持上的 Azure 专家。 或者，你也可以提出 Azure 支持事件。 请转到 Azure 支持站点提交请求。 有关使用 Azure 支持的信息，请阅读 Azure 支持常见问题。