OverrideArmParameters with Synapse workspace deployment@2

Question

OverrideArmParameters with Synapse workspace deployment@2

Mathias Opland 155

I'm trying to deploy a synapse workspace to a Prod environment, overriding parameters (such as linkedServiceUrls etc.). I have got it working using a template-parameters-definition.json file to make the parameters I want available for overriding, and the following task for deployment:

However, I see that down the road, the parameters list for overriding will grow a lot, so having the parameters inline in the deployment pipeline will be really ugly. I've seen some documentation that states that the "OverrideArmParameters" input can be a path to a .yaml file containing the parameters that should be overrided, however this does not seem to work for me. Any input on how this should be configured?

pipeline:

yaml file:
User's image

I've ensured that the path of the yaml file is correct by printing the content in a pwsh task.

Mathias Opland 155 Reputation points

2023-10-09T11:51:27.7733333+00:00

A related question:
Why is both LinkedServiceName and Location URL required for tables in a Lake Database? Wouldn't the linked service point to the correct storage account, and it should not be necessary to provide a full location link to the storage account as well?
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-09T18:47:11.37+00:00
Hello Mathias Opland,

My understanding is you are using Github actions here.

Are the override Arm parameters not working for any linked service or only for a specific linked service?

If the override parameters are not working, it could be an issue with the parameters template definition file.

Please check this reference document

also; please check the path of OverridArmparamters in your workspace template.

OverrideArmParameters: './path of the parameters.yaml'

Please see the below reference document.

https://github.com/MicrosoftDocs/azure-docs/blob/main/articles/synapse-analytics/cicd/continuous-integration-delivery.md#set-up-a-release-in-github-actions
Mathias Opland 155 Reputation points

2023-10-09T19:13:23.93+00:00

Hi @Bhargava-MSFT , thanks for your response! I’m using Azure DevOps, and it’s related to all parameters I’m trying to override. When overriding them with a in-line parameter list it works fine, however when using a .yaml file, the default values are not overrided. Is there a special way to reference the path or set up the .yaml file? I’m using the same path reference as I’m using for other template references (.bicep files, .ps1 files etc) in other deploy tasks.
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-09T20:10:11.5433333+00:00

Thanks for the details.

If you are using AzureDevops, My understanding is that overrideParamters are in the JSON format when using the "validate and deploy" operation to deploy the workspace.

"I've seen some documentation that states that the "OverrideArmParameters" input can be a path to a .yaml file containing the parameters that should be overrides,"

Based on your statement above, can you please provide me with the reference document you are discussing here? So that I will do further research and get back to you.
Mathias Opland 155 Reputation points

2023-10-09T20:32:18.21+00:00

Hi @Bhargava-MSFT I’ve read it here I think:

https://learn.microsoft.com/en-us/azure/synapse-analytics/cicd/continuous-integration-delivery#create-custom-parameters-in-the-workspace-template

But it was only referenced in the same way you described it:

I was not aware that it could be a difference between using GitHub actions and Azure DevOps pipelines. If so, json is fine. Do you have any documentation for json setup?

Thanks for your help!

regards,

Mathias
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-09T23:30:23.7233333+00:00

GitHub actions are different from the Azuredevops release pipeline.

When using AzureDevOps, you will use either the ARM template deployment task or the Synapse deployment task in your release pipeline.

For the synapse deployment task, please see this video tutorial explaining how to use the "Template-paramters-definition.json" file in the release pipeline. To use the custom parameters template, you need to create the Json file with the exact name on the root folder of the collaboration branch.

I hope this helps. Please let me know if you have any further questions.
Mathias Opland 155 Reputation points

2023-10-10T07:14:15.63+00:00

Hi @Bhargava-MSFT , thank you for your help. The part regarding "Template-parameters-definition.json" I managed to get right, so I have the parameters I need available for overriding. When I do it like this, it works:

However, I want to do it like this:

with parameters-file.yaml like this:

This does not work. Any tips?
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-11T16:40:13.8366667+00:00

Hello Mathias Opland,

I am checking to see if you have any further questions here.
Mathias Opland 155 Reputation points

2023-10-11T16:50:04.18+00:00

H, @Bhargava-MSFT

No, thanks! That clarifies why I have not got it working. I’m unfortunately not able to switch to GitHub atm, so will have to find another solution. Thanks for your help!

regards,

Mathias
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-11T17:19:37.1566667+00:00

Thank you, Mathias Opland

If you don't have any further questions, please consider accepting the answer by hitting the Accept answer and up-vote as it helps the community look for answers to similar questions.
shashank br 0 Reputation points

2025-05-12T11:09:07.99+00:00

Hi @Mathias Opland

I too am trying to override using a parameter file may it be json or yaml.

were you able to configure ? Please do help me out if any of your findings have worked.

Accepted answer

2 additional answers

Your answer

Mathias Opland 155 Reputation points

2023-10-09T11:51:27.7733333+00:00

A related question:
Why is both LinkedServiceName and Location URL required for tables in a Lake Database? Wouldn't the linked service point to the correct storage account, and it should not be necessary to provide a full location link to the storage account as well?
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-09T18:47:11.37+00:00

Hello Mathias Opland,

My understanding is you are using Github actions here.

Are the override Arm parameters not working for any linked service or only for a specific linked service?

If the override parameters are not working, it could be an issue with the parameters template definition file.

Please check this reference document

also; please check the path of OverridArmparamters in your workspace template.

OverrideArmParameters: './path of the parameters.yaml'

Please see the below reference document.

https://github.com/MicrosoftDocs/azure-docs/blob/main/articles/synapse-analytics/cicd/continuous-integration-delivery.md#set-up-a-release-in-github-actions
Mathias Opland 155 Reputation points

2023-10-09T19:13:23.93+00:00

Hi @Bhargava-MSFT , thanks for your response! I’m using Azure DevOps, and it’s related to all parameters I’m trying to override. When overriding them with a in-line parameter list it works fine, however when using a .yaml file, the default values are not overrided. Is there a special way to reference the path or set up the .yaml file? I’m using the same path reference as I’m using for other template references (.bicep files, .ps1 files etc) in other deploy tasks.
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-09T20:10:11.5433333+00:00

Thanks for the details.

If you are using AzureDevops, My understanding is that overrideParamters are in the JSON format when using the "validate and deploy" operation to deploy the workspace.

"I've seen some documentation that states that the "OverrideArmParameters" input can be a path to a .yaml file containing the parameters that should be overrides,"

Based on your statement above, can you please provide me with the reference document you are discussing here? So that I will do further research and get back to you.
Mathias Opland 155 Reputation points

2023-10-09T20:32:18.21+00:00

Hi @Bhargava-MSFT I’ve read it here I think:

https://learn.microsoft.com/en-us/azure/synapse-analytics/cicd/continuous-integration-delivery#create-custom-parameters-in-the-workspace-template

But it was only referenced in the same way you described it:

I was not aware that it could be a difference between using GitHub actions and Azure DevOps pipelines. If so, json is fine. Do you have any documentation for json setup?

Thanks for your help!

regards,

Mathias
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-09T23:30:23.7233333+00:00

GitHub actions are different from the Azuredevops release pipeline.

When using AzureDevOps, you will use either the ARM template deployment task or the Synapse deployment task in your release pipeline.

For the synapse deployment task, please see this video tutorial explaining how to use the "Template-paramters-definition.json" file in the release pipeline. To use the custom parameters template, you need to create the Json file with the exact name on the root folder of the collaboration branch.

I hope this helps. Please let me know if you have any further questions.
Mathias Opland 155 Reputation points

2023-10-10T07:14:15.63+00:00

Hi @Bhargava-MSFT , thank you for your help. The part regarding "Template-parameters-definition.json" I managed to get right, so I have the parameters I need available for overriding. When I do it like this, it works:

However, I want to do it like this:

with parameters-file.yaml like this:

This does not work. Any tips?
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-11T16:40:13.8366667+00:00

Hello Mathias Opland,

I am checking to see if you have any further questions here.
Mathias Opland 155 Reputation points

2023-10-11T16:50:04.18+00:00

H, @Bhargava-MSFT

No, thanks! That clarifies why I have not got it working. I’m unfortunately not able to switch to GitHub atm, so will have to find another solution. Thanks for your help!

regards,

Mathias
Bhargava-MSFT 31,246 Reputation points Microsoft Employee Moderator

2023-10-11T17:19:37.1566667+00:00

Thank you, Mathias Opland

If you don't have any further questions, please consider accepting the answer by hitting the Accept answer and up-vote as it helps the community look for answers to similar questions.
shashank br 0 Reputation points

2025-05-12T11:09:07.99+00:00

Hi @Mathias Opland

I too am trying to override using a parameter file may it be json or yaml.

were you able to configure ? Please do help me out if any of your findings have worked.

Answer 1

Bhargava-MSFT 31,246 Microsoft Employee Moderator

Since you are using Azure Devops, you need to pass each parameter on the Overridearmparameters section.

Please see the below screenshot for your reference.

User's image

If you use Github actions, you can pass the './path of the parameters.yaml' in the OverrideArmParameters section(as mentioned in the document)

I hope this clarifies your question.

Please let me know if you have any further questions.

Answer 2

Mathias Opland 155

Hi Avi Bhardwaj, see my comment above:

"However, I've also learned that one can pass a text file as parameter and parse it as a string when inputing to the deployment module."
So YAML is not a valid parameter override format, but string is.

Answer 3

Nikola Branković 0

@Mathias Opland What was your solution for this?

Kind Regards
Nikola

Mathias Opland 155 Reputation points

2024-02-02T10:35:07.5166667+00:00

Hi, the solution we went for was to download the template files in the deploy pipeline and replace environment specific variables using search and replace. This way, we didn't have to add parameters if we ex. added a new pipeline with a storage account reference.

However, I've also learned that one can pass a text file as parameter and parse it as a string when inputing to the deployment module.

I hope this helps!

Regard,
Mathias
Abhishek Danalakota 0 Reputation points

2024-02-24T01:45:02.42+00:00

Hi Mathias, Have you able to resolve the issue?

I am not able to change the parameter values of my dev environment to deploy onto prod environment.

Kind regards, Abhishek
Avi Bhardwaj 0 Reputation points Microsoft Employee

2024-05-28T08:14:42.6166667+00:00

@Mathias Opland I was not able to override the parameters using YML file, I'm using a file with values as per screenshot.

Anything I'm missing?
Mathias Opland 155 Reputation points

2024-05-28T08:56:37.3933333+00:00

Hi Avi Bhardwaj, see my comment above:

"However, I've also learned that one can pass a text file as parameter and parse it as a string when inputing to the deployment module." So YAML is not a valid parameter override format, but string is.

Share via

OverrideArmParameters with Synapse workspace deployment@2

2 additional answers

Your answer