使用Azure Devops Pipeline将标签带有空格传递到ARM模板

问题描述

我正在使用Azure DevOps Pipelines部署ARM模板。我的模板有一个我使用AzureResourceManagerTemplateDeployment@3传递到管道的标签参数。

我的ARM模板在parameters部分中有一个值作为对象。 tags是一个对象，这是许多示例模板显示的内容：

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#","contentVersion": "1.0.0.0","parameters": {
    "resourceName": {
      "type": "string","Metadata": {
        "description": "Specifies the name of the resource,including its prefix."
      }
    },"tags": {
      "type": "object","defaultValue": {
        "Cost Center": "Admin"
      }
    }
  },"resources": [
    {
      "apiVersion": "2019-06-01","kind": "StorageV2","location": "[resourceGroup().location]","name": "[parameters('resourceName')]","properties": {
        "supportsHttpsTrafficOnly": true
      },"sku": {
        "name": "Standard_lrs"
      },"type": "Microsoft.Storage/storageAccounts","tags": "[parameters('tags')]"
    }
  ]
}

[已编辑，以匹配后面的线程]

我正在将ubuntu-latest用于我的游泳池。标签可能有空格。

在为简单起见的管道中，我将标签设置为变量。

pool:
  vmImage: 'ubuntu-latest'
variables:
  - name: tags
    value: ("Location Region=West US 2" "Environment=${{ parameters.environment }}")

调用模板部署时，我将标签作为overrideParameters

传递

  - task: AzureResourceManagerTemplateDeployment@3
    displayName: "Deploy my templateaccount"
    inputs:
      deploymentScope: 'Resource Group'
      azureResourceManagerConnection: 'ResourceManager-connection'
      subscriptionId: ${{ parameters.subscriptionid }}
      action: 'Create Or Update Resource Group'
      resourceGroupName: '$(resourceGroupName)'
      location: '${{ parameters.location }}'
      templateLocation: 'Linked artifact'
      csmFile: 'mytemplatelocation/azuredeploy.json'
      overrideParameters: -resourceName abcdefg76534 -tags "$(tags)"
      deploymentMode: 'Incremental'
      deploymentOutputs: resourceOutput
  - pwsh: Write-Output '$(resourceOutput)'

到目前为止，我还不了解Ubuntu上的AzureResourceManagerTemplateDeployment@3如何期望标签被发送。

在每种情况下，模板都无法部署。

Azure DevOps Pipeline是否支持此方案？

有人提出建议吗？

解决方法

在Azure DevOps管道AzureResourceManagerTemplateDeployment@3中工作的标签的格式是将JSON用于ARM模板对象，例如标签。

左花括号，用冒号分隔键值对，并用逗号分隔标签。
在我的案例中，每个键和值都用引号引起来。
右花括号。

但是，以下模板通过传入JSON对象来工作：{"Cost Center":"DevTest","Location":"West US"}作为模板参数。在上下文中，这看起来像：

- task: AzureResourceManagerTemplateDeployment@3
  inputs:
    deploymentScope: 'Resource Group'
    azureResourceManagerConnection: 'ResourceManager-connection'
    subscriptionId: 'XXXXX'
    action: 'Create Or Update Resource Group'
    resourceGroupName: 'rg-wus2-exampletest'
    location: 'West US 2'
    templateLocation: 'Linked artifact'
    csmFile: 'storageaccount/example.azuredeploy.json'
    csmParametersFile: 'storageaccount/azuredeploy.parameters.json'
    overrideParameters: '-resourceName oweruhsow -resourceTags {"Cost Center":"DevTest","Location":"West US"}'
    deploymentMode: 'Complete'

此管道模块期望使用JSON对象，而不是通过命令行部署PowerShell（https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resource）所使用的其他格式。

另外，作为其他说明，其他帖子也建议您使用tags以外的名称作为标签参数。对我有用的是resourceTags。这是我的ARM模板：

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#","contentVersion": "1.0.0.0","parameters": {
    "resourceName": {
      "type": "string","metadata": {
        "description": "Specifies the name of the resource"
      }
    },"location": {
      "type": "string","defaultValue": "[resourceGroup().location]","metadata": {
        "description": "Location for the resources."
      }
    },"resourceTags": {
      "type": "object","defaultValue": {
        "Cost Center": "Admin"
      }
    }
  },"resources": [
    {
      "apiVersion": "2019-06-01","kind": "StorageV2","location": "[parameters('location')]","name": "[parameters('resourceName')]","properties": {
        "supportsHttpsTrafficOnly": true
      },"sku": {
        "name": "Standard_LRS"
      },"type": "Microsoft.Storage/storageAccounts","tags": "[parameters('resourceTags')]"
    }
  ]
}

如果要将模板对象设置为变量，则可以使用DevOps变量（例如$(tags)）将其传入：

variables:
  tags: '{"Cost Center":"DevTest","Location":"West US"}'
steps:
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
    deploymentScope: 'Resource Group'
    azureResourceManagerConnection: 'ResourceManager-connection'
    subscriptionId: '9f241d6e-16e2-4b2b-a485-cc546f04799b'
    action: 'Create Or Update Resource Group'
    resourceGroupName: 'rg-wus2-exampletest'
    location: 'West US 2'
    templateLocation: 'Linked artifact'
    csmFile: 'storageaccount/example.azuredeploy.json'
    csmParametersFile: 'storageaccount/azuredeploy.parameters.json'
    overrideParameters: '-resourceName oweruhso11w -resourceTags $(tags)'
    deploymentMode: 'Complete'

（作为旁注）由于某种原因，该模块需要具有csmParametersFile，否则它将因所有大写字母RESOURCEGROUP失败而失败。从命令行部署不需要param文件，但是Pipelines模块似乎确实需要它。一个csmParamters文件，几乎没有任何内容，但似乎是必需的。

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#","parameters": { }
  }

这也可以使用pool image: windows-latest

非常感谢https://github.com/MicrosoftDocs/azure-devops-docs/issues/9051

中的ToMakesSense ,

如果您使用的参数值包含多个单词，即使您使用变量传递它们，也请用引号引起来。

例如，-name“参数值” -name2“ $（变量）”。

尝试使用以下格式：

overrideParameters: -location "${{ parameters.location }}" -tags "$(tags)"

更多详细信息，请参阅此处的官方文档-Azure Resource Group Deployment task

azure azure azure-devops