azure.synapse.tools icon indicating copy to clipboard operation
azure.synapse.tools copied to clipboard

PowerShell module to deploy Synapse workspace (and more) in Microsoft Azure.

azure.synapse.tools

What is supported

The deployment of these objects:

  • Workspace instance
  • dataset
  • dataflow
  • integration runtime
  • linked service
  • pipeline
  • KQL script *
  • SQL script *
  • notebook *
  • Spark job definition *

* via RestAPI only

What is NOT yet supported

The deployment of these objects:

  • credential
  • 'AzResource' deployment method
  • Apache Spark pools (BigDataPool - #11)

How to start

Install-Module

To install the module, open PowerShell command line window and run the following lines:

Install-Module -Name azure.synapse.tools -Scope CurrentUser
Import-Module -Name azure.synapse.tools

If you want to upgrade module from a previous version:

Update-Module -Name azure.synapse.tools

Check your currently available version of module:

Get-Module -Name azure.synapse.tools

The module is available on PowerShell Gallery.

Release Notes

New features, bug fixes and changes can be found here.

Misc

New feature requests

Tell me your thoughts or describe your specific case or problem.
For any requests on new features please raise a new issue here: New issue