Skip to content

Commit 9c0ab66

Browse files
committed
git rebase and setup.sh changes to pass securityEnabled parameters to bicep
1 parent e0335ed commit 9c0ab66

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

deploy/README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ Steps 2 through 4 can instead be deployed using a single script below:
4848
./deploy/setup.sh <environmentCode> <location> <pipelineName> <envTag>
4949

5050
```
51+
To enabled security features like Synapse managed VNET, managed private endpoints, and privates enpoints to 3 synapse endpoints, set 'securityEnabled=true' when running setup.sh:
52+
```
53+
securityEnabled=true ./deploy/setup.sh <environmentCode> <location> <pipelineName> <envTag>
54+
```
55+
**Note that if you turn on securityEnabled during setup, Synapse endpoints are restricted to the custom VNET in the deployment environment. Thus, you need to create a Windows jumpbox inside the VNET to connect to Synapse Studio.**
56+
5157
If you like to package other pipelines or re-package an updated/modified pipeline, follow the instructions under `Packaging the Synapse pipeline` section. The script mentioned in that section can be rerun multiple times.
5258

5359
Arguments | Required | Sample value
@@ -83,6 +89,12 @@ To install infrastructure execute install.sh script as follows
8389

8490
```
8591

92+
To enabled security features like Synapse managed VNET, managed private endpoints, and privates enpoints to 3 synapse endpoints, set 'securityEnabled=true' when running install.sh:
93+
```
94+
securityEnabled=true ./deploy/install.sh <environmentCode> <location> <envTag>
95+
```
96+
**Note that if you turn on securityEnabled during setup, Synapse endpoints are restricted to the custom VNET in the deployment environment. Thus, you need to create a Windows jumpbox inside the VNET to connect to Synapse Studio.**
97+
8698
Default values for the parameters are provided in the script itself.
8799

88100
Arguments | Required | Sample value
@@ -113,6 +125,11 @@ For eg.
113125
az deployment sub create -l <region> -n aoi -f main.bicep -p location=<region> environmentCode=aoi environment=synapse-aoi
114126
```
115127

128+
To enabled security features like Synapse managed VNET, managed private endpoints, and privates enpoints to 3 Synapse endpoints, pass parameter 'securityEnabled=true' when running bicep:
129+
```
130+
bash
131+
az deployment sub create -l <region_name> -n <deployment_name> -f main.bicep -p location=<region_name> environmentCode=<environment_name_prefix> environment=<tag_value> securityEnabled=true
132+
```
116133

117134
## Configuring the Resources
118135

@@ -142,7 +159,10 @@ Once the above step completes, a zip file is generated. Upload the generated zip
142159
4. When prompted to select a file, pick the zip file generated in the previous step
143160
5. Pipelines and its dependencies are imported to the Synapse Studio. Validate the components being imported for any errors
144161
6. Click "Publish all" and wait for the imported components to be published
145-
NOTE: You may run into this error during import "Invalid template, please check the template file". It is a known issue that we are working on with the product team. In the interim, we suggest importing from Git Repository as described below.
162+
NOTE: You may run into this error during import "Invalid template, please check the template file". It is a known issue that we are working on with the product team. In the interim, we suggest importing from Git Repository as described below.
163+
164+
**Note that if you turn on securityEnabled during setup, Synapse endpoints are restricted to the custom VNET in the deployment environment. Thus, you need to create a Windows jumpbox inside the VNET to connect to Synapse Studio and import the package.**
165+
146166
## Importing from Git Repository
147167

148168
Another way to get import pipeline into the Synape Studio is through Source Control repository like GitHub or Azure DevOps repository. Refer to the document on [Source Control](https://docs.microsoft.com/azure/synapse-analytics/cicd/source-control) to learn about Git Integration for Azure Synapse Analytics and how to setup.

deploy/setup.sh

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ LOCATION=$2
88
PIPELINE_NAME=$3
99
ENVTAG=$4
1010

11+
export securityEnabled=${securityEnabled:-false}
12+
export preventDataExfiltration=${preventDataExfiltration:-false}
1113

1214
set -x
1315

0 commit comments

Comments
 (0)