dsccommunity / dsccommunity/SqlServerDsc
SqlServerDsc.Common: Rename parameter for Connect-Sql
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 385
- Forks
- 224
- PR merge metrics
- No merged PRs in 30d
Description
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.
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1 around line 486, where Connect-SQL is defined. Search the module for Connect-SQL and SetupCredential usages before making the rename. Done means the parameter and its references consistently use ImpersonateAsCredentials.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- databases
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100