ReplicationServer.ChangeReplicationServerPasswords Method (ReplicationSecurityMode, String, SecureString)
Changes all stored instances of the password for a login maintained on the replication server using a SecureString object.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Syntax
'Declaration
Public Sub ChangeReplicationServerPasswords ( _
securityMode As ReplicationSecurityMode, _
login As String, _
password As SecureString _
)
'Usage
Dim instance As ReplicationServer
Dim securityMode As ReplicationSecurityMode
Dim login As String
Dim password As SecureString
instance.ChangeReplicationServerPasswords(securityMode, _
login, password)
public void ChangeReplicationServerPasswords(
ReplicationSecurityMode securityMode,
string login,
SecureString password
)
public:
void ChangeReplicationServerPasswords(
ReplicationSecurityMode securityMode,
String^ login,
SecureString^ password
)
member ChangeReplicationServerPasswords :
securityMode:ReplicationSecurityMode *
login:string *
password:SecureString -> unit
public function ChangeReplicationServerPasswords(
securityMode : ReplicationSecurityMode,
login : String,
password : SecureString
)
Parameters
- securityMode
Type: Microsoft.SqlServer.Replication.ReplicationSecurityMode
Is the ReplicationSecurityMode value that specifies whether the login is used for Windows Authentication or SQL Server Authentication.
- login
Type: System.String
Is the login for the stored password being changed.
- password
Type: System.Security.SecureString
Is the password being changed, supplied as a SecureString value.
Security Note When possible, prompt users to enter security credentials at run time. If you must store credentials, use the https://go.microsoft.com/fwlink/?LinkId=34733 cryptographic services provided by the Windows .NET Framework.
Remarks
The ChangeReplicationServerPasswords method is used to update the password for a login used by replication agents to connect to other servers in the replication topology after the password for this login has been changed. This method is used instead of individually changing the password for each stored instance of the login used for each agent connection.
The ChangeReplicationServerPasswords(ReplicationSecurityMode, String, SecureString) method provides additional security for the password while it is stored in memory and should be used instead of ChangeReplicationServerPasswords(ReplicationSecurityMode, String, String).
The ChangeReplicationServerPasswords method can only be called by a member of the sysadmin fixed server role on the replication server.
Calling ChangeReplicationServerPasswords is equivalent to executing sp_changereplicationserverpasswords (Transact-SQL).