Remove‑SqlDscRSEncryptedInformation - dsccommunity/SqlServerDsc GitHub Wiki

SYNOPSIS

Removes encrypted information from SQL Server Reporting Services.

SYNTAX

Remove-SqlDscRSEncryptedInformation [-Configuration] <Object> [-PassThru] [-Force]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes all encrypted information stored in the SQL Server Reporting Services or Power BI Report Server database by calling the DeleteEncryptedInformation method on the MSReportServer_ConfigurationSetting CIM instance.

This command deletes all encrypted data stored in the report server database, including stored credentials, connection strings, and other sensitive data.

WARNING: This is a destructive operation. After removing encrypted information, stored credentials and connection strings are permanently deleted and cannot be recovered. The report server will need to be re-initialized and data sources will need to be reconfigured with new credentials.

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

EXAMPLES

EXAMPLE 1

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Remove-SqlDscRSEncryptedInformation

Removes all encrypted information from the Reporting Services instance.

EXAMPLE 2

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Remove-SqlDscRSEncryptedInformation -Force

Removes all encrypted information without confirmation.

EXAMPLE 3

Get-SqlDscRSConfiguration -InstanceName 'SSRS' | Remove-SqlDscRSEncryptedInformation -PassThru

Removes all encrypted information and returns the configuration CIM instance.

PARAMETERS

-Configuration

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

-Force

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

-PassThru

If specified, returns the configuration CIM instance after removing the encrypted information.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Confirm

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

-WhatIf

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

CommonParameters

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

INPUTS

Microsoft.Management.Infrastructure.CimInstance

Accepts MSReportServer_ConfigurationSetting CIM instance via pipeline.

OUTPUTS

None. By default, this command does not generate any output.

Microsoft.Management.Infrastructure.CimInstance

When PassThru is specified, returns the MSReportServer_ConfigurationSetting

CIM instance.

NOTES

This is a destructive operation. Ensure you understand the impact before removing encrypted information. The Reporting Services service may need to be restarted after this operation.

RELATED LINKS

https://docs.microsoft.com/en-us/sql/reporting-services/wmi-provider-library-reference/configurationsetting-method-deleteencryptedinformation

⚠️ **GitHub.com Fallback** ⚠️