假设我们有这个简化的 Azure 二头肌模板,其中包含我们想要在每个公司上修改的参数, 每个环境,我们可能有数十家公司,每个公司有 4 - 6 个环境。我不想把所有 每个排列中的参数,理想情况下,大多数公司将使用模板中的默认值,并且仅覆盖 他们的公司名称适用于所有环境,并且在非生产环境中,可能仅覆盖环境名称和环境大小。
/path/to/baseline/deployments/test-template.bicep
param companyName string // No default - Specify in common.parameters.json
param environmentName string = 'Sandbox' // Override in both common.parameters.json as 'Production'; in development.parameters.json as 'Development'
param environmentSize string = 'Large' // Override in only development.parameters.json as 'Small'
param outputFormat string = 'JSON' // No need to overide
output companyName string = companyName
output environmentName string = environmentName
output environmentSize string = environmentSize
output outputFormat string = outputFormat
按照惯例,我们有一组通用参数,这些参数具有适合生产的值,但也意味着可以共享 所有其他环境 - 除非 - 我们希望该环境具有不同的值。因此,对于每个非生产 环境中,我们有一个与生产环境不同的参数子集。比如这两个例子。
/path/to/company-a/conf/common.parameters.json
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"companyName": {
"value": "CompanyA"
},
"environmentName": {
"value": "Production"
}
}
}
/path/to/company-a/conf/development.parameters.json
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"comments": "Development Parameters.",
},
"parameters": {
"environmentName": {
"value": "Development"
},
"environmentSize": {
"value": "Small"
}
}
}
使用 Azure CLI,我可以使用此命令将此模板部署到生产环境。注意这里我们指定一个 参数文件,因此定义的任何参数都将覆盖模板中的默认参数(如果指定)。
az deployment group create --name MyProductionDeployment \
--resource-group MyProductionResourceGroup \
--template-file /path/to/baseline/deployments/test-template.bicep \
--parameters @/path/to/company-a/conf/common.parameters.json
并得到这个输出
companyName: MyCompany // From common.parameters.json
environmentName: Production // From common.parameters.json
environmentSize: Large // From template default
outputFormat: JSON // From template default
然后我可以使用此命令将此模板部署到开发中。请注意,这里我们指定了两个参数文件, 当重复某个参数时,它会覆盖当时有效的任何值。
az deployment group create --name MyDevelopmentDeployment \
--resource-group MyDevelopmentResourceGroup \
--template-file /path/to/baseline/deployments/test-template.bicep \
--parameters @/path/to/company-a/conf/common.parameters.json \
--parameters @/path/to/company-a/conf/development.parameters.json
并得到这个输出
companyName: MyCompany // From common.parameters.json
environmentName: Development // From development.parameters.json (replaced value from common.parameters.json)
environmentSize: Small // From development.parameters.json
outputFormat: JSON // From template default
所以,这种行为正是我想要的,清晰直观。不幸的是,截至目前,PowerShell 等效项 Azure 部署函数不支持多个参数文件。我只能指定一个。所以,写出等价的 逻辑上,当需要多个参数文件时,我们需要将两个参数文件合并起来。
因此,对于生产环境,我们可以执行此操作并获得与 Azure CLI 相同的输出:
New-AzResourceGroupDeployment -Name MyProductionDeployment `
-ResourceGroupName MyProductionResourceGroup `
-TemplateFile \path\to\baseline\deployments\test-template.bicep `
-TemplateParameterFile \path\to\company-a\conf\common.parameters.json
但是,对于开发环境,由于我们无法指定两个文件,因此我需要首先合并两个 JSON 文件 并创建一个新的临时版本(在伪代码中显示)或将它们合并到某种类型的 HashTable 对象中 可以直接传递,不需要临时文件。
Merge-ARMParametersFiles -Common \path\to\company-a\conf\common.parameters.json `
-Override \path\to\company-a\conf\development.parameters.json `
-Result \tmp\combined.parameters.json
/tmp/combined.parameters.json(如果写入临时文件)
{
"$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"comments": "Combined Result.",
},
"parameters": {
"companyName": {
"value": "CompanyA"
},
"environmentName": {
"value": "Development"
},
"environmentSize": {
"value": "Small"
}
}
}
然后允许进行开发,再次为开发环境生成与上面相同的输出。请注意临时单个组合 JSON 属性文件。
New-AzResourceGroupDeployment -Name MyProductionDeployment `
-ResourceGroupName MyProductionResourceGroup `
-TemplateFile \path\to\baseline\deployments\test-template.bicep `
-TemplateParameterFile \tmp\combined.parameters.json
我已经了解了如何导入 common.parameters.json。我已经了解了如何组合两个哈希表。我似乎找不到 如何仅合并两个文件中的两个属性映射,然后将其写入一个新文件,这就是 我需要 PowerShell 专家的帮助。我认为这个问题很常见,令我惊讶的是没有找到 现有答案,因此发布以帮助他人和我自己!
$CommonParameters = Get-Content -Raw -Path \path\to\company-a\conf\common.parameters.json | ConvertFrom-Json
$OverrideParameters = Get-Content -Raw -Path \path\to\company-a\conf\development.parameters.json | ConvertFrom-Json
// How can I merge the two parameters sections, with any duplicates replaced with the override value, then write to
// the temp file?
最佳答案
将您的问题简化为本质:
- 给定两个 PSCustomObject 实例,将一个对象的某些属性合并并覆盖到另一个对象中...
$override.parameters.psobject.Properties | foreach-object {
$default.parameters | Add-Member `
-NotePropertyName $_.Name `
-NotePropertyValue $_.Value `
-Force;
}
请注意,这会发生变化 $default
而不是返回表示合并的新对象。
使用示例:
# set up some test data
$default = @"
{
"`$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"companyName": {
"value": "CompanyA"
},
"environmentName": {
"value": "Production"
}
}
}
"@ | ConvertFrom-Json
$override = @"
{
"`$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
"contentVersion": "1.0.0.0",
"metadata": {
"comments": "Development Parameters.",
},
"parameters": {
"environmentName": {
"value": "Development"
},
"environmentSize": {
"value": "Small"
}
}
}
"@ | ConvertFrom-Json
# override the default values and add any extra parameters
write-host "before = ";
write-host ($default | ConvertTo-Json);
#{
# "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
# "contentVersion": "1.0.0.0",
# "parameters": {
# "companyName": {
# "value": "CompanyA"
# },
# "environmentName": {
# "value": "Production"
# }
# }
#}
$override.parameters.psobject.Properties | foreach-object {
$default.parameters | Add-Member `
-NotePropertyName $_.Name `
-NotePropertyValue $_.Value `
-Force;
}
write-host "after = ";
write-host ($default | ConvertTo-Json);
#{
# "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
# "contentVersion": "1.0.0.0",
# "parameters": {
# "companyName": {
# "value": "CompanyA"
# },
# "environmentName": {
# "value": "Development"
# },
# "environmentSize": {
# "value": "Small"
# }
# }
#}
关于json - 如何合并两个 ARM 模板 JSON 参数文件并覆盖重复参数?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/74169527/