Stop‑SqlDscRSWebService - dsccommunity/SqlServerDsc GitHub Wiki

Stops the Reporting Services web service.

Stop-SqlDscRSWebService [-Configuration] <Object> [-Force] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Stops the SQL Server Reporting Services or Power BI Report Server web service by calling the SetServiceState WMI method with EnableWebService set to $false.

This command preserves the current state of the Windows service. If the web service is already disabled, the command proceeds without error (idempotent behavior).

The configuration CIM instance can be obtained using the Get-SqlDscRSConfiguration command and passed via the pipeline.

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Stop-SqlDscRSWebService

Stops the web service for the SSRS instance by piping the configuration from Get-SqlDscRSConfiguration.

$config = Get-SqlDscRSConfiguration -InstanceName 'SSRS'
Stop-SqlDscRSWebService -Configuration $config -Force

Stops the web service for the SSRS instance without confirmation.

Specifies the MSReportServer_ConfigurationSetting CIM instance for the Reporting Services instance. This can be obtained using the Get-SqlDscRSConfiguration command. This parameter accepts pipeline input.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

If specified, suppresses the confirmation prompt.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.