Azure pipelines ARM deployment task YAML multiline

Question

Is it possible to use multiline in YAML in Azure Pipelines tasks? For instance for the ARM deployment task, there is an overrideParameters property. It would be nice if this could be split accross several lines instead of putting everything in one line:

- task: AzureResourceManagerTemplateDeployment@3
          displayName: 'ARM deploy MyFunctionAPP'
          inputs:
            deploymentScope: 'Resource Group'
            azureResourceManagerConnection: ${{ parameters.serviceConnection }}
            subscriptionId: ${{ parameters.subscriptionId }}
            action: 'Create Or Update Resource Group'
            resourceGroupName: ${{ parameters.resourceGroupName }}
            location: 'West Europe'
            templateLocation: 'Linked artifact'
            csmFile: '$(ARMtemplatesPath)\MyFunctionAPP\template.json'
            csmParametersFile: '$(ARMtemplatesPath)\MyFunctionAPP\parameters.json'
            deploymentMode: 'Incremental'
            overrideParameters: '-environment_name ${{ parameters.environmentName }} -vnetAddressPrefix ${{ parameters.vnetAddressPrefix }} -subnet1Prefix ${{ parameters.subnet1Prefix }} -APIkey ${{ parameters.APIkey }} -queueName ${{ parameters.queueNameMyQueue }} -SendGridAPIkey ${{ parameters.SendGridAPIkey }} -StorageConnectionAppSetting ${{ parameters.StorageConnectionAppSetting }}'

Is it somehow possible to split the overrideParameters values on multiple lines?

Actually I saw that post before answering this one and I have tried it and got errors on not being properly formatted. — Oliver Nilsen, Aug 03 '20 at 17:39
How about the issue? Does the answer below resolved your question, If not, would you please let me know the latest information about this issue? — Leo Liu-MSFT, Aug 05 '20 at 09:30

score 4 · Accepted Answer · answered Aug 07 '20 at 14:24

This has worked for me:

overrideParameters: >-
  -environment_name "${{ parameters.environmentName }}" 
  -vnetAddressPrefix "${{ parameters.vnetAddressPrefix }}" 
  -subnet1Prefix "${{ parameters.subnet1Prefix }}"
  -APIkey "${{ parameters.APIkey }}"
  -queueName "${{ parameters.queueNameMyQueue }}" 
  -SendGridAPIkey "${{ parameters.SendGridAPIkey }}"
  -StorageConnectionAppSetting "${{ parameters.StorageConnectionAppSetting }}"

So using >- on a single line and then using double-quotes to surround settings values works.

More inconsistent cryptic undocumented YAML. Oh well, it works. Where did you find this? — Nick.McDermaid, May 31 '22 at 10:45

score 2 · Answer 2 · answered Aug 04 '20 at 06:32

Is it somehow possible to split the overrideParameters values on multiple lines?

According to the document Expressions, we could use a pipe character (|) for multiline strings:

- task: AzureResourceManagerTemplateDeployment@3
          displayName: 'ARM deploy MyFunctionAPP'
          inputs:
            deploymentScope: 'Resource Group'
            azureResourceManagerConnection: ${{ parameters.serviceConnection }}
            subscriptionId: ${{ parameters.subscriptionId }}
            action: 'Create Or Update Resource Group'
            resourceGroupName: ${{ parameters.resourceGroupName }}
            location: 'West Europe'
            templateLocation: 'Linked artifact'
            csmFile: '$(ARMtemplatesPath)\MyFunctionAPP\template.json'
            csmParametersFile: '$(ARMtemplatesPath)\MyFunctionAPP\parameters.json'
            deploymentMode: 'Incremental'
            overrideParameters: |
             -environment_name ${{ parameters.environmentName }}
             -vnetAddressPrefix ${{ parameters.vnetAddressPrefix }}
             -subnet1Prefix ${{ parameters.subnet1Prefix }}
             -APIkey ${{ parameters.APIkey }}
             -queueName ${{ parameters.queueNameMyQueue }}
             -SendGridAPIkey ${{ parameters.SendGridAPIkey }}
             -StorageConnectionAppSetting ${{ parameters.StorageConnectionAppSetting }}

You could check this thread for some more details.

Azure pipelines ARM deployment task YAML multiline

2 Answers2

Linked