Can't get template-parameters-definition.json to expose Synapse parameters

Question

Hello. I am new to this so please go easy.

I want to be able to customise a couple of parameters when I deploy my Synapse workspace artifacts to another environment. I understand the way to do this is the template-parameters-definition.json in the collaboration branch which will then expose parameters in the TemplateParametersForWorkspace.json file in the workspace_publish branch.

However so far nothing is working, I add the below code in my template-parameters-definition.json file as I want to be able to customise my two spark configuration values when this gets deployed to other environments. But once I publish the collaboration branch, the TemplateParametersForWorkspace.json file remains exactly the same.

{
    "Microsoft.Synapse/workspaces/sparkConfigurations": {
        "properties": {
            "configs": {
                    "*": "="
            }
        }
    }
}

I've even tried it with simpler code (to make sure it wasn't a problem specifically with sparkconfigurations) that I've stolen directly from helpful guide pages like below but still it makes no difference to the TemplateParametersForWorkspace file when deployed

{
    "Microsoft.Synapse/workspaces/notebooks": {
        "properties": {
            "bigDataPool": {
                "referenceName": "="
            }
        }
    }
}

Any help would be appreciated with this.

Many thanks

Adam

Answer 1

Hi Adam Peel ,

Welcome to Microsoft Q&A platform and thanks for posting your question here.

As per my understanding, you are trying to customize the parameters for the deployment process in Synapse .

You can use custom parameter template if you want to change some properties during deployment, but the properties aren't parameterized by default, you can override the default parameter template by creating a custom parameter template.

Below are the helpful resources you can leverage for this requirement:

Create custom parameters in the workspace template

Azure Synapse Analytics CI/CD with Custom Parameters - Made Easy!

CICD Automation in Synapse Analytics: taking advantage of custom parameters in Workspace Templates

Synapse CI/CD: Using a custom parameter template

Hope it helps. Kindly accept the answer by clicking on Accept answerbutton . Thankyou.