COMMAND EVERYTHING.

Set-RDDatabaseConnectionString

Configures the database connection string for the database server used in a high availability environment.

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft RemoteDesktop reference: Configures the database connection string for the database server used in a high availability environment. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-RDDatabaseConnectionString [[-DatabaseConnectionString] <String>]
 [[-DatabaseSecondaryConnectionString] <String>] [[-ConnectionBroker] <String>] [-RestoreDatabaseConnection]
 [-RestoreDBConnectionOnAllBrokers] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-RDDatabaseConnectionString. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / RemoteDesktop · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-ConnectionBroker: Specifies the RD Connection Broker server for a remote desktop deployment. If you do not supply a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
-DatabaseConnectionString: Specifies the database connection string. The database connection string supports both high availability configurations: - Dedicated database server. Uses Windows Authentication to connect to the database. - Shared database server. Uses database authentication (such as SQL authentication) with a user name and password to connect to the database.
-DatabaseSecondaryConnectionString: Specifies the secondary database connection string optionally used to support password expiration. Specify the secondary connection string if the high availability configuration uses a shared database server in which authentication to the database requires a user name and password.
-RestoreDBConnectionOnAllBrokers: Indicates that this operation restores the database connection string(s) on all RD Connection Brokers in a deployment to re-establish database connectivity. If you specify this parameter, you must also specify the *RestoreDatabaseConnection* parameter.
-RestoreDatabaseConnection: Indicates that this operation restores the database connection string(s) when database access is lost for dedicated or shared configurations. You can use Set-RDDatabaseConnectionString on the active management broker to restore the database connection string(s) on the specified broker, or you can specify the *RestoreDBConnectionOnAllBrokers* parameter to restore the database connection string(s) on all RD Connection Brokers in the deployment.

Prerequisites

Windows with the RemoteDesktop module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Set a remote desktop database connection string

Set-RDDatabaseConnectionString -ConnectionBroker "Rdcb.Contoso.com" -DatabaseConnectionString "DRIVER=SQL Server Native Client 10.0;SERVER=Sqlserver.Contoso.com;Trusted_Connection=Yes;APP=Remote Desktop Services Connection Broker;Database=RemoteDesktopDeployment"

This command sets the database connection string for the RD Connection Broker named Rdcb.Contoso.com. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/RemoteDesktop/Set-RDDatabaseConnectionString.md

https://learn.microsoft.com/powershell/module/remotedesktop/set-rddatabaseconnectionstring?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands