Merge pull request #31688 from erinstellato-ms/debugger

Debugger articles for SSDT

Author: rwestMSFT

.openpublishing.redirection.json

@@ -55292,17 +55292,17 @@
     },
     {
       "source_path": "docs/relational-databases/scripting/specify-a-breakpoint-action.md",
-      "redirect_url": "/sql/ssms/scripting/specify-a-breakpoint-action",
+      "redirect_url": "/sql/ssdt/debugger/specify-breakpoint-action",
       "redirect_document_id": true
     },
     {
       "source_path": "docs/relational-databases/scripting/specify-a-breakpoint-condition.md",
-      "redirect_url": "/sql/ssms/scripting/specify-a-breakpoint-condition",
+      "redirect_url": "/sql/ssdt/debugger/specify-breakpoint-condition",
       "redirect_document_id": true
     },
     {
       "source_path": "docs/relational-databases/scripting/specify-a-breakpoint-filter.md",
-      "redirect_url": "/sql/ssms/scripting/specify-a-breakpoint-filter",
+      "redirect_url": "/sql/ssdt/debugger/specify-breakpoint-filter",
       "redirect_document_id": true
     },
     {
@@ -62789,6 +62789,111 @@
       "source_path": "docs/ssdt/how-to-clone-an-existing-database.md",
       "redirect_url": "/sql/t-sql/statements/create-table-as-clone-of-transact-sql",
       "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssdt/how-to-debug-stored-procedures.md",
+      "redirect_url": "/sql/ssdt/debugger/debug-stored-procedures",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/configure-firewall-rules-before-running-the-tsql-debugger.md",
+      "redirect_url": "/sql/ssdt/debugger/configure-firewall-rules-before-running-tsql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/run-the-transact-sql-debugger.md",
+      "redirect_url": "/sql/ssdt/debugger/run-transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/step-through-transact-sql-code.md",
+      "redirect_url": "/sql/ssdt/debugger/step-through-transact-sql-code",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-breakpoints.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-breakpoints",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/toggle-a-breakpoint.md",
+      "redirect_url": "/sql/ssdt/debugger/toggle-breakpoint",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/enable-disable-and-delete-breakpoints.md",
+      "redirect_url": "/sql/ssdt/debugger/enable-disable-delete-breakpoints",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/specify-a-breakpoint-condition.md",
+      "redirect_url": "/sql/ssdt/debugger/specify-breakpoint-condition",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/specify-a-hit-count.md",
+      "redirect_url": "/sql/ssdt/debugger/specify-hit-count",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/specify-a-breakpoint-filter.md",
+      "redirect_url": "/sql/ssdt/debugger/specify-breakpoint-filter",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/specify-a-breakpoint-action.md",
+      "redirect_url": "/sql/ssdt/debugger/specify-breakpoint-action",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-information.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger-information",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-error-list-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-breakpoints-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-call-stack-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-locals-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-threads-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-command-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-output-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
+    },
+    {
+      "source_path": "docs/ssms/scripting/transact-sql-debugger-watch-window.md",
+      "redirect_url": "/sql/ssdt/debugger/transact-sql-debugger",
+      "redirect_document_id": false
     }
   ]
 }

…ules-before-running-the-tsql-debugger.md …ll-rules-before-running-tsql-debugger.mddocs/ssms/scripting/configure-firewall-rules-before-running-the-tsql-debugger.md renamed to docs/ssdt/debugger/configure-firewall-rules-before-running-tsql-debugger.md docs/ssms/scripting/configure-firewall-rules-before-running-the-tsql-debugger.md renamed to docs/ssdt/debugger/configure-firewall-rules-before-running-tsql-debugger.md

@@ -4,47 +4,31 @@ description: Learn how to configure the Windows Firewall rules before running th
 author: markingmyname
 ms.author: maghan
 ms.reviewer: randolphwest
-ms.date: 05/31/2023
+ms.date: 08/28/2024
 ms.service: sql
-ms.subservice: ssms
+ms.subservice: ssdt
 ms.topic: conceptual
-f1_keywords:
-  - "vs.debug.error.sqlde_accessdenied"
-  - "vs.debug.error.sqlde_register_failed"
-  - "vs.debug.error.sqlde_firewall.remotemachines"
-helpviewer_keywords:
-  - "Transact-SQL debugger, remote connections"
-  - "Windows Firewall [Database Engine], Transact-SQL debugger"
-  - "Transact-SQL debugger, Windows Firewall"
-  - "Transact-SQL debugger, configuring"
-  - "ports [SQL Server], Transact-SQL debugger"
-  - "TCP/IP [SQL Server], port numbers"
-monikerRange: ">=aps-pdw-2016||=azuresqldb-current||=azure-sqldw-latest||>=sql-server-2016||>=sql-server-linux-2017||=azuresqldb-mi-current"
 ---
 # Configure firewall rules before running the Transact-SQL debugger
 
 [!INCLUDE [SQL Server](../../includes/applies-to-version/sqlserver.md)]
 
 Windows Firewall rules must be configured to enable [!INCLUDE [tsql](../../includes/tsql-md.md)] debugging when connected to an instance of the [!INCLUDE [ssDE](../../includes/ssde-md.md)] that is running on a different computer than the [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor.
 
-[!INCLUDE [ssms-old-versions](../../includes/ssms-old-versions.md)]
-
 ## Configure the Transact-SQL debugger
 
-The [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger includes both server-side and client-side components. The server-side debugger components are installed with each instance of the Database Engine from [!INCLUDE [ssVersion2005](../../includes/ssversion2005-md.md)] Service Pack 2 (SP2) or later versions. The client-side debugger components are included:
-
-- When you install the client-side tools from [!INCLUDE [sql2008-md](../../includes/sql2008-md.md)] or later versions
+The [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger includes both server-side and client-side components. The server-side debugger components are installed with each instance of the [!INCLUDE [ssdenoversion-md](../../includes/ssdenoversion-md.md)]. The client-side debugger components are included:
 
-- When you install Microsoft Visual Studio 2010 or later versions
+- When you install Microsoft Visual Studio 2019 or later versions
 
 - When you install [!INCLUDE [ssBIDevStudioFull](../../includes/ssbidevstudiofull-md.md)] from the web download
 
-There are no configuration requirements to run the [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger when SQL Server Management Studio or [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] is running on the same computer as the instance of the [!INCLUDE [ssDEnoversion](../../includes/ssdenoversion-md.md)]. However, to run the [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger when connected to a remote instance of the [!INCLUDE [ssDE](../../includes/ssde-md.md)], program and port rules in the Windows Firewall must be enabled on both computers. These rules may be created by [!INCLUDE [ssNoVersion](../../includes/ssnoversion-md.md)] setup. If you get errors attempting to open a remote debugging session, ensure the following firewall rules are defined on your computer.
+There are no configuration requirements to run the [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger when [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] is running on the same computer as the instance of the [!INCLUDE [ssDEnoversion](../../includes/ssdenoversion-md.md)]. However, to run the [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger when connected to a remote instance of the [!INCLUDE [ssDE](../../includes/ssde-md.md)], program and port rules in the Windows Firewall must be enabled on both computers. If you get errors attempting to open a remote debugging session, ensure the following firewall rules are defined on your computer.
 
 Use the **Windows Firewall with Advanced Security** application to manage the firewall rules. In both [!INCLUDE [win7](../../includes/win7-md.md)] and [!INCLUDE [winserver2008r2](../../includes/winserver2008r2-md.md)], open **Control Panel**, open **Windows Firewall**, and select **Advanced settings**. In [!INCLUDE [winserver2008r2](../../includes/winserver2008r2-md.md)], you can also open **Service Manager**, expand **Configuration** in the left pane, and expand **Windows Firewall with Advanced Security**.
 
 > [!CAUTION]  
-> Enabling rules in the Windows Firewall may expose your computer to security threats that the firewall is designed to block. Enabling rules for remote debugging unblocks the ports and programs listed in this topic.
+> Enabling rules in the Windows Firewall can expose your computer to security threats that the firewall is designed to block. Enabling rules for remote debugging unblocks the ports and programs listed in this topic.
 
 ## Firewall rules on the server
 
@@ -56,7 +40,7 @@ On the computer that is running the instance of the [!INCLUDE [ssDE](../../inclu
 
    1. In the **Rule Type** dialog, select **Program**, and then select **Next**.
 
-   1. In the **Program** dialog, select **This program path:** and enter the full path to `sqlservr.exe` for this instance. By default, `sqlservr.exe` is installed in `C:\Program Files\Microsoft SQL Server\MSSQL13.<InstanceName>\MSSQL\Binn`, where `<InstanceName>` is `MSSQLSERVER` for the default instance, and the instance name for any named instance.
+   1. In the **Program** dialog, select **This program path:** and enter the full path to `sqlservr.exe` for this instance. By default, `sqlservr.exe` is installed in `C:\Program Files\Microsoft SQL Server\MSSQL16.<InstanceName>\MSSQL\Binn`, where `<InstanceName>` is `MSSQLSERVER` for the default instance, and the instance name for any named instance.
 
    1. In the **Action** dialog, select **Allow the connection**, and select **Next**.
 
@@ -70,7 +54,7 @@ On the computer that is running the instance of the [!INCLUDE [ssDE](../../inclu
 
    1. Select **TCP** in the **Protocol type:** box, select **RPC Dynamic Ports** in the **Local port:** box, select **Apply**, and then select **OK**.
 
-- Add an inbound program rule for `svchost.exe` to enable DCOM communications from remote debugger sessions.
+- Add an inbound program rule for `svchost.exe` to enable Distributed Component Object Model (DCOM) communications from remote debugger sessions.
 
    1. In **Windows Firewall with Advanced Security**, in the left pane, right-click **Inbound Rules**, and then select **New Rule** in the action pane.
 
@@ -94,7 +78,7 @@ On the computer that is running the instance of the [!INCLUDE [ssDE](../../inclu
 
 ## Firewall rules on the client
 
-On the computer that is running the [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor, the SQL Server setup or [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] setup may have configured the Windows Firewall to allow remote debugging.
+On the computer that is running the [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor, configure the Windows Firewall to allow remote debugging.
 
 If you get errors attempting to open a remote debugging session, you can manually configure the program and port exceptions by using **Windows Firewall with Advanced Security** to configure firewall rules:
 
@@ -118,23 +102,21 @@ If you get errors attempting to open a remote debugging session, you can manuall
 
    1. Select **TCP** in the **Protocol type:** box, select **RPC Endpoint Mapper** in the **Local port:** box, select **Apply**, and then select **OK**.
 
-- Add a program entry for the application hosting the [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor. If you need to open remote debugging sessions from both SQL Server Management Studio and [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] on the same computer, you must add a program rule for both:
+- Add a program entry for the application hosting the [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor. If you need to open remote debugging sessions from multiple installations of [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] on the same computer, you must add a program rule for both:
 
    1. In **Windows Firewall with Advanced Security**, in the left pane, right-click **Inbound Rules**, and then select **New Rule** in the action pane.
 
    1. In the **Rule Type** dialog, select **Program**, and then select **Next**.
 
    1. In the **Program** dialog, select **This program path:** and enter one of these three values.
 
-       - For SQL Server Management Studio, enter the full path to ssms.exe. By default, ssms.exe is installed in `C:\Program Files (x86)\Microsoft SQL Server\130\Tools\Binn\Management Studio`.
-
        - For [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] enter the full path to `devenv.exe`:
 
-            1. By default, the `devenv.exe` for Visual Studio 2010 is in `C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE`.
+            1. By default, the `devenv.exe` for Visual Studio 2022 is in `C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE`.
 
-            1. By default, the `devenv.exe` for Visual Studio 2012 is in `C:\Program Files (x86)\Microsoft Visual Studio 11.0\Common7\IDE`.
+            1. By default, the `devenv.exe` for Visual Studio 2019 is in `C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\IDE`.
 
-            1. You can find the path to ssms.exe from the shortcut you use to launch SQL Server Management Studio. You can find the path to `devenv.exe` from the shortcut you use to launch [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)]. Right-click the shortcut and select **Properties**. The executable and path are listed in the **Target** box.
+            1. You can find the path to `devenv.exe` from the shortcut you use to launch [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)]. Right-click the shortcut and select **Properties**. The executable and path are listed in the **Target** box.
 
    1. In the **Action** dialog, select **Allow the connection**, and select **Next**.
 
@@ -152,18 +134,18 @@ If you get errors attempting to open a remote debugging session, you can manuall
 
 All attempts to start the [!INCLUDE [tsql](../../includes/tsql-md.md)] debugger must also meet the following requirements:
 
-- SQL Server Management Studio or [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] must be running under a Windows account that is a member of the **sysadmin** fixed server role.
+- [!INCLUDE [ssBIDevStudio](../../includes/ssbidevstudio-md.md)] must be running under a Windows account that is a member of the **sysadmin** fixed server role.
 
 - The [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor window must be connected by using either a Windows Authentication or [!INCLUDE [ssNoVersion](../../includes/ssnoversion-md.md)] Authentication login that is a member of the **sysadmin** fixed server role.
 
-- The [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor window must be connected to an instance of the [!INCLUDE [ssDE](../../includes/ssde-md.md)] from [!INCLUDE [ssVersion2005](../../includes/ssversion2005-md.md)] Service Pack 2 (SP2) or later versions. You can't run the debugger when the Query Editor window is connected to an instance that is in single-user mode.
+- The [!INCLUDE [ssDE](../../includes/ssde-md.md)] Query Editor window must be connected to an instance of the [!INCLUDE [ssdenoversion-md](../../includes/ssdenoversion-md.md)]. You can't run the debugger when the Query Editor window is connected to an instance that is in single-user mode.
 
 - The server needs to communicate back to the client via RPC. The account under which SQL Server service is running must have authenticated permissions to the client.
 
-## Next steps
+## Related content
 
 - [Transact-SQL Debugger](./transact-sql-debugger.md)
-- [Run the Transact-SQL Debugger](./run-the-transact-sql-debugger.md)
+- [Run the Transact-SQL Debugger](./run-transact-sql-debugger.md)
 - [Step Through Transact-SQL Code](./step-through-transact-sql-code.md)
+- [Debug Stored Procedures](debug-stored-procedures.md)
 - [Transact-SQL Debugger Information](./transact-sql-debugger-information.md)
-- [Database Engine Query Editor (SQL Server Management Studio)](../f1-help/database-engine-query-editor-sql-server-management-studio.md)