Skip to content

Commit 42694a8

Browse files
committed
edit pass: synapse-workspace-quickstarts
1 parent ea3bdf1 commit 42694a8

File tree

2 files changed

+64
-58
lines changed

2 files changed

+64
-58
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 on the [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-portal#create-a-storage-account) page.
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 URL 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+
[![Screenshot that shows the Azure Synapse Analytics 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)
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 instructions, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
96+
- Assign other users the appropriate [Synapse 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 Store Gen2 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.
Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'Quickstart: create a Synapse workspace'
3-
description: Create an Synapse workspace by following the steps in this guide.
2+
title: 'Quickstart: Create an Azure Synapse Analytics workspace'
3+
description: Learn how to create an Azure Synapse Analytics workspace by following the steps in this quickstart.
44
author: whhender
55
ms.service: azure-synapse-analytics
66
ms.topic: quickstart
@@ -11,60 +11,61 @@ ms.reviewer: whhender
1111
ms.custom: subject-rbac-steps, mode-other
1212
---
1313

14-
# Quickstart: Create a Synapse workspace
15-
This quickstart describes the steps to create an Azure Synapse workspace by using the Azure portal.
14+
# Quickstart: Create an Azure Synapse Analytics workspace
1615

17-
## Create a Synapse workspace
16+
This quickstart describes the steps to create an Azure Synapse Analytics workspace by using the Azure portal.
1817

19-
1. Open the [Azure portal](https://portal.azure.com), and at the top search for **Synapse**.
18+
## Create an Azure Synapse Analytics workspace
19+
20+
1. Open the [Azure portal](https://portal.azure.com), and at the top, search for **Synapse**.
2021
1. In the search results, under **Services**, select **Azure Synapse Analytics**.
2122
1. Select **Add** to create a workspace.
22-
1. In the **Basics** tab, give the workspace a unique name. We'll use **mysworkspace** in this document
23-
1. You need an ADLSGEN2 account to create a workspace. The simplest choice is to create a new one. If you want to re-use an existing one you'll need to perform some additional configuration.
24-
1. OPTION 1 Creating a new ADLSGEN2 account
25-
1. Under **Select Data Lake Storage Gen 2 / Account Name**, click **Create New** and provide a global unique name, such as **contosolake**.
26-
1. Under **Select Data Lake Storage Gen 2 / File system name**, click **File System** and name it **users**.
27-
1. OPTION 2 See the [**Prepare a Storage Account**](#prepare-an-existing-storage-account-for-use-with-azure-synapse-analytics) instructions at the bottom of this document.
28-
1. Your Azure Synapse workspace will use this storage account as the "primary" storage account and the container to store workspace data. The workspace stores data in Apache Spark tables. It stores Spark application logs under a folder called **/synapse/workspacename**.
23+
1. On the **Basics** tab, give the workspace a unique name. We use **mysworkspace** in this document.
24+
1. You need an ADLSGEN2 account to create a workspace. The simplest choice is to create a new one. If you want to reuse an existing one, you need to perform extra configuration.
25+
1. Option 1: Create a new ADLSGEN2 account:
26+
1. Under **Select Data Lake Storage Gen 2** > **Account Name**, select **Create New**. Provide a global unique name, such as **contosolake**.
27+
1. Under **Select Data Lake Storage Gen 2** > **File system name**, select **File System** and name it **users**.
28+
1. Option 2: See the instructions in [Prepare an existing storage account for use with Azure Synapse Analytics](#prepare-an-existing-storage-account-for-use-with-azure-synapse-analytics).
29+
1. Your Azure Synapse Analytics workspace uses this storage account as the primary storage account and the container to store workspace data. The workspace stores data in Apache Spark tables. It stores Spark application logs under a folder named */synapse/workspacename*.
2930
1. Select **Review + create** > **Create**. Your workspace is ready in a few minutes.
3031

3132
> [!NOTE]
32-
> After creating your Azure Synapse workspace, you will not be able to move the workspace to another Microsoft Entra tenant. If you do so through subscription migration or other actions, you may lose access to the artifacts within the workspace.
33+
> After you create your Azure Synapse Analytics workspace, you won't be able to move the workspace to another Microsoft Entra tenant. If you do so through subscription migration or other actions, you might lose access to the artifacts within the workspace.
3334
3435
## Open Synapse Studio
3536

36-
After your Azure Synapse workspace is created, you have two ways to open Synapse Studio:
37+
After your Azure Synapse Analytics workspace is created, you have two ways to open Synapse Studio:
3738

38-
* Open your Synapse workspace in the [Azure portal](https://portal.azure.com). On the top of the **Overview** section, select **Launch Synapse Studio**.
39-
* Go to the `https://web.azuresynapse.net` and sign in to your workspace.
39+
* Open your Synapse workspace in the [Azure portal](https://portal.azure.com). At the top of the **Overview** section, select **Launch Synapse Studio**.
40+
* Go to [Azure Synapse Analytics](https://web.azuresynapse.net) and sign in to your workspace.
4041

4142
## Prepare an existing storage account for use with Azure Synapse Analytics
4243

4344
1. Open the [Azure portal](https://portal.azure.com).
44-
1. Navigate to an existing ADLSGEN2 storage account
45+
1. Go to an existing ADLSGEN2 storage account.
4546
1. Select **Access control (IAM)**.
46-
1. Select **Add** > **Add role assignment** to open the Add role assignment page.
47-
1. Assign the following role. For detailed steps, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
47+
1. Select **Add** > **Add role assignment** to open the **Add role assignment** page.
48+
1. Assign the following role. For instructions, see [Assign Azure roles by using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
4849

4950
| Setting | Value |
5051
| --- | --- |
5152
| Role | Owner and Storage Blob Data Owner |
5253
| Assign access to | USER |
53-
| Members | your user name |
54+
| Members | Your user name |
5455

55-
![Add role assignment page in Azure portal.](~/reusable-content/ce-skilling/azure/media/role-based-access-control/add-role-assignment-page.png)
56+
![Screenshot that shows the Add role assignment page in Azure portal.](~/reusable-content/ce-skilling/azure/media/role-based-access-control/add-role-assignment-page.png)
5657
1. On the left pane, select **Containers** and create a container.
57-
1. You can give the container any name. In this document, we'll name the container **users**.
58+
1. You can give the container any name. In this document, we name the container **users**.
5859
1. Accept the default setting **Public access level**, and then select **Create**.
5960

6061
### Configure access to the storage account from your workspace
6162

62-
Managed identities for your Azure Synapse workspace might already have access to the storage account. Follow these steps to make sure:
63+
Managed identities for your Azure Synapse Analytics workspace might already have access to the storage account. Follow these steps to make sure:
6364

6465
1. Open the [Azure portal](https://portal.azure.com) and the primary storage account chosen for your workspace.
6566
1. Select **Access control (IAM)**.
66-
1. Select **Add** > **Add role assignment** to open the Add role assignment page.
67-
1. Assign the following role. For detailed steps, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
67+
1. Select **Add** > **Add role assignment** to open the **Add role assignment** page.
68+
1. Assign the following role. For instructions, see [Assign Azure roles by using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
6869

6970
| Setting | Value |
7071
| --- | --- |
@@ -75,11 +76,11 @@ Managed identities for your Azure Synapse workspace might already have access to
7576
> [!NOTE]
7677
> The managed identity name is also the workspace name.
7778
78-
![Add role assignment page in Azure portal.](~/reusable-content/ce-skilling/azure/media/role-based-access-control/add-role-assignment-page.png)
79+
![Screenshot that shows the Add role assignment pane in the Azure portal.](~/reusable-content/ce-skilling/azure/media/role-based-access-control/add-role-assignment-page.png)
7980
1. Select **Save**.
8081

81-
## Next steps
82+
## Related content
8283

8384
* [Create a dedicated SQL pool](quickstart-create-sql-pool-studio.md)
8485
* [Create a serverless Apache Spark pool](quickstart-create-apache-spark-pool-portal.md)
85-
* [Use serverless SQL pool](quickstart-sql-on-demand.md)
86+
* [Use a serverless SQL pool](quickstart-sql-on-demand.md)

0 commit comments

Comments
 (0)