如何通过PowerShell命令删除Azure Data Factory全局参数

ARM模板默认使用增量部署模式，只会新增/更新模板中定义的配置项，不会删除目标环境中存在但模板未声明的配置，这是DEV删除参数后QA环境未同步移除的核心原因。不需要专门的全局参数删除权限，只要拥有ADF实例的写入权限即可通过PowerShell完成清理，操作步骤如下：

前置依赖 #

• 本地安装Az.DataFactory模块，执行安装命令：
  Install-Module -Name Az.DataFactory -Scope CurrentUser -Force -AllowClobber
• 确认账号拥有QA环境ADF实例的Microsoft.DataFactory/factories/write权限，提前收集好以下信息：QA环境租户ID、订阅ID、ADF所在资源组名称、ADF实例名称，如需和DEV全量对齐还要准备DEV环境对应ADF的资源组和实例名。

操作步骤 #

1. 登录Azure并切换到QA环境订阅上下文

# 登录指定租户
Connect-AzAccount -TenantId "<替换为QA环境租户ID>"
# 切换到QA所在订阅
Set-AzContext -SubscriptionId "<替换为QA环境订阅ID>"

2. 拉取QA环境ADF配置并备份现有全局参数，避免操作失误可回滚

$qaRgName = "<替换为QA环境ADF资源组名>"
$qaAdfName = "<替换为QA环境ADF实例名>"
# 获取QA环境ADF实例对象
$qaAdf = Get-AzDataFactoryV2 -ResourceGroupName $qaRgName -Name $qaAdfName
# 备份当前全局参数到本地文件
$qaAdf.GlobalParameters | ConvertTo-Json -Depth 10 | Out-File "./qa_adf_globalparam_backup_$(Get-Date -Format 'yyyyMMddHHmm').json"

3. 清理废弃参数，两种方式二选一即可

• 方式1：精确删除指定的残留参数

# 填入需要删除的废弃参数名称
$removeParamList = @("废弃参数1","废弃参数2")
foreach ($p in $removeParamList) {
    if ($qaAdf.GlobalParameters.ContainsKey($p)) {
        $qaAdf.GlobalParameters.Remove($p)
    }
}

• 方式2：全量对齐DEV环境当前的全局参数配置，自动清除所有DEV不存在的残留项

$devRgName = "<替换为DEV环境ADF资源组名>"
$devAdfName = "<替换为DEV环境ADF实例名>"
$devAdf = Get-AzDataFactoryV2 -ResourceGroupName $devRgName -Name $devAdfName
# 直接替换QA全局参数集合为DEV当前配置
$qaAdf.GlobalParameters = $devAdf.GlobalParameters

4. 提交更新到QA环境完成清理

Update-AzDataFactoryV2 -ResourceGroupName $qaRgName -Name $qaAdfName -GlobalParameter $qaAdf.GlobalParameters

注意事项 #

操作前请确认QA环境所有管道已经移除了对废弃参数的引用，否则清理后对应管道运行会抛出参数不存在的错误。操作完成后刷新QA环境ADF门户的全局参数页面，即可确认残留参数已被移除。如果操作失误，直接导入之前备份的JSON文件中的参数配置重新执行更新即可回滚。

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