Skip to content

Commit 6ff7676

Browse files
committed
edit pass: synapse-workspace-quickstarts
1 parent 77e8a97 commit 6ff7676

File tree

4 files changed

+58
-63
lines changed

4 files changed

+58
-63
lines changed

articles/synapse-analytics/quickstart-create-workspace-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ In this quickstart, you learn how to create an Azure Synapse Analytics workspace
6464
--location $Region
6565
```
6666
67-
1. Get the web and dev URL for the Azure Synapse Analytics workspace:
67+
1. Get the web and dev URLs for the Azure Synapse Analytics workspace:
6868
6969
```azurecli
7070
WorkspaceWeb=$(az synapse workspace show --name $SynapseWorkspaceName --resource-group $SynapseResourceGroup | jq -r '.connectivityEndpoints | .web')
@@ -92,8 +92,8 @@ In this quickstart, you learn how to create an Azure Synapse Analytics workspace
9292
9393
1. After it's deployed, more permissions are required:
9494
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.
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.
9797
- 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.
9898
9999
## Clean up resources
Lines changed: 31 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: 'Quickstart: Create a Synapse workspace using Azure PowerShell'
3-
description: Create an Azure Synapse workspace using Azure PowerShell by following the steps in this guide.
2+
title: 'Quickstart: Create an Azure Synapse Analytics workspace using PowerShell'
3+
description: Create an Azure Synapse Analytics workspace using Azure PowerShell by following the steps in this article.
44
author: WilliamDAssafMSFT
55
ms.service: azure-synapse-analytics
66
ms.topic: quickstart
@@ -11,11 +11,11 @@ ms.reviewer: whhender
1111
ms.custom: devx-track-azurepowershell, mode-api
1212
---
1313

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

1616
Azure PowerShell is a set of cmdlets for managing Azure resources directly from PowerShell. You can use it in your browser with Azure Cloud Shell. You can also install it on macOS, Linux, or Windows.
1717

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

2020
If you don't have an Azure subscription, create a [free Azure account](https://azure.microsoft.com/free/) before you begin.
2121

@@ -24,52 +24,49 @@ If you don't have an Azure subscription, create a [free Azure account](https://a
2424
- [Azure Data Lake Storage Gen2 storage account](../storage/common/storage-account-create.md)
2525

2626
> [!IMPORTANT]
27-
> The Azure Synapse workspace needs to be able to read and write to the selected ADLS Gen2
28-
> account. For any storage account that you link as the primary storage account, you must enable
29-
> **hierarchical namespace** at the creation of the storage account as described in
30-
> [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-powershell#create-a-storage-account).
27+
> An Azure Synapse Analytics workspace needs to be able to read and write to the selected Azure Data Lake Storage Gen2 account. For any storage account that you link as the primary storage account, you must enable **hierarchical namespace** at the creation of the storage account as described in [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-powershell#create-a-storage-account).
3128
3229
If you choose to use Cloud Shell, see [Overview of Azure Cloud Shell](../cloud-shell/overview.md) for more information.
3330

3431
### Install the Azure PowerShell module locally
3532

36-
If you choose to use PowerShell locally, this article requires that you install the Az PowerShell module and connect to your Azure account using the [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet. For more information about installing the Az PowerShell module, see [Install Azure PowerShell](/powershell/azure/install-azure-powershell).
33+
If you choose to use PowerShell locally, this article requires that you install the Az PowerShell module and connect to your Azure account by using the [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet. For more information about installing the Az PowerShell module, see [Install Azure PowerShell](/powershell/azure/install-azure-powershell).
3734

3835
For more information about authentication with Azure PowerShell, see [Sign in with Azure PowerShell](/powershell/azure/authenticate-azureps).
3936

4037
### Install the Azure Synapse PowerShell module
4138

4239
> [!IMPORTANT]
43-
> While the **Az.Synapse** PowerShell module is in preview, you must install it separately using the `Install-Module` cmdlet. After this PowerShell module becomes generally available, it will be part of future Az PowerShell module releases and available by default from within Azure Cloud Shell.
40+
> While the `Az.Synapse` PowerShell module is in preview, you must install it separately by using the `Install-Module` cmdlet. After this PowerShell module becomes generally available, it will be part of future Az PowerShell module releases and available by default from within Cloud Shell.
4441
4542
```azurepowershell-interactive
4643
Install-Module -Name Az.Synapse
4744
```
4845

49-
## Create an Azure Synapse workspace using Azure PowerShell
46+
## Create an Azure Synapse Analytics workspace by using Azure PowerShell
5047

51-
1. Define necessary environment variables to create resources for Azure Synapse workspace.
48+
1. Define necessary environment variables to create resources for an Azure Synapse Analytics workspace.
5249

5350
| Variable name | Description |
5451
| --------------------------- | ----------------------------------------------------------------------------------------------------------- |
55-
| StorageAccountName | Name for your existing ADLS Gen2 storage account. |
56-
| StorageAccountResourceGroup | Name of your existing ADLS Gen2 storage account resource group. |
52+
| StorageAccountName | Name for your existing Azure Data Lake Storage Gen2 storage account. |
53+
| StorageAccountResourceGroup | Name of your existing Azure Data Lake Storage Gen2 storage account resource group. |
5754
| FileShareName | Name of your existing storage file system. |
58-
| SynapseResourceGroup | Choose a new name for your Azure Synapse resource group. |
55+
| SynapseResourceGroup | Choose a new name for your Azure Synapse Analytics resource group. |
5956
| Region | Choose one of the [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/#overview). |
60-
| SynapseWorkspaceName | Choose a unique name for your new Azure Synapse Workspace. |
57+
| SynapseWorkspaceName | Choose a unique name for your new Azure Synapse Analytics workspace. |
6158
| SqlUser | Choose a value for a new username. |
6259
| SqlPassword | Choose a secure password. |
63-
| ClientIP | Public IP Address of the system you're running PowerShell from. |
60+
| ClientIP | Public IP address of the system you're running PowerShell from. |
6461
| | |
6562

66-
1. Create a resource group as a container for your Azure Synapse workspace:
63+
1. Create a resource group as a container for your Azure Synapse Analytics workspace:
6764

6865
```azurepowershell-interactive
6966
New-AzResourceGroup -Name $SynapseResourceGroup -Location $Region
7067
```
7168

72-
1. Create an Azure Synapse Workspace:
69+
1. Create an Azure Synapse Analytics workspace:
7370

7471
```azurepowershell-interactive
7572
$Cred = New-Object -TypeName System.Management.Automation.PSCredential ($SqlUser, (ConvertTo-SecureString $SqlPassword -AsPlainText -Force))
@@ -85,14 +82,14 @@ Install-Module -Name Az.Synapse
8582
New-AzSynapseWorkspace @WorkspaceParams
8683
```
8784

88-
1. Get Web and Dev URL for Azure Synapse Workspace:
85+
1. Get the web and dev URLs for Azure Synapse Analytics workspace:
8986

9087
```azurepowershell-interactive
9188
$WorkspaceWeb = (Get-AzSynapseWorkspace -Name $SynapseWorkspaceName -ResourceGroupName $StorageAccountResourceGroup).ConnectivityEndpoints.web
9289
$WorkspaceDev = (Get-AzSynapseWorkspace -Name $SynapseWorkspaceName -ResourceGroupName $StorageAccountResourceGroup).ConnectivityEndpoints.dev
9390
```
9491

95-
1. Create a Firewall Rule to allow your access to Azure Synapse Workspace from your machine:
92+
1. Create a firewall rule to allow access to your Azure Synapse Analytics workspace from your machine:
9693

9794
```azurepowershell-interactive
9895
$FirewallParams = @{
@@ -105,39 +102,37 @@ Install-Module -Name Az.Synapse
105102
New-AzSynapseFirewallRule @FirewallParams
106103
```
107104

108-
1. Open the Azure Synapse Workspace Web URL address stored in environment variable `WorkspaceWeb` to
105+
1. Open the Azure Synapse Analytics workspace web URL address stored in the environment variable `WorkspaceWeb` to
109106
access your workspace:
110107

111108
```azurepowershell-interactive
112109
Start-Process $WorkspaceWeb
113110
```
114111

115-
![Azure Synapse workspace web](media/quickstart-create-synapse-workspace-powershell/create-workspace-powershell-1.png)
112+
![Screenshot that shows the Azure Synapse Analytics workspace web.](media/quickstart-create-synapse-workspace-powershell/create-workspace-powershell-1.png)
116113

114+
1. After it's deployed, more permissions are required.
117115

118-
1. Once deployed, additional permissions are required.
119-
- 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).
120-
- Assign other users the appropriate **[Synapse RBAC roles](security/synapse-workspace-synapse-rbac-roles.md)** using Synapse Studio.
121-
- 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.
116+
- In the Azure portal, assign other users of the workspace to the Contributor role in the workspace. For instructions, see [Assign Azure roles by using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
117+
- Assign other users the appropriate [Azure Synapse Analytics role-based access control roles](security/synapse-workspace-synapse-rbac-roles.md) by using Synapse Studio.
118+
- 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.
122119

123120
## Clean up resources
124121

125-
Follow the steps below to delete the Azure Synapse workspace.
122+
Follow these steps to delete the Azure Synapse Analytics workspace.
126123

127124
> [!WARNING]
128-
> Deleting an Azure Synapse workspace will remove the analytics engines and the data stored in the
129-
> database of the contained SQL pools and workspace metadata. It will no longer be possible to
130-
> connect to the SQL or Apache Spark endpoints. All code artifacts will be deleted (queries,
131-
> notebooks, job definitions and pipelines). Deleting the workspace will **not** affect the data in
132-
> the Data Lake Store Gen2 linked to the workspace.
125+
> 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).
126+
>
127+
> Deleting the workspace won't affect the data in the Azure Data Lake Store Gen2 linked to the workspace.
133128
134-
If the Azure Synapse workspace created in this article isn't needed, you can delete it by running
135-
the following example.
129+
If the Azure Synapse Analytics workspace created in this article isn't needed, you can delete it by running
130+
the following example:
136131

137132
```azurepowershell-interactive
138133
Remove-AzSynapseWorkspace -Name $SynapseWorkspaceNam -ResourceGroupName $SynapseResourceGroup
139134
```
140135

141-
## Next steps
136+
## Related content
142137

143138
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.

articles/synapse-analytics/quickstart-create-workspace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ After your Azure Synapse Analytics workspace is created, you have two ways to op
4545
1. Go to an existing ADLSGEN2 storage account.
4646
1. Select **Access control (IAM)**.
4747
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+
1. Assign the following role. For more information, see [Assign Azure roles by using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
4949

5050
| Setting | Value |
5151
| --- | --- |
@@ -65,7 +65,7 @@ Managed identities for your Azure Synapse Analytics workspace might already have
6565
1. Open the [Azure portal](https://portal.azure.com) and the primary storage account chosen for your workspace.
6666
1. Select **Access control (IAM)**.
6767
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+
1. Assign the following role. For more information, see [Assign Azure roles by using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
6969

7070
| Setting | Value |
7171
| --- | --- |

0 commit comments

Comments
 (0)