You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
4
4
author: WilliamDAssafMSFT
5
5
ms.service: azure-synapse-analytics
6
6
ms.topic: quickstart
@@ -11,46 +11,48 @@ ms.reviewer: whhender
11
11
ms.custom: mode-api, devx-track-azurecli
12
12
---
13
13
14
-
# Quickstart: Create an Azure synapse workspace with Azure CLI
14
+
# Quickstart: Create an Azure Synapse Analytics workspace with the Azure CLI
15
15
16
16
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.
17
17
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.
- 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).
26
26
27
27
> [!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.
[ ](media/quickstart-create-synapse-workspace-cli/create-workspace-cli-1.png#lightbox)
89
92
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.
94
98
95
99
## Clean up resources
96
100
97
-
Follow the steps below to delete the Azure Synapse workspace.
101
+
Follow these steps to delete the Azure Synapse Analytics workspace.
102
+
98
103
> [!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).
100
105
>
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.
102
107
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:
104
109
105
110
```azurecli
106
111
az synapse workspace delete --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup
107
112
```
108
113
109
-
## Next steps
114
+
## Related content
110
115
111
116
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.
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.
4
4
author: whhender
5
5
ms.service: azure-synapse-analytics
6
6
ms.topic: quickstart
@@ -11,60 +11,61 @@ ms.reviewer: whhender
11
11
ms.custom: subject-rbac-steps, mode-other
12
12
---
13
13
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
16
15
17
-
## Create a Synapse workspace
16
+
This quickstart describes the steps to create an Azure Synapse Analytics workspace by using the Azure portal.
18
17
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**.
20
21
1. In the search results, under **Services**, select **Azure Synapse Analytics**.
21
22
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*.
29
30
1. Select **Review + create** > **Create**. Your workspace is ready in a few minutes.
30
31
31
32
> [!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.
33
34
34
35
## Open Synapse Studio
35
36
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:
37
38
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.
40
41
41
42
## Prepare an existing storage account for use with Azure Synapse Analytics
42
43
43
44
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.
45
46
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).
48
49
49
50
| Setting | Value |
50
51
| --- | --- |
51
52
| Role | Owner and Storage Blob Data Owner |
52
53
| Assign access to | USER |
53
-
| Members |your user name |
54
+
| Members |Your user name |
54
55
55
-

56
+

56
57
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**.
58
59
1. Accept the default setting **Public access level**, and then select **Create**.
59
60
60
61
### Configure access to the storage account from your workspace
61
62
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:
63
64
64
65
1. Open the [Azure portal](https://portal.azure.com) and the primary storage account chosen for your workspace.
65
66
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).
68
69
69
70
| Setting | Value |
70
71
| --- | --- |
@@ -75,11 +76,11 @@ Managed identities for your Azure Synapse workspace might already have access to
75
76
> [!NOTE]
76
77
> The managed identity name is also the workspace name.
77
78
78
-

79
+

79
80
1. Select **Save**.
80
81
81
-
## Next steps
82
+
## Related content
82
83
83
84
*[Create a dedicated SQL pool](quickstart-create-sql-pool-studio.md)
84
85
*[Create a serverless Apache Spark pool](quickstart-create-apache-spark-pool-portal.md)
0 commit comments