Skip to content

Commit 6a20c9f

Browse files
Updates to ADS connection docs and SSMS rel notes
1 parent 7c8a0c6 commit 6a20c9f

5 files changed

Lines changed: 38 additions & 18 deletions

File tree

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

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Explains the Azure connection options available in Azure Data Studi
44
author: erinstellato-ms
55
ms.author: erinstellato
66
ms.reviewer: maghan, randolphwest
7-
ms.date: 03/22/2023
7+
ms.date: 06/06/2023
88
ms.service: azure-data-studio
99
ms.topic: "overview"
1010
---
@@ -76,9 +76,6 @@ Azure Data Studio supports Azure Active Directory (Azure AD) authentication with
7676

7777
:::image type="content" source="media/azure-connectivity/national-clouds.png" alt-text="Screenshot of Azure authentication National Clouds.":::
7878

79-
> [!NOTE]
80-
> Only one National Cloud can be enabled in a session.
81-
8279
## Azure resource configuration
8380

8481
These settings apply filters on Azure resources and tenants.
@@ -184,13 +181,35 @@ If the user application is running in an environment behind a proxy, user authen
184181

185182
As a cross-platform application, ADS proxy resolution fetches the proxy from either setting within the application, or through environment variables. The aim is to avoid interaction with system settings, which can vary significantly on different operating systems.
186183

184+
### Issue: Azure Core extension is disabled
185+
186+
Azure Core extension is `@builtin` extension in Azure Data Studio, please ensure it's not disabled or uninstalled accidentally. This extension is required to be able to authenticate Azure accounts and connect to resources with Azure MFA authentication.
187+
188+
:::image type="content" source="media/azure-connectivity/azure-connectivity-azure-core-extension.png" alt-text="Screenshot of built-in Azure Core extension.":::
189+
190+
### Issue: System CA certificates are expired
191+
192+
Azure Data Studio's default behavior includes validating system's root CA certificates when making REST API calls using HTTPS Protocol. This is controlled by the below setting that is enabled by default:
193+
194+
:::image type="content" source="media/azure-connectivity/azure-connectivity-system-certificates.png" alt-text="Screenshot of system certificates setting.":::
195+
196+
```
197+
"http.systemCertificates": true
198+
```
199+
200+
If a system's Root CA certificate is expired, authentication requests to Azure Active Directory will fail and an error like below would be captured in 'Azure Account' logs:
201+
202+
`error: certificate is expired`
203+
204+
To mitigate this error, you should remove any expired Root CA Certificates or disable the setting to not validate system certificates.
205+
187206
## Capture logs for Azure authentication
188207

189208
Azure Data Studio captures Error events for Azure account activity by default. To enable more detailed traces, users can modify these settings:
190209

191210
### Azure: Logging level
192211

193-
This setting configures the logging level for information from Azure core that can be captured in Azure Data Studio. Change it to *Verbose* or *All* to capture detailed logs that can be useful to diagnose authentication failures. For more information, see [Debug Trace Logging](https://github.com/microsoft/azuredatastudio/wiki/Debug-Trace-Logging) to learn how to capture logging information.
212+
This setting configures the logging level for information from Azure core that can be captured in Azure Data Studio. Change it to *Verbose* or *All* to capture detailed logs that can be useful to diagnose authentication failures. For more information, see [Azure Data Studio logs and location](troubleshooting.md#azure-data-studio-logs-and-location) to learn how to capture logging information.
194213

195214
`Settings.json`
196215

@@ -240,4 +259,4 @@ Execute this command from **Command Palette (Ctrl/CMD + Shift + P)** to clear ac
240259

241260
Execute this command from **Command Palette (Ctrl/CMD + Shift + P)** to remove all linked Azure accounts from Azure Data Studio:
242261

243-
**Clear all saved accounts (clearSavedAccounts)**
262+
**Clear all saved accounts (clearSavedAccounts)**
52.6 KB
Loading
8.82 KB
Loading

docs/azure-data-studio/troubleshooting.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Learn how to get logs and troubleshoot Azure Data Studio, which is
44
author: dzsquared
55
ms.author: drskwier
66
ms.reviewer: hanqin, maghan
7-
ms.date: 11/24/2020
7+
ms.date: 06/06/2023
88
ms.service: azure-data-studio
99
ms.topic: conceptual
1010
ms.custom: updatefrequency5
@@ -24,41 +24,42 @@ File a single issue per problem and feature request.
2424
* Don't enumerate multiple bugs or feature requests in the same issue.
2525
* Don't add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.
2626

27-
The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix.
27+
The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix.
2828

2929
Include the following information with each issue:
3030

3131
* Version of Azure Data Studio
3232
* Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw.
3333
* Images, animations, or a link to a video. Images and animations illustrate repro-steps but don't replace them.
34-
* A code snippet that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue.
34+
* A code snippet that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue.
3535

3636
> [!NOTE]
37-
> Because we need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
37+
> Because we need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.
3838
3939
* Errors in the Dev Tools Console (Help | Toggle Developer Tools)
4040

4141
Please remember to do the following:
4242

43-
* Search the issue repository to see if there exists a duplicate.
44-
* Simplify your code around the issue so we can better isolate the problem.
43+
* Search the issue repository to see if the same issue already exists.
44+
* Simplify your code around the issue so we can better isolate the problem.
4545

4646
Don't feel bad if we can't reproduce the issue and ask for more information!
4747

4848
## How to set the logging level
4949

5050
### Azure Data Studio
51-
Run the `Developer: Set Log Level...` command to select the log level for the current session. This value is NOT persisted over multiple sessions - so if you restart Azure Data Studio it will revert back to the default `Info` level.
51+
Run the `Developer: Set Log Level...` command to select the log level for the current session. This value is NOT persisted over multiple sessions - so if you restart Azure Data Studio it will revert back to the default `Info` level.
5252

53-
If you want to enable debug logging for startup then set the log level to `Debug` and run the `Developer: Reload Window` command
53+
If you want to enable debug logging for startup then set the log level to `Debug` and run the `Developer: Reload Window` command.
5454

5555
### MSSQL (Built-In Extension)
5656

5757
If the `Mssql: Log Debug Info` user setting is set to true, then debug log info will be sent to the `MSSQL` output channel.
5858

5959
The `Mssql: Tracing Level` user setting is used to control the verbosity of the logging.
6060

61-
## Debug log location
61+
## Azure Data Studio logs and location
62+
6263
From Azure Data Studio, run the `Developer: Open Logs Folder` command to open the path to the logs. There's many different types of log files that write there, a few of the commonly used ones are:
6364

6465
1. `renderer#.log` (for example, renderer1.log) - this file is the log file for the main process.
@@ -68,7 +69,7 @@ From Azure Data Studio, run the `Developer: Open Logs Folder` command to open th
6869
* sqltools.log is the log for SQL Tools Service
6970
1. `exthost#/output_logging_#######` - these folders contain the messages displayed in the `Output` panel in Azure Data Studio. Each file is named `#-<Channel Name>` so for example the `Notebooks` output channel may output to a file named `3-Notebooks.log`.
7071

71-
If you are asked to provide logs, zip up the entire folder to ensure that the correct logs are included.
72+
If you are asked to provide logs, zip up the entire folder to ensure that the correct logs are included.
7273

7374
## Next Steps
7475
- [Report an issue](https://github.com/Microsoft/azuredatastudio/issues)

docs/ssms/release-notes-ssms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Release notes for SQL Server Management Studio (SSMS).
44
author: erinstellato-ms
55
ms.author: erinstellato
66
ms.reviewer: maghan
7-
ms.date: 06/02/2023
7+
ms.date: 06/06/2023
88
ms.service: sql
99
ms.subservice: ssms
1010
ms.topic: conceptual
@@ -38,7 +38,7 @@ SSMS 19.1 is the latest general availability (GA) release of SSMS. If you need a
3838
| Azure Data Studio installation integration | The installation of SSMS installs Azure Data Studio 1.44. |
3939
| Always Encrypted | Added support for secure enclaves and in-place encryption in the Always Encrypted Wizard. See [Configure column encryption using Always Encrypted Wizard](/sql/relational-databases/security/encryption/always-encrypted-wizard). |
4040
| Azure SQL Managed Instance | Introduced visibility to the status of the Distributed Transaction Coordinator (DTC) service for Azure SQL Managed Instance. Object Explorer can be used to determine if DTC is enabled on the Azure SQL Managed Instance (within the Management node). See [Distributed Transaction Coordinator (DTC) for Azure SQL Managed Instance](/azure/azure-sql/managed-instance/distributed-transaction-coordinator-dtc). |
41-
| Backup/Restore | Added capability to restore backup files from Amazon S3 storage to SQL Server 2022 and Azure SQL Managed Instance. |
41+
| Backup/Restore | Added capability to restore backup files from S3-compatible storage to SQL Server 2022 and Azure SQL Managed Instance. |
4242
| General SSMS | Updated File Version for ssms.exe to align with product version. |
4343
| General SSMS | Removed deprecated hardware from the list of available service-level objects. |
4444
| General SSMS | Changed the system browser setting, within **Tools > Options > Azure Services**, to default to True. The external browser will be used, instead of the legacy embedded browser. |

0 commit comments

Comments
 (0)