在已启用 Azure Arc 的 Windows 服务器上安装和管理 Azure 文件同步代理扩展

本文介绍如何在已启用 Azure Arc 的 Windows 服务器上安装、验证和卸载 Azure 文件同步代理扩展。 用于 Windows 的 Azure 文件同步代理扩展在通过 Azure Arc 连接的 Windows 服务器上部署 Azure 文件同步代理，使服务器能够将文件与 Azure 文件共享同步。 该扩展由Microsoft发布，可以使用 Azure 门户、Azure PowerShell 或 Azure CLI 进行管理。

先决条件

• 已启用 Azure Arc 的服务器（仅限 Windows）： 目标计算机必须连接到 Azure Arc（已安装并载入已完成的 Azure Connected Machine 代理），并运行受支持的 Windows Server OS。 Windows Server 2016 及更高版本支持 Azure 文件同步扩展。 仅支持 RTM 版本。 有关受支持的版本的详细信息，请参阅 Azure 文件同步系统要求和互作性 。

  重要

  Azure 文件同步代理扩展 仅在 Windows 上受支持。 Azure 文件同步不支持已启用 Linux Arc 的服务器。

• 已启用 Arc 的服务器 必须安装Microsoft根证书（Microsoft根证书颁发机构 2011）。 有关更多详细信息，请参阅 本文档。

• Azure 资源： 安装代理后，Azure 订阅中应存在 Azure 存储同步服务 来注册服务器。 （安装 前 无需注册服务器，但需要将其注册到存储同步服务以开始同步。后续 步骤对此进行了介绍。

• Azure PowerShell 或 Azure CLI 环境：

  • 对于 Azure PowerShell，请使用 Az.ConnectedMachine 模块安装 Azure PowerShell 模块（Az 模块）。 确保已安装最新的 Az PowerShell，并运行 Connect-AzAccount 以登录到 Azure。

  • 对于 Azure CLI，请安装 Azure CLI 并登录（az login）。 确保 Azure CLI 已安装连接机器扩展，可以通过运行以下命令：

    az extension add --name connectedmachine
    

    Connected Machine 扩展提供了你需要的az connectedmachine命令。

• 网络连接： 服务器必须有权访问 Azure Arc 和 Azure 文件同步所需的 Azure 终结点（例如，下载扩展并访问 Azure 文件同步服务终结点）。 确保防火墙或代理设置允许必要的 Azure 服务 URL。 有关详细信息，请参阅 Azure 文件同步代理和防火墙设置 。

安装代理扩展

可以使用 Azure 门户、Azure PowerShell 或 Azure CLI 在已启用 Arc 的 Windows 服务器上安装 适用于 Windows 的 Azure 文件同步代理 。

$Settings = @{
  EnableAgentAutoUpdate = "true"
  AutoUpdateScheduledDayOfWeek = "Monday"
  AutoUpdateScheduledHourOfDay = 05
  EnableServerDiagnostics = "true"
  AgentInstallDir = "C:\Custom Path\AFS"
  EnrollInMicrosoftUpdate = "true"
}

New-AzConnectedMachineExtension `
  -ResourceGroupName <resource-group-name> `
  -MachineName <machine-name> `
  -Name AzureFileSyncExtension `
  -SubscriptionId <subscriptionId> `
  -Location <region> `
  -TypeHandlerVersion <version> `
  -Publisher Microsoft.StorageSync `
  -ExtensionType AzureFileSyncExtension `
  -Settings $settings

$Settings = @{
  EnableAgentAutoUpdate = "true"
  AutoUpdateScheduledDayOfWeek = "Monday"
  AutoUpdateScheduledHourOfDay = 05
  EnableServerDiagnostics = "true"
  AgentInstallDir = "C:\Custom Path\AFS"
  EnrollInMicrosoftUpdate = "true"
  UseCustomProxy = "true"
  ProxyAddress = "http://proxy.contoso.com"
  ProxyPort = 1009
  ProxyAuthRequired = "true"
  ProxyUsername = "myuser"
}

$protectedSettings =@{
  ProxyPassword = "your_proxy_password"
}

New-AzConnectedMachineExtension `
  -ResourceGroupName <resource-group-name> `
  -MachineName <machine-name> `
  -Name AzureFileSyncExtension `
  -SubscriptionId <subscriptionId> `
  -Location <region> `
  -TypeHandlerVersion <version> `
  -Publisher Microsoft.StorageSync `
  -ExtensionType AzureFileSyncExtension `
  -Settings $settings `
  -ProtectedSetting $protectedSettings

{
  "EnableAgentAutoUpdate": "true",
  "AutoUpdateScheduledDayOfWeek": "Monday",
  "AutoUpdateScheduledHourOfDay": 5,
  "EnableServerDiagnostics": "true",
  "AgentInstallDir": "C:\\Custom Path\\AFS",
  "EnrollInMicrosoftUpdate": "true",
  "UseCustomProxy": "true",
  "ProxyAddress": "http://proxy.contoso.com",
  "ProxyPort": 1009,
  "ProxyAuthRequired": "true",
  "ProxyUsername": "your_username"
}

{
  "ProxyPassword": "your_proxy_password"
}

az connectedmachine extension create \
  --name AzureFileSyncAgentExtension \
  --machine-name <machine> \
  --resource-group <machine rg> \
  --publisher Microsoft.StorageSync \
  --type AzureFileSyncAgentExtension \
  --settings "afs_settings.json" \
  --protected-settings "afs_pwd.json"

使用 ARM 模板进行安装

还可以使用 Azure 资源管理器 （ARM） 模板将 Azure 文件同步代理扩展部署到已启用 Arc 的 Windows 服务器。 此方法适用于自动化或大规模部署。

1.准备参数文件

创建一个文件parameters.json，并包括您的自定义详细信息，如 VM 名称和扩展设置：

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "AgentInstallDir": { "value": "C:\\Program Files\\Azure\\StorageSyncAgent\\" },
    "UseCustomProxy": { "value": true },
    "ProxyAddress": { "value": "http://proxy.contoso.com" },
    "ProxyPort": { "value": "80" },
    "ProxyAuthRequired": { "value": true },
    "ProxyUserName": { "value": "ProxyUserName" },
    "ProxyPassword": { "value": "ProxyPassword" },
    "EnrollInMicrosoftUpdate": { "value": true },
    "EnableAgentAutoUpdate": { "value": true },
    "AutoUpdateScheduledDayOfWeek": { "value": "Monday" },
    "AutoUpdateScheduledHourOfDay": { "value": "23" },
    "EnableServerDiagnostics": { "value": true },
    "vmName": { "value": "ArcVM1" },
    "location": { "value": "eastus2euap" }
  }
}

2.准备模板文件

按此处所示创建 template.json 文件。 此模板定义扩展资源并将参数映射到扩展设置：

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "0.43.0.0",
  "parameters": {
    "vmName": { "type": "string" },
    "location": { "type": "string" },
    "agentInstallDir": { "type": "string", "defaultValue": "C:\\Program Files\\Azure\\StorageSyncAgent\\" },
    "useCustomProxy": { "type": "bool", "defaultValue": false },
    "proxyAddress": { "type": "string", "defaultValue": "" },
    "proxyPort": { "type": "string", "defaultValue": "0" },
    "proxyAuthRequired": { "type": "bool", "defaultValue": false },
    "proxyUsername": { "type": "string", "defaultValue": "" },
    "proxyPassword": { "type": "securestring", "defaultValue": "" },
    "enrollInMicrosoftUpdate": { "type": "bool", "defaultValue": true },
    "enableAgentAutoUpdate": { "type": "bool", "defaultValue": false },
    "autoUpdateScheduledDayOfWeek": { "type": "string", "defaultValue": "Tuesday" },
    "autoUpdateScheduledHourOfDay": { "type": "string", "defaultValue": "18" },
    "enableServerDiagnostics": { "type": "bool", "defaultValue": true }
  },
  "variables": {
    "AgentInstallDir": "[parameters('agentInstallDir')]",
    "UseCustomProxy": "[parameters('useCustomProxy')]",
    "ProxyAddress": "[parameters('proxyAddress')]",
    "ProxyPort": "[int(parameters('proxyPort'))]",
    "ProxyAuthRequired": "[parameters('proxyAuthRequired')]",
    "ProxyUserName": "[parameters('proxyUserName')]",
    "ProxyPassword": "[parameters('proxyPassword')]",
    "EnrollInMicrosoftUpdate": "[parameters('enrollInMicrosoftUpdate')]",
    "EnableAgentAutoUpdate": "[parameters('enableAgentAutoUpdate')]",
    "AutoUpdateScheduledDayOfWeek": "[parameters('autoUpdateScheduledDayOfWeek')]",
    "AutoUpdateScheduledHourOfDay": "[parameters('autoUpdateScheduledHourOfDay')]",
    "EnableServerDiagnostics": "[parameters('enableServerDiagnostics')]"
  },
  "resources": [
    {
      "name": "[concat(parameters('vmName'),'/AzureFileSyncAgentExtension')]",
      "type": "Microsoft.HybridCompute/machines/extensions",
      "location": "[parameters('location')]",
      "apiVersion": "2021-05-20",
      "properties": {
        "publisher": "Microsoft.StorageSync",
        "type": "AzureFileSyncAgentExtension",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": {
          "agentInstallDir": "[variables('AgentInstallDir')]",
          "useCustomProxy": "[variables('UseCustomProxy')]",
          "proxyAddress": "[variables('ProxyAddress')]",
          "proxyPort": "[variables('ProxyPort')]",
          "proxyAuthRequired": "[variables('ProxyAuthRequired')]",
          "proxyUsername": "[variables('ProxyUserName')]",
          "enrollInMicrosoftUpdate": "[variables('EnrollInMicrosoftUpdate')]",
          "enableAgentAutoUpdate": "[variables('EnableAgentAutoUpdate')]",
          "autoUpdateScheduledDayOfWeek": "[variables('AutoUpdateScheduledDayOfWeek')]",
          "autoUpdateScheduledHourOfDay": "[variables('AutoUpdateScheduledHourOfDay')]",
          "enableServerDiagnostics": "[variables('EnableServerDiagnostics')]"
        },
        "protectedSettings": {
          "proxyPassword": "[parameters('proxyPassword')]"
        }
      }
    }
  ]
}

3.部署模板

使用以下 PowerShell 命令将模板部署到资源组：

New-AzResourceGroupDeployment -ResourceGroupName "<ResourceGroupName>" -TemplateFile "template.json" -TemplateParameterFile "parameters.json"

将 <ResourceGroupName> 替换为包含已启用 Arc 的计算机的资源组的名称。 这将使用指定的设置将 Azure 文件同步代理扩展部署到已启用 Arc 的目标 Windows 服务器。

可用设置

可以在安装 Azure 文件同步代理扩展期间配置以下设置：

如果 Azure Arc 计算机已安装 Azure 文件同步代理，该扩展将成功安装，并且不会修改计算机上安装的现有 Azure 文件同步代理。

验证安装

安装后，请验证是否已成功部署 Azure 文件同步代理扩展，以及代理是否在服务器上运行。

Get-AzConnectedMachineExtension `
  -ResourceGroupName <resource-group-name> `
  -MachineName <machine-name> `
  -Name <EXTENSION_NAME>

az connectedmachine extension show \
  --resource-group "<resource-group-name>" \
  --machine-name "<machine-name>" \
  --name "<EXTENSION_NAME>"

输出将包含有关扩展的信息，例如其 provisioningState （如果代理安装正确时应 成功 ）、 类型 （扩展类型名称）和 typeHandlerVersion （指示已安装的 Azure 文件同步代理的版本）。 验证预配状态是否成功，并且报告的版本是否与预期的代理版本匹配。 如果未列出扩展或状态不是成功，请查看输出中的或 Azure 门户中的错误详细信息以进行故障排除。

后续步骤

安装扩展后，应在 Arc 计算机上安装 Azure 文件同步代理。 但是，若要在计算机上安装 Azure 文件同步，需要完成以下步骤。

• 将服务器注册到 Azure 文件同步： 安装代理只是第一步。 若要开始同步文件，必须将 Windows Server 注册 到 Azure 存储同步服务 ，才能在服务器与 Azure 文件同步之间建立信任。按照 使用 Azure 文件同步管理已注册的服务器（注册/注销服务器） 中的步骤注册服务器（如果尚未注册服务器）。

• 创建同步组和云终结点： 注册后，在存储同步服务中创建 同步组 。 同步组将 Azure 文件共享（云终结点）和已注册服务器（服务器终结点）上的文件夹链接。 有关如何设置存储同步服务、创建同步组和添加服务器终结点的端到端指南，请参阅 如何部署 Azure 文件同步 。

• 了解详细信息和故障排除： 有关详细信息，请参阅 规划 Azure 文件同步部署 以了解要求和最佳做法。 如果在安装或服务器注册过程中遇到问题，请参阅 排查 Azure 文件同步代理安装和注册 的常见问题和解决方案。

卸载代理扩展

如果不再需要特定已启用 Arc 的服务器上的 Azure 文件同步代理扩展，可以使用 Azure 门户、Azure PowerShell 或 Azure CLI 卸载该扩展。 卸载扩展 不会 从服务器中删除 Azure 文件同步代理。

删除 Azure 文件同步代理将停止该服务器上的任何云同步。 如果服务器当前已注册到存储同步服务并参与同步组，则卸载代理将中断同步连接和文件同步拓扑。 如果决定删除 Arc 计算机上的代理，请确保查看 取消预配或删除 Azure 文件同步服务器终结点 ，以获取有关卸载 Azure 文件同步代理的详细说明。

Remove-AzConnectedMachineExtension `
  -MachineName <machine-name> `
  -ResourceGroupName <resource-group-name> `
  -Name <EXTENSION_NAME>

az connectedmachine extension delete \
  --machine-name "<machine-name>" \
  --resource-group "<resource-group-name>" \
  --name "<EXTENSION_NAME>"

可以通过检查 Azure 门户中的 “扩展 ”列表（不应再显示扩展）或运行上述验证命令（不应再找到扩展）来验证删除。 如果扩展无法卸载，请检查 Azure 活动日志或扩展实例视图以了解错误详细信息。