azure.synapse.tools

KO | EN

gitlite — search

#javascript #android #python #kotlin #react #windows #hacktoberfest #css3 #p2p #java #minecraft #arduino

azure.synapse.tools

★ 24 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build status](https://dev.azure.com/sqlplayer/azure.datafactory.tools/_apis/build/status/azure.synapse.tools-CI)](https://dev.azure.com/sqlplayer/azure.datafactory.tools/_build/latest?definitionId=63)
![PSGalleryStatus](https://vsrm.dev.azure.com/sqlplayer/_apis/public/Release/badge/ee3bd4b9-1ccf-4a86-89a0-a9d5dcd1918a/7/11)
[![PowerShell Gallery Version](https://img.shields.io/powershellgallery/v/azure.synapse.tools?label=PowerShell%20Gallery)](https://www.powershellgallery.com/packages/azure.synapse.tools)
![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/azure.synapse.tools?color=yellow)

# azure.synapse.tools
<img style="float: right;" src="./images/Azure-Synapse-tools-256-logo.png" width="256px">

## 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: `<synapse-workspace-name>_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)

azure.synapse.tools

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README