Skip to content

Commit d8b92e4

Browse files
committed
git rebase and setup.sh changes to pass securityEnabled parameters to bicep
1 parent 3d030a1 commit d8b92e4

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

deploy/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ 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> <envTag>
54+
```
55+
5156
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.
5257

5358
Arguments | Required | Sample value
@@ -83,6 +88,12 @@ To install infrastructure execute install.sh script as follows
8388

8489
```
8590

91+
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:
92+
```
93+
securityEnabled=true ./deploy/install.sh <environmentCode> <location> <envTag>
94+
```
95+
**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.**
96+
8697
Default values for the parameters are provided in the script itself.
8798

8899
Arguments | Required | Sample value
@@ -113,6 +124,11 @@ For eg.
113124
az deployment sub create -l <region> -n aoi -f main.bicep -p location=<region> environmentCode=aoi environment=synapse-aoi
114125
```
115126

127+
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:
128+
```
129+
bash
130+
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
131+
```
116132

117133
## Configuring the Resources
118134

@@ -142,7 +158,10 @@ Once the above step completes, a zip file is generated. Upload the generated zip
142158
4. When prompted to select a file, pick the zip file generated in the previous step
143159
5. Pipelines and its dependencies are imported to the Synapse Studio. Validate the components being imported for any errors
144160
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.
161+
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+
163+
**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.**
164+
146165
## Importing from Git Repository
147166

148167
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: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
# Copyright (c) Microsoft Corporation.
44
# Licensed under the MIT license.
55

6-
ENVCODE=$ENVCODE
7-
LOCATION=$LOCATION
6+
ENVCODE=${ENVCODE:-"${1}"}
7+
LOCATION=$LOCATION:-"${2}"}
8+
ENVTAG=$ENVTAG:-"${3}"}
89
PIPELINE_NAME=$PIPELINE_NAME
9-
ENVTAG=$ENVTAG
1010

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

1214
set -x
1315

0 commit comments

Comments
 (0)