Skip to content

Commit ef474f7

Browse files
committed
Merge branch 'master' of https://github.com/MicrosoftDocs/sql-docs-pr into release-synapse-pool-rebrand
2 parents 3db0e02 + 3b66d69 commit ef474f7

53 files changed

Lines changed: 377 additions & 305 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/azdata/install/deploy-install-azdata-installer.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Install azdata with Windows Installer
2+
title: Install Azure Data CLI (azdata) with Windows Installer
33
titleSuffix:
4-
description: Learn how to install the azdata tool with the installer.
4+
description: Learn how to install the Azure Data CLI (azdata) tool with the installer.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
@@ -11,7 +11,7 @@ ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

14-
# Install `azdata` with Windows Installer
14+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] with Windows Installer
1515

1616
[!INCLUDE [azdata](../../includes/applies-to-version/azdata.md)]
1717

@@ -39,4 +39,4 @@ The program to uninstall is called `Azdata CLI` . Select this application, then
3939

4040
For more information about big data clusters, see [What are [!INCLUDE[big-data-clusters-2019](../../includes/ssbigdataclusters-ver15.md)]?](../../big-data-cluster/big-data-cluster-overview.md)
4141

42-
Use azdata with [Azure Arc enabled data services](/azure/azure-arc/data/)
42+
Use `azdata` with [Azure Arc enabled data services](/azure/azure-arc/data/)

docs/azdata/install/deploy-install-azdata-linux-package.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Install azdata with apt
3-
description: Learn how to install the azdata tool with apt.
2+
title: Install Azure Data CLI (azdata) with apt
3+
description: Learn how to install the Azure Data CLI (azdata) tool with apt.
44
author: MikeRayMSFT
55
ms.author: mikeray
66
ms.reviewer: mihaelab
@@ -10,7 +10,7 @@ ms.prod: sql
1010
ms.technology: big-data-cluster
1111
---
1212

13-
# Install `azdata` with apt
13+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] with apt
1414

1515
[!INCLUDE[azdata](../../includes/applies-to-version/azdata.md)]
1616

docs/azdata/install/deploy-install-azdata-macos.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Install azdata for macOS
2+
title: Install Azure Data CLI (azdata) for macOS
33
titleSuffix:
4-
description: Learn how to install the azdata tool on macOS.
4+
description: Learn how to install the Azure Data CLI (azdata) tool on macOS.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
@@ -11,7 +11,7 @@ ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

14-
# Install `azdata` on macOS
14+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] on macOS
1515

1616
For the macOS platform, you can install the `azdata-cli` with Homebrew package manager. The CLI package has been tested on macOS versions:
1717

docs/azdata/install/deploy-install-azdata-pip.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Install azdata using pip
2+
title: Install Azure Data CLI (azdata) using pip
33
titleSuffix:
44
description: Learn how to install the azdata tool with pip.
55
author: MikeRayMSFT
@@ -11,11 +11,11 @@ ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

14-
# Install `azdata` with `pip`
14+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] with `pip`
1515

1616
[!INCLUDE[azdata](../../includes/applies-to-version/azdata.md)]
1717

18-
This article describes how to install the `azdata` tool on Windows, Linux or macOS/OS X using `pip`.
18+
This article describes how to install the [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] tool on Windows, Linux or macOS/OS X using `pip`.
1919

2020
> [!TIP]
2121
> For a simpler experience, `azdata` can be installed with a [package manager](./deploy-install-azdata.md) for Windows, Linux (Ubuntu, Debian, RHEL, CentOS, openSUSE and SLE distributions) and macOS.
@@ -124,7 +124,7 @@ To install `azdata` on macOS or OS X complete these steps. For each step, run th
124124
pip3 uninstall -r https://azdatacli.blob.core.windows.net/python/azdata/2019-rc1/requirements.txt
125125
```
126126

127-
1. Install `azdata`.
127+
1. Install Azure Data CLI.
128128

129129
```bash
130130
pip3 install -r https://aka.ms/azdata

docs/azdata/install/deploy-install-azdata-yum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

14-
# Install `azdata` with yum
14+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] with yum
1515

1616
[!INCLUDE[azdata](../../includes/applies-to-version/azdata.md)]
1717

docs/azdata/install/deploy-install-azdata-zypper.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Install azdata with zypper
2+
title: Install Azure Data CLI (azdata) with zypper
33
titleSuffix:
4-
description: Learn how to install the azdata tool with zypper.
4+
description: Learn how to install the Azure Data CLI (azdata) tool with zypper.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
@@ -11,7 +11,7 @@ ms.prod: sql
1111
ms.technology: big-data-cluster
1212
---
1313

14-
# Install `azdata` with zypper
14+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] with zypper
1515

1616
[!INCLUDE[azdata](../../includes/applies-to-version/azdata.md)]
1717

docs/azdata/install/deploy-install-azdata.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Install azdata
2+
title: Install Azure Data CLI (azdata)
33
titleSuffix:
4-
description: Learn how to install the azdata tool.
4+
description: Learn how to install the Azure Data CLI azdata) tool.
55
author: MikeRayMSFT
66
ms.author: mikeray
77
ms.reviewer: mihaelab
@@ -10,11 +10,11 @@ ms.topic: conceptual
1010
ms.prod: sql
1111
---
1212

13-
# Install `azdata`
13+
# Install [!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)]
1414

1515
[!INCLUDE[azdata](../../includes/applies-to-version/azdata.md)]
1616

17-
`azdata` is a command-line utility written in Python to bootstrap and manage the data services via REST APIs.
17+
[!INCLUDE [azure-data-cli-azdata](../../includes/azure-data-cli-azdata.md)] is a command-line utility written in Python to bootstrap and manage the data services via REST APIs.
1818

1919
## Find latest version
2020

docs/azure-data-studio/download-azure-data-studio.md

Lines changed: 54 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ author: yualan
88
ms.author: alayu
99
ms.reviewer: maghan
1010
ms.custom: seodec18
11-
ms.date: 10/14/2020
11+
ms.date: 10/20/2020
1212
---
1313

1414
# Download and install Azure Data Studio
@@ -34,37 +34,37 @@ For details about the latest release, see the [release notes](./release-notes-az
3434

3535
This release of Azure Data Studio includes a standard Windows Installer experience, and a .zip file.
3636

37-
The *user installer* is recommended because it does not require administrator privileges, which simplify both installs and upgrades. The user installer does not require Administrator privileges as the location is under your user Local AppData (LOCALAPPDATA) folder. The user installer also provides a smoother background update experience. For more information, see [User setup for Windows](https://code.visualstudio.com/updates/v1_26#_user-setup-for-windows).
37+
We recommend the *user installer* because it doesn't require administrator privileges, which simplify both installs and upgrades. The user installer doesn't require Administrator privileges as the location is under your user Local AppData (LOCALAPPDATA) folder. The user installer also provides a smoother background update experience. For more information, see [User setup for Windows](https://code.visualstudio.com/updates/v1_26#_user-setup-for-windows).
3838

3939
**User Installer** (recommended)
4040

41-
1. Download and run the [[!INCLUDE[name-sos](../includes/name-sos-short.md)] *user* installer for Windows](https://go.microsoft.com/fwlink/?linkid=2145989).
42-
2. Start the [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] app.
41+
1. Download and run the [Azure Data Studio *user* installer for Windows](https://go.microsoft.com/fwlink/?linkid=2145989).
42+
2. Start the Azure Data Studio app.
4343

4444
**System Installer**
4545

46-
1. Download and run the [[!INCLUDE[name-sos](../includes/name-sos-short.md)] *system* installer for Windows](https://go.microsoft.com/fwlink/?linkid=2145990).
47-
2. Start the [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] app.
46+
1. Download and run the [Azure Data Studio *system* installer for Windows](https://go.microsoft.com/fwlink/?linkid=2145990).
47+
2. Start the Azure Data Studio app.
4848

4949
**.zip file**
5050

51-
1. Download [[!INCLUDE[name-sos](../includes/name-sos-short.md)] .zip for Windows](https://go.microsoft.com/fwlink/?linkid=2145864).
51+
1. Download [Azure Data Studio .zip for Windows](https://go.microsoft.com/fwlink/?linkid=2145864).
5252
2. Browse to the downloaded file and extract it.
5353
3. Run `\azuredatastudio-windows\azuredatastudio.exe`
5454

5555
## Get Azure Data Studio for macOS
5656

57-
1. Download [[!INCLUDE[name-sos](../includes/name-sos-short.md)] for macOS](https://go.microsoft.com/fwlink/?linkid=2145865).
57+
1. Download [Azure Data Studio for macOS](https://go.microsoft.com/fwlink/?linkid=2145865).
5858
2. To expand the contents of the zip, double-click it.
5959
3. To make Azure Data Studio available in the *Launchpad*, drag *Azure Data Studio.app* to the *Applications* folder.
6060

6161
## Get Azure Data Studio for Linux
6262

63-
1. Download [!INCLUDE[name-sos](../includes/name-sos-short.md)] for Linux by using one of the installers or the tar.gz archive:
63+
1. Download Azure Data Studio for Linux by using one of the installers or the tar.gz archive:
6464
- [.deb](https://go.microsoft.com/fwlink/?linkid=2146016)
6565
- [.rpm](https://go.microsoft.com/fwlink/?linkid=2146015)
6666
- [.tar.gz](https://go.microsoft.com/fwlink/?linkid=2145866)
67-
1. To extract the file and launch [!INCLUDE[name-sos](../includes/name-sos-short.md)], open a new Terminal window and type the following commands:
67+
1. To extract the file and launch Azure Data Studio, open a new Terminal window and type the following commands:
6868

6969
**Debian Installation:**
7070

@@ -122,13 +122,7 @@ The *user installer* is recommended because it does not require administrator pr
122122

123123
## Download Insiders build of Azure Data Studio
124124

125-
In general, users should download the stable release of Azure Data Studio above. However, if you want to try out our beta features and give us feedback, you can download an [Insiders build of Azure Data Studio.](https://github.com/microsoft/azuredatastudio#try-out-the-latest-insiders-build-from-main)
126-
127-
## Uninstall Azure Data Studio
128-
129-
If you installed [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] using the Windows Installer, then uninstall the same way you remove any Windows application.
130-
131-
If you installed [!INCLUDE[name-sos-short](../includes/name-sos-short.md)] with a .zip or other archive, then simply delete the files.
125+
In general, users should download the stable release of Azure Data Studio above. However, if you want to try out the beta features and send feedback, you can download the [Insiders build of Azure Data Studio](https://github.com/microsoft/azuredatastudio#try-out-the-latest-insiders-build-from-main).
132126

133127
## Supported Operating Systems
134128

@@ -169,42 +163,73 @@ Azure Data Studio runs on Windows, macOS, and Linux, and is supported on the fol
169163

170164
## Check for updates
171165

172-
To check for latest updates, click the gear icon on the bottom left of the window and click **Check for Updates**.
166+
To check for latest updates, select the gear icon on the bottom left of the window and select **Check for Updates**.
173167

174-
In an offline environment updates can be applied by [installing the latest version](#download-and-install-azure-data-studio) directly over a previously installed version. Uninstalling prior versions of Azure Data Studio is not necessary as the installer updates a currently installed application, if present.
168+
Offline environment updates can be applied by [installing the latest version](#download-and-install-azure-data-studio) directly over a previously installed version. Uninstalling prior versions of Azure Data Studio isn't necessary. The installer updates a currently installed application, if present.
175169

176170
## Supported SQL offerings
177171

178172
- This version of Azure Data Studio works with all [supported versions of SQL Server 2014 - [!INCLUDE[sql-server-2019](../includes/sssqlv15-md.md)]](https://support.microsoft.com/lifecycle?C2=1044) and provides support for working with the latest cloud features in Azure SQL Database and Azure Synapse Analytics. Azure Data Studio also provides preview support for Azure SQL Managed Instance.
179173

180-
## Upgrade from SQL Operations Studio
181-
182-
If you are still using SQL Operations Studio, you need to upgrade to Azure Data Studio. SQL Operations Studio was the preview name and preview version of Azure Data Studio. In September 2018, we [changed the name to Azure Data Studio](https://cloudblogs.microsoft.com/sqlserver/2018/09/25/azure-data-studio-for-sql-server/) and released the General Availability (GA) version. Because SQL Operations Studio is no longer being updated or supported, we ask all SQL Operations Studio users to download the latest version of Azure Data Studio to get the latest features, security updates, and fixes.
183-
184-
When upgrading from the old preview to the latest Azure Data Studio, you will lose your current settings and extensions. To move your settings, follow the instructions in the following *Move user settings* section:
185-
186174
## Move user settings
187175

188-
If you want to move your custom settings, keyboard shortcuts, or code snippets, follow the steps below. This is important to do if you are upgrading from SQL Operations Studio version to Azure Data Studio.
176+
If you want to move your custom settings, keyboard shortcuts, or code snippets, follow the steps below. This is important to do if you're upgrading from SQL Operations Studio version to Azure Data Studio.
189177

190178
*If you already have Azure Data Studio, or you've never installed or customized SQL Operations Studio, then you can ignore this section.*
191179

192-
1. Open Settings by clicking the gear on the bottom left and clicking **Settings.**
180+
1. Open Settings by selecting the gear on the bottom left and selecting **Settings.**
193181

194182
![edit settings in Azure Data Studio](./media/download/open-settings.png)
195183

196-
2. Right-click the **User Settings** tab on top and click **Reveal in Explorer**
184+
2. Right-click the **User Settings** tab on top and select **Reveal in Explorer**
197185

198186
![launch explorer which will take you to your local file system](./media/download/reveal-in-explorer.png)
199187

200188
3. Copy all files in this folder and save in an easy to find location on your local drive, like your Documents folder.
201189

202190
![use the files and copy over to your location](./media/download/copy-settings.png)
203191

204-
4. In your new version of Azure Data Studio, follow steps 1-2, then for step 3 paste the contents you saved into the folder. You can also manually copy over the settings, keybindings, or snippets in their respective locations.
192+
4. In your new version of Azure Data Studio, follow steps 1-2, then for step 3 paste the contents you saved into the folder. You can also manually copy over the settings, key bindings, or snippets in their respective locations.
205193

206194
5. If overriding an existing installation, delete the old install directory before installation to avoid errors connecting to your Azure account for the resource explorer.
207195

196+
## Unattended install for Windows
197+
198+
You can also install Azure Data Studio using a command prompt script.
199+
200+
If you want to install Azure Data Studio in the background with no GUI prompts and you're on the Windows platform, then follow the steps below.
201+
202+
1. Launch the command prompt with elevated permissions.
203+
204+
2. Type the command below in the command prompt.
205+
206+
```console
207+
<path where the azuredatastudio-windows-user-setup-x.xx.x.exe file is located> /VERYSILENT /MERGETASKS=!runcode>
208+
```
209+
210+
Example:
211+
212+
```console
213+
%systemdrive%\azuredatastudio-windows-user-setup-1.23.0.exe /VERYSILENT /MERGETASKS=!runcode
214+
```
215+
216+
> [!Note]
217+
> The example also works with the system installer file.
218+
>
219+
> ```console
220+
> <path where the azuredatastudio-windows-setup-x.xx.x.exe file is located> /VERYSILENT /MERGETASKS=!runcode>
221+
> ```
222+
223+
You can also pass */SILENT* instead of */VERYSILENT* to see the setup UI.
224+
225+
3. If all goes well, you can see Azure Data Studio installed.
226+
227+
## Uninstall Azure Data Studio
228+
229+
If you installed Azure Data Studio using the Windows Installer, then uninstall the same way you remove any Windows application.
230+
231+
If you installed Azure Data Studio with a .zip or other archive, then delete the files.
232+
208233
## Next Steps
209234

210235
See one of the following quickstarts to get started:

0 commit comments

Comments
 (0)