synapse deployment programatically using powershell

MrFlinstone 541

I would like to know if its possible to perform a synapse deployment using PowerShell programmatically. If one has the template files that is TemplateParametersForWorkspace.json and TemplateForWorkspace.json.

I have tried to use New-AzResourceGroupDeployment to no avail.

phemanth 10,165 Reputation points Microsoft Vendor

2024-03-11T07:09:40.81+00:00
@MrFlinstone

Thanks for reaching out to Microsoft Q&A.

deploying Synapse Workspace artifacts directly through code isn't currently possible. While Azure offers tools like DevOps pipelines and Github Actions for automated deployments, these solutions involve pre-built workflows.

Here's a breakdown of your options:

CI/CD Platforms:

Azure DevOps Pipelines: This is a popular choice. You can define pipelines that use tasks to interact with your Git repository and deploy artifacts (like Synapse notebooks, pipelines, etc.) to a target workspace. Here are some resources to get you started:

Video tutorial: https://m.youtube.com/watch?v=mbOvrQAUGUE

GitHub Actions: Similar to DevOps pipelines, you can configure workflows in your Github repository to deploy artifacts to your Synapse workspace.

refer:https://techcommunity.microsoft.com/t5/azure-synapse-analytics-blog/how-to-deploy-your-synapse-workspace-artifacts-to-a-managed-vnet/ba-p/2764232

https://techcommunity.microsoft.com/t5/azure-synapse-analytics-blog/automating-the-publishing-of-workspace-artifacts-in-synapse-cicd/ba-p/3603042

Alternative Approach: ARM Templates (Limited): While not directly deploying code, you can use ARM templates to manage some aspects of your Synapse workspace infrastructure. This might be helpful for provisioning resources like Data Explorer clusters. However, it's not ideal for deploying code artifacts themselves. You can find more information about ARM templates here: https://learn.microsoft.com/en-us/azure/azure-resource-manager/
phemanth 10,165 Reputation points Microsoft Vendor

2024-03-12T05:00:13.57+00:00

@MrFlinstone We haven’t heard from you on the last response and was just checking back to see if you have a resolution yet. In case if you have any resolution please do share that same with the community as it can be helpful to others. Otherwise, will respond with more details and we will try to help.

1 answer

Vinodh247 17,941 Reputation points

2024-03-05T14:30:05.2833333+00:00
Hi MrFlinstone,

Thanks for reaching out to Microsoft Q&A.

Using custom PS script:

./Create-AzSynapseWorkspace -ResourceGroupName "rg-name" -Name "synwssps" -Location "US East" -DefaultDataLakeStorageAccountName "storageaccount" -DefaultDataLakeStorageFilesystem "sfs" -AdminSqlLogin "admin" -AdminSqlPwd "passw"

For reference: https://github.com/techtalkcorner/AzSynapseAnalytics/blob/master/Scripts/PowerShell/Create-AzSynapseWorkspace.ps1

Using ARM templates:

https://mrpaulandrew.com/2020/12/08/trying-to-deploy-azure-synapse-analytics-using-arm-templates/

https://learn.microsoft.com/en-us/azure/templates/microsoft.synapse/workspaces?pivots=deployment-language-bicep

https://techcommunity.microsoft.com/t5/azure-synapse-analytics-blog/how-to-activate-my-synapse-workspace-using-arm-templates/ba-p/3565748

Please 'Upvote'(Thumbs-up) and 'Accept' as an answer if the reply was helpful. This will benefit other community members who face the same issue.
Please sign in to rate this answer.
MrFlinstone 541 Reputation points

2024-03-05T17:25:09.9766667+00:00

this is purely deployment, the workspace already exists. The scenario is that to deploy the workspace onto other environments.

Vinodh247 17,941 Reputation points

2024-03-06T05:32:50.6466667+00:00

if you have azure devops configured, that would be easy, but did you try the ARM template option that I have provided above?

https://learn.microsoft.com/en-us/azure/synapse-analytics/quickstart-deployment-template-workspaces

Vinodh247 17,941 Reputation points

2024-03-07T05:48:27.7+00:00

MrFlinstone: Were you able to check the above suggestions? let me know

MrFlinstone 541 Reputation points

2024-03-08T00:00:08.7633333+00:00

I think I should have been clearer, what i want to deploy is Synapse Workspace artifacts not a synapse workspace itself.

I would like to do this programmatically, I have seen examples that use github actions and azure devops pipelines, but is it possible to do this via code ?
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

synapse deployment programatically using powershell

1 answer

Your answer