Skip to content

Commit 0fe7c14

Browse files
authored
Merge pull request #283484 from paulth1/synapse-workspace-quickstarts
[AQ] edit pass: Synapse workspace quickstarts
2 parents 836bf3f + 27119db commit 0fe7c14

File tree

4 files changed

+118
-116
lines changed

4 files changed

+118
-116
lines changed
Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'Quickstart: Create a Synapse workspace using Azure CLI'
3-
description: Create an Azure Synapse workspace using Azure CLI by following the steps in this guide.
2+
title: 'Quickstart: Create an Azure Synapse Analytics workspace using Azure CLI'
3+
description: Create an Azure Synapse Analytics workspace using the Azure CLI by following the steps in this article.
44
author: WilliamDAssafMSFT
55
ms.service: azure-synapse-analytics
66
ms.topic: quickstart
@@ -11,46 +11,48 @@ ms.reviewer: whhender
1111
ms.custom: mode-api, devx-track-azurecli
1212
---
1313

14-
# Quickstart: Create an Azure synapse workspace with Azure CLI
14+
# Quickstart: Create an Azure Synapse Analytics workspace with the Azure CLI
1515

1616
The Azure CLI is Azure's command-line experience for managing Azure resources. You can use it in your browser with Azure Cloud Shell. You can also install it on macOS, Linux, or Windows and run it from the command line.
1717

18-
In this quickstart, you learn to create a Synapse workspace by using the Azure CLI.
18+
In this quickstart, you learn how to create an Azure Synapse Analytics workspace by using the Azure CLI.
1919

2020
[!INCLUDE [quickstarts-free-trial-note](~/reusable-content/ce-skilling/azure/includes/quickstarts-free-trial-note.md)]
2121

2222
## Prerequisites
2323

24-
- Download and install [jq](https://stedolan.github.io/jq/download/), a lightweight and flexible command-line JSON processor
25-
- [Azure Data Lake Storage Gen2 storage account](../storage/common/storage-account-create.md)
24+
- Download and install [jq](https://stedolan.github.io/jq/download/), a lightweight and flexible command-line JSON processor.
25+
- [Azure Data Lake Storage Gen2 storage account](../storage/common/storage-account-create.md).
2626

2727
> [!IMPORTANT]
28-
> The Azure Synapse workspace needs to be able to read and write to the selected ADLS Gen2 account. In addition, for any storage account that you link as the primary storage account, you must have enabled **hierarchical namespace** at the creation of the storage account, as described on the [Create a Storage Account](../storage/common/storage-account-create.md?tabs=azure-portal#create-a-storage-account) page.
28+
> An Azure Synapse Analytics workspace needs to be able to read and write to the selected Data Lake Storage Gen2 account. In addition, for any storage account that you link as the primary storage account, you must have enabled **hierarchical namespace** at the creation of the storage account, as described in [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-portal#create-a-storage-account).
2929
3030
[!INCLUDE [azure-cli-prepare-your-environment.md](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)]
3131

32-
## Create an Azure Synapse workspace using the Azure CLI
32+
## Create an Azure Synapse Analytics workspace by using the Azure CLI
3333

34-
1. Define necessary environment variables to create resources for Azure Synapse workspace.
34+
1. Define necessary environment variables to create resources for an Azure Synapse Analytics workspace.
3535

36-
| Environment Variable Name | Description |
36+
| Environment Variable name | Description |
3737
|---|---|---|
38-
|StorageAccountName| Name for your existing ADLS Gen2 storage account.|
39-
|StorageAccountResourceGroup| Name of your existing ADLS Gen2 storage account resource group. |
38+
|StorageAccountName| Name for your existing Data Lake Storage Gen2 storage account.|
39+
|StorageAccountResourceGroup| Name of your existing Data Lake Storage Gen2 storage account resource group. |
4040
|FileShareName| Name of your existing storage file system.|
41-
|SynapseResourceGroup| Choose a new name for your Azure Synapse resource group. |
41+
|SynapseResourceGroup| Choose a new name for your Azure Synapse Analytics resource group. |
4242
|Region| Choose one of the [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/#overview). |
43-
|SynapseWorkspaceName| Choose a unique name for your new Azure Synapse Workspace. |
43+
|SynapseWorkspaceName| Choose a unique name for your new Azure Synapse Analytics workspace. |
4444
|SqlUser| Choose a value for a new username.|
4545
|SqlPassword| Choose a secure password.|
4646
|||
4747

48-
1. Create a resource group as a container for your Azure Synapse workspace:
48+
1. Create a resource group as a container for your Azure Synapse Analytics workspace:
49+
4950
```azurecli
5051
az group create --name $SynapseResourceGroup --location $Region
5152
```
5253
53-
1. Create an Azure Synapse Workspace:
54+
1. Create an Azure Synapse Analytics workspace:
55+
5456
```azurecli
5557
az synapse workspace create \
5658
--name $SynapseWorkspaceName \
@@ -62,14 +64,15 @@ In this quickstart, you learn to create a Synapse workspace by using the Azure C
6264
--location $Region
6365
```
6466
65-
1. Get Web and Dev URL for Azure Synapse Workspace:
67+
1. Get the web and dev URLs for the Azure Synapse Analytics workspace:
68+
6669
```azurecli
6770
WorkspaceWeb=$(az synapse workspace show --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup | jq -r '.connectivityEndpoints | .web')
6871
6972
WorkspaceDev=$(az synapse workspace show --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup | jq -r '.connectivityEndpoints | .dev')
7073
```
7174
72-
1. Create a Firewall Rule to allow your access to Azure Synapse Workspace from your machine:
75+
1. Create a firewall rule to allow access to your Azure Synapse Analytics workspace from your machine:
7376
7477
```azurecli
7578
ClientIP=$(curl -sb -H "Accept: application/json" "$WorkspaceDev" | jq -r '.message')
@@ -79,33 +82,35 @@ In this quickstart, you learn to create a Synapse workspace by using the Azure C
7982
az synapse workspace firewall-rule create --end-ip-address $ClientIP --start-ip-address $ClientIP --name "Allow Client IP" --resource-group $SynapseResourceGroup --workspace-name $SynapseWorkspaceName
8083
```
8184
82-
1. Open the Azure Synapse Workspace Web URL address stored in environment variable `WorkspaceWeb` to access your workspace:
85+
1. Open the Azure Synapse Analytics workspace web URL address stored in the environment variable `WorkspaceWeb` to access your workspace:
8386
8487
```azurecli
8588
echo "Open your Azure Synapse Workspace Web URL in the browser: $WorkspaceWeb"
8689
```
8790
88-
[ ![Azure Synapse workspace web](media/quickstart-create-synapse-workspace-cli/create-workspace-cli-1.png) ](media/quickstart-create-synapse-workspace-cli/create-workspace-cli-1.png#lightbox)
91+
:::image type="content" source="media/quickstart-create-synapse-workspace-cli/create-workspace-cli-1.png" alt-text="Screenshot that shows the Azure Synapse Analytics workspace web." lightbox="media/quickstart-create-synapse-workspace-cli/create-workspace-cli-1.png":::
8992
90-
1. Once deployed, additional permissions are required.
91-
- In the Azure portal, assign other users of the workspace to the **Contributor** role in the workspace. For detailed steps, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
92-
- Assign other users the appropriate **[Synapse RBAC roles](security/synapse-workspace-synapse-rbac-roles.md)** using Synapse Studio.
93-
- A member of the **Owner** role of the Azure Storage account must assign the **Storage Blob Data Contributor** role to the Azure Synapse workspace MSI and other users.
93+
1. After it's deployed, more permissions are required:
94+
95+
- In the Azure portal, assign other users of the workspace to the Contributor role in the workspace. For more information, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
96+
- Assign other users the appropriate [Azure Synapse Analytics role-based access control roles](security/synapse-workspace-synapse-rbac-roles.md) by using Synapse Studio.
97+
- A member of the Owner role of the Azure Storage account must assign the Storage Blob Data Contributor role to the Azure Synapse Analytics workspace managed service identity and other users.
9498
9599
## Clean up resources
96100
97-
Follow the steps below to delete the Azure Synapse workspace.
101+
Follow these steps to delete the Azure Synapse Analytics workspace.
102+
98103
> [!WARNING]
99-
> Deleting an Azure Synapse workspace will remove the analytics engines and the data stored in the database of the contained SQL pools and workspace metadata. It will no longer be possible to connect to the SQL or Apache Spark endpoints. All code artifacts will be deleted (queries, notebooks, job definitions and pipelines).
104+
> Deleting an Azure Synapse Analytics workspace removes the analytics engines and the data stored in the database of the contained SQL pools and workspace metadata. It will no longer be possible to connect to the SQL or Apache Spark endpoints. All code artifacts will be deleted (queries, notebooks, job definitions, and pipelines).
100105
>
101-
> Deleting the workspace will **not** affect the data in the Data Lake Store Gen2 linked to the workspace.
106+
> Deleting the workspace won't affect the data in the Data Lake Storage Gen2 account linked to the workspace.
102107
103-
If you want to delete the Azure Synapse workspace, complete the following command:
108+
If you want to delete the Azure Synapse Analytics workspace, complete the following command:
104109
105110
```azurecli
106111
az synapse workspace delete --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup
107112
```
108113

109-
## Next steps
114+
## Related content
110115

111116
Next, you can [create SQL pools](quickstart-create-sql-pool-studio.md) or [create Apache Spark pools](quickstart-create-apache-spark-pool-studio.md) to start analyzing and exploring your data.

0 commit comments

Comments
 (0)