Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Azure-Player/azure.synapse.tools
PowerShell module to deploy Synapse workspace (and more) in Microsoft Azure.
https://github.com/Azure-Player/azure.synapse.tools
azure azure-synapse ci-cd publish synapse synapsetools
Last synced: 3 months ago
JSON representation
PowerShell module to deploy Synapse workspace (and more) in Microsoft Azure.
- Host: GitHub
- URL: https://github.com/Azure-Player/azure.synapse.tools
- Owner: Azure-Player
- License: mit
- Created: 2020-11-26T21:35:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T19:10:19.000Z (9 months ago)
- Last Synced: 2024-05-29T17:15:28.537Z (8 months ago)
- Topics: azure, azure-synapse, ci-cd, publish, synapse, synapsetools
- Language: PowerShell
- Homepage:
- Size: 208 KB
- Stars: 19
- Watchers: 2
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-synapse - SQLPlayer/azure.synapse.tools - PowerShell module to deploy Synapse. (Repositories / Deployment Templates)
README
# 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:
```powershell
Install-Module -Name azure.synapse.tools -Scope CurrentUser
Import-Module -Name azure.synapse.tools
```
If you want to upgrade module from a previous version:
```powershell
Update-Module -Name azure.synapse.tools
```
Check your currently available version of module:
```powershell
Get-Module -Name azure.synapse.tools
```
The module is available on [PowerShell Gallery](https://www.powershellgallery.com/packages/azure.synapse.tools).
## Publish Options
* DeleteNotInSource: Deletes objects in destination that does not exist in source.
* IncrementalDeployment: Deployment state file to only deploy changed objects in the source.
### Incremental Deployment
The Synapse service does not have global parameter capability as in Azure Data Factory (ADF). In order to maintain a deployment state of changed objects, a storage account and json file will hold the deployment state. The file will be in the naming convention: `_deployment_state.json`. If `IncrementalDeployment` is used, please find the prerequisites below.
1. Authenticated user with `Storage Blob Data Contributor` rbac role on the destination storage account.
2. `azure-synapse-tools` container is required prior to deploying a Synapse workspace.
# Release Notes
New features, bug fixes and changes [can be found here](https://github.com/Azure-Player/azure.synapse.tools/blob/master/changelog.md).
# 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](https://github.com/Azure-Player/azure.synapse.tools/issues)