Skip to content

Commit d621ea4

Browse files
CopilotCopilot
authored
Rename *-SqlDscBIReportServer to *-SqlDscPowerBIReportServer (#2363)
1 parent 1110653 commit d621ea4

14 files changed

+82
-75
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2424

2525
### Changed
2626

27+
- Renamed commands `*-SqlDscBIReportServer` to `*-SqlDscPowerBIReportServer` for
28+
clarity. The old names `*-SqlDscBIReportServer` and `*-SqlDscPBIReportServer`
29+
are available as aliases for backward compatibility
30+
([issue #2071](https://github.com/dsccommunity/SqlServerDsc/issues/2071)).
2731
- `SqlPermission`
2832
- Refactored to use the new object-based server permission commands
2933
(`Grant-SqlDscServerPermission`, `Deny-SqlDscServerPermission`,

‎azure-pipelines.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -587,15 +587,15 @@ stages:
587587
'tests/Integration/Commands/Save-SqlDscSqlServerMediaFile.Integration.Tests.ps1'
588588
'tests/Integration/Commands/Import-SqlDscPreferredModule.Integration.Tests.ps1'
589589
# Group 1
590-
'tests/Integration/Commands/Install-SqlDscBIReportServer.Integration.Tests.ps1'
590+
'tests/Integration/Commands/Install-SqlDscPowerBIReportServer.Integration.Tests.ps1'
591591
# Group 2
592592
'tests/Integration/Commands/Get-SqlDscInstalledInstance.Integration.Tests.ps1'
593593
'tests/Integration/Commands/Get-SqlDscRSSetupConfiguration.Integration.Tests.ps1'
594594
'tests/Integration/Commands/Test-SqlDscRSInstalled.Integration.Tests.ps1'
595595
# Group 8
596-
'tests/Integration/Commands/Repair-SqlDscBIReportServer.Integration.Tests.ps1'
596+
'tests/Integration/Commands/Repair-SqlDscPowerBIReportServer.Integration.Tests.ps1'
597597
# Group 9
598-
'tests/Integration/Commands/Uninstall-SqlDscBIReportServer.Integration.Tests.ps1'
598+
'tests/Integration/Commands/Uninstall-SqlDscPowerBIReportServer.Integration.Tests.ps1'
599599
)
600600
name: test
601601
displayName: 'Run Integration Test'

‎source/Classes/020.SqlRSSetup.ps1‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ class SqlRSSetup : ResourceBase
474474
{
475475
Write-Verbose -Message $this.localizedData.Installing_PowerBIReportServer
476476

477-
$exitCode = Install-SqlDscBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
477+
$exitCode = Install-SqlDscPowerBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
478478

479479
break
480480
}
@@ -483,7 +483,7 @@ class SqlRSSetup : ResourceBase
483483
{
484484
Write-Verbose -Message $this.localizedData.Repairing_PowerBIReportServer
485485

486-
$exitCode = Repair-SqlDscBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
486+
$exitCode = Repair-SqlDscPowerBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
487487

488488
break
489489
}
@@ -492,7 +492,7 @@ class SqlRSSetup : ResourceBase
492492
{
493493
Write-Verbose -Message $this.localizedData.Uninstalling_PowerBIReportServer
494494

495-
$exitCode = Uninstall-SqlDscBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
495+
$exitCode = Uninstall-SqlDscPowerBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
496496

497497
break
498498
}

source/Public/Install-SqlDscBIReportServer.ps1 renamed to source/Public/Install-SqlDscPowerBIReportServer.ps1

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,33 +71,34 @@
7171
No output is generated when PassThru is not specified.
7272
7373
.EXAMPLE
74-
Install-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe'
74+
Install-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe'
7575
7676
Installs Power BI Report Server with default settings.
7777
7878
.EXAMPLE
79-
Install-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -ProductKey '12345-12345-12345-12345-12345'
79+
Install-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -ProductKey '12345-12345-12345-12345-12345'
8080
8181
Installs Power BI Report Server using a product key.
8282
8383
.EXAMPLE
84-
Install-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -Edition 'Evaluation' -InstallFolder 'C:\Program Files\Power BI Report Server'
84+
Install-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -Edition 'Evaluation' -InstallFolder 'C:\Program Files\Power BI Report Server'
8585
8686
Installs Power BI Report Server in evaluation edition to a custom folder.
8787
8888
.EXAMPLE
89-
Install-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -ProductKey '12345-12345-12345-12345-12345' -EditionUpgrade -LogPath 'C:\Logs\PowerBIReportServer_Install.log'
89+
Install-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -ProductKey '12345-12345-12345-12345-12345' -EditionUpgrade -LogPath 'C:\Logs\PowerBIReportServer_Install.log'
9090
9191
Installs Power BI Report Server and upgrades the edition using a product key. Also specifies a custom log path.
9292
9393
.EXAMPLE
94-
$exitCode = Install-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -PassThru
94+
$exitCode = Install-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -PassThru
9595
9696
Installs Power BI Report Server with default settings and returns the setup exit code.
9797
#>
98-
function Install-SqlDscBIReportServer
98+
function Install-SqlDscPowerBIReportServer
9999
{
100100
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'Because ShouldProcess is used in Invoke-SetupAction')]
101+
[Alias('Install-SqlDscBIReportServer', 'Install-SqlDscPBIReportServer')]
101102
[CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
102103
[OutputType([System.Int32])]
103104
param

source/Public/Repair-SqlDscBIReportServer.ps1 renamed to source/Public/Repair-SqlDscPowerBIReportServer.ps1

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,29 +66,30 @@
6666
code as System.Int32.
6767
6868
.EXAMPLE
69-
Repair-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe'
69+
Repair-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe'
7070
7171
Repairs Power BI Report Server with default settings.
7272
7373
.EXAMPLE
74-
Repair-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -ProductKey '12345-12345-12345-12345-12345' -EditionUpgrade
74+
Repair-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -ProductKey '12345-12345-12345-12345-12345' -EditionUpgrade
7575
7676
Repairs Power BI Report Server and upgrades the edition using a
7777
product key.
7878
7979
.EXAMPLE
80-
Repair-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -LogPath 'C:\Logs\PowerBIReportServer_Repair.log'
80+
Repair-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -LogPath 'C:\Logs\PowerBIReportServer_Repair.log'
8181
8282
Repairs Power BI Report Server and specifies a custom log path.
8383
8484
.EXAMPLE
85-
$exitCode = Repair-SqlDscBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -PassThru
85+
$exitCode = Repair-SqlDscPowerBIReportServer -AcceptLicensingTerms -MediaPath 'E:\PowerBIReportServer.exe' -PassThru
8686
8787
Repairs Power BI Report Server with default settings and returns the setup exit code.
8888
#>
89-
function Repair-SqlDscBIReportServer
89+
function Repair-SqlDscPowerBIReportServer
9090
{
9191
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'Because ShouldProcess is used in Invoke-SetupAction')]
92+
[Alias('Repair-SqlDscBIReportServer', 'Repair-SqlDscPBIReportServer')]
9293
[CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
9394
[OutputType([System.Int32])]
9495
param

source/Public/Uninstall-SqlDscBIReportServer.ps1 renamed to source/Public/Uninstall-SqlDscPowerBIReportServer.ps1

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,28 +43,29 @@
4343
No output when PassThru is not specified.
4444
4545
.EXAMPLE
46-
Uninstall-SqlDscBIReportServer -MediaPath 'E:\PowerBIReportServer.exe'
46+
Uninstall-SqlDscPowerBIReportServer -MediaPath 'E:\PowerBIReportServer.exe'
4747
4848
Uninstalls Power BI Report Server.
4949
5050
.EXAMPLE
51-
Uninstall-SqlDscBIReportServer -MediaPath 'E:\PowerBIReportServer.exe' -LogPath 'C:\Logs\PowerBIReportServer_Uninstall.log'
51+
Uninstall-SqlDscPowerBIReportServer -MediaPath 'E:\PowerBIReportServer.exe' -LogPath 'C:\Logs\PowerBIReportServer_Uninstall.log'
5252
5353
Uninstalls Power BI Report Server and specifies a custom log path.
5454
5555
.EXAMPLE
56-
Uninstall-SqlDscBIReportServer -MediaPath 'E:\PowerBIReportServer.exe' -Force
56+
Uninstall-SqlDscPowerBIReportServer -MediaPath 'E:\PowerBIReportServer.exe' -Force
5757
5858
Uninstalls Power BI Report Server without prompting for confirmation.
5959
6060
.EXAMPLE
61-
$exitCode = Uninstall-SqlDscBIReportServer -MediaPath 'E:\PowerBIReportServer.exe' -PassThru
61+
$exitCode = Uninstall-SqlDscPowerBIReportServer -MediaPath 'E:\PowerBIReportServer.exe' -PassThru
6262
6363
Uninstalls Power BI Report Server and returns the setup exit code.
6464
#>
65-
function Uninstall-SqlDscBIReportServer
65+
function Uninstall-SqlDscPowerBIReportServer
6666
{
6767
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSShouldProcess', '', Justification = 'Because ShouldProcess is used in Invoke-SetupAction')]
68+
[Alias('Uninstall-SqlDscBIReportServer', 'Uninstall-SqlDscPBIReportServer')]
6869
[CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')]
6970
[OutputType([System.Int32])]
7071
param

tests/Integration/Commands/Install-SqlDscBIReportServer.Integration.Tests.ps1 renamed to tests/Integration/Commands/Install-SqlDscPowerBIReportServer.Integration.Tests.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ BeforeAll {
2929
Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
3030
}
3131

32-
Describe 'Install-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
32+
Describe 'Install-SqlDscPowerBIReportServer' -Tag @('Integration_PowerBI') {
3333
BeforeAll {
3434
Write-Verbose -Message ('Running integration test as user ''{0}''.' -f $env:UserName) -Verbose
3535

@@ -42,7 +42,7 @@ Describe 'Install-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
4242
Context 'When installing Power BI Report Server' {
4343
# cSpell: ignore PBIRS
4444
It 'Should run the command without throwing' {
45-
# Set splatting parameters for Install-SqlDscBIReportServer
45+
# Set splatting parameters for Install-SqlDscPowerBIReportServer
4646
$installSqlDscBIReportServerParameters = @{
4747
AcceptLicensingTerms = $true
4848
MediaPath = $powerBIReportServerExecutable
@@ -54,7 +54,7 @@ Describe 'Install-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
5454
Force = $true
5555
}
5656

57-
$null = Install-SqlDscBIReportServer @installSqlDscBIReportServerParameters -ErrorAction 'Stop'
57+
$null = Install-SqlDscPowerBIReportServer @installSqlDscBIReportServerParameters -ErrorAction 'Stop'
5858
}
5959

6060
It 'Should have installed Power BI Report Server' {

‎tests/Integration/Commands/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,12 +174,12 @@ Command | Run order # | Depends on # | Use instance | Creates persistent objects
174174
Prerequisites | 0 | - | - | Sets up dependencies
175175
Save-SqlDscSqlServerMediaFile | 0 | - | - | Downloads SQL Server media files
176176
Import-SqlDscPreferredModule | 0 | - | - | -
177-
Install-SqlDscBIReportServer | 1 | 0 (Prerequisites) | - | PBIRS instance
178-
Get-SqlDscInstalledInstance | 2 | 1 (Install-SqlDscBIReportServer), 0 (Prerequisites) | PBIRS | -
179-
Get-SqlDscRSSetupConfiguration | 2 | 1 (Install-SqlDscBIReportServer), 0 (Prerequisites) | PBIRS | -
180-
Test-SqlDscRSInstalled | 2 | 1 (Install-SqlDscBIReportServer), 0 (Prerequisites) | PBIRS | -
181-
Repair-SqlDscBIReportServer | 8 | 1 (Install-SqlDscBIReportServer) | PBIRS | -
182-
Uninstall-SqlDscBIReportServer | 9 | 8 (Repair-SqlDscBIReportServer) | - | -
177+
Install-SqlDscPowerBIReportServer | 1 | 0 (Prerequisites) | - | PBIRS instance
178+
Get-SqlDscInstalledInstance | 2 | 1 (Install-SqlDscPowerBIReportServer), 0 (Prerequisites) | PBIRS | -
179+
Get-SqlDscRSSetupConfiguration | 2 | 1 (Install-SqlDscPowerBIReportServer), 0 (Prerequisites) | PBIRS | -
180+
Test-SqlDscRSInstalled | 2 | 1 (Install-SqlDscPowerBIReportServer), 0 (Prerequisites) | PBIRS | -
181+
Repair-SqlDscPowerBIReportServer | 8 | 1 (Install-SqlDscPowerBIReportServer) | PBIRS | -
182+
Uninstall-SqlDscPowerBIReportServer | 9 | 8 (Repair-SqlDscPowerBIReportServer) | - | -
183183
<!-- markdownlint-enable MD013 -->
184184

185185
## Integration Tests

tests/Integration/Commands/Repair-SqlDscBIReportServer.Integration.Tests.ps1 renamed to tests/Integration/Commands/Repair-SqlDscPowerBIReportServer.Integration.Tests.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ BeforeAll {
2929
Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
3030
}
3131

32-
Describe 'Repair-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
32+
Describe 'Repair-SqlDscPowerBIReportServer' -Tag @('Integration_PowerBI') {
3333
BeforeAll {
3434
Write-Verbose -Message ('Running integration test as user ''{0}''.' -f $env:UserName) -Verbose
3535

@@ -50,7 +50,7 @@ Describe 'Repair-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
5050

5151
Context 'When repairing BI Report Server' {
5252
It 'Should run the command without throwing' {
53-
# Set splatting parameters for Repair-SqlDscBIReportServer
53+
# Set splatting parameters for Repair-SqlDscPowerBIReportServer
5454
$repairSqlDscBIReportServerParameters = @{
5555
AcceptLicensingTerms = $true
5656
MediaPath = $powerBIReportServerExecutable
@@ -61,7 +61,7 @@ Describe 'Repair-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
6161
Force = $true
6262
}
6363

64-
$null = Repair-SqlDscBIReportServer @repairSqlDscBIReportServerParameters
64+
$null = Repair-SqlDscPowerBIReportServer @repairSqlDscBIReportServerParameters
6565
}
6666

6767
It 'Should still have a Power BI Report Server service running after repair' {

tests/Integration/Commands/Uninstall-SqlDscBIReportServer.Integration.Tests.ps1 renamed to tests/Integration/Commands/Uninstall-SqlDscPowerBIReportServer.Integration.Tests.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ BeforeAll {
2929
Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
3030
}
3131

32-
Describe 'Uninstall-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
32+
Describe 'Uninstall-SqlDscPowerBIReportServer' -Tag @('Integration_PowerBI') {
3333
BeforeAll {
3434
Write-Verbose -Message ('Running integration test as user ''{0}''.' -f $env:UserName) -Verbose
3535

@@ -50,7 +50,7 @@ Describe 'Uninstall-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
5050

5151
Context 'When uninstalling BI Report Server' {
5252
It 'Should run the command without throwing' {
53-
# Set splatting parameters for Uninstall-SqlDscBIReportServer
53+
# Set splatting parameters for Uninstall-SqlDscPowerBIReportServer
5454
$uninstallSqlDscBIReportServerParameters = @{
5555
MediaPath = $powerBIReportServerExecutable
5656
LogPath = Join-Path -Path $script:temporaryFolder -ChildPath 'SSRS_Uninstall.log'
@@ -60,7 +60,7 @@ Describe 'Uninstall-SqlDscBIReportServer' -Tag @('Integration_PowerBI') {
6060
Force = $true
6161
}
6262

63-
$null = Uninstall-SqlDscBIReportServer @uninstallSqlDscBIReportServerParameters
63+
$null = Uninstall-SqlDscPowerBIReportServer @uninstallSqlDscBIReportServerParameters
6464
}
6565

6666
It 'Should not have a Power BI Report Server service' {

0 commit comments

Comments
 (0)