SqlServerDsc icon indicating copy to clipboard operation
SqlServerDsc copied to clipboard

SqlServerDsc.Common: Rename parameter for Connect-Sql

Open johlju opened this issue 5 years ago • 2 comments

Details of the scenario you tried and the problem that is occurring

The helper function Connect-SQL should have the parameter SetupCredential renamed to ImpersonateAsCredentials to more clearly indicate that impersonation should be made using SQL Server Database Engine instance credentials.

https://github.com/dsccommunity/SqlServerDsc/blob/25a59632cb82796e1eb998dda734ec6aff7deece/source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1#L486

This will be more relevant with the issue https://github.com/dsccommunity/SqlServerDsc/issues/1579.

Verbose logs showing the problem

n/a

Suggested solution to the issue

See above.

The DSC configuration that is used to reproduce the issue (as detailed as possible)

n/a

SQL Server edition and version the target node is running

Any

SQL Server PowerShell modules present on the target node

n/a

The operating system the target node is running

Any

Version and build of PowerShell the target node is running

n/a

Version of the DSC module that was used

n/a

johlju avatar Jul 22 '20 17:07 johlju

this could be done using an parameter alias. that way it would not be a breaking change and can this change be done resource after resource.

Fiander avatar Dec 10 '20 10:12 Fiander

I would not consider this a breaking change since it would not affect any user configurations. All resources that uses this cmdlet should be change too.

johlju avatar Dec 10 '20 18:12 johlju