SqlServerDsc.SqlRSSetup.dsc.adaptedResource.json
|
{
"$schema": "https://aka.ms/dsc/schemas/v3/bundled/adaptedresource/manifest.json", "type": "SqlServerDsc/SqlRSSetup", "kind": "resource", "version": "17.6.0", "capabilities": [ "get", "test", "set" ], "description": "The `SqlRSSetup` DSC resource is used to install, repair, or uninstall SQL Server Reporting Services (SSRS) or Power BI Report Server (PBIRS).", "author": "DSC Community", "requireAdapter": "Microsoft.Adapter/PowerShell", "path": "SqlServerDsc.psd1", "schema": { "embedded": { "$schema": "https://json-schema.org/draft/2020-12/schema", "properties": { "InstanceName": { "type": "string", "title": "InstanceName", "description": "Specifies the instance name for the Reporting Services instance. This must be either `'SSRS'` for SQL Server Reporting Services or `'PBIRS'` for Power BI Report Server." }, "Action": { "type": "string", "enum": [ "Install", "Repair", "Uninstall" ], "title": "Action", "description": "Specifies the action to take for the Reporting Services instance. This can be 'Install', 'Repair', or 'Uninstall'." }, "AcceptLicensingTerms": { "type": "string", "title": "AcceptLicensingTerms", "description": "Required parameter for Install and Repair actions to be able to run unattended. By specifying this parameter you acknowledge the acceptance of all license terms and notices for the specified features, the terms and notices that the setup executable normally asks for." }, "MediaPath": { "type": "string", "title": "MediaPath", "description": "Specifies the path where to find the SQL Server installation media. On this path the SQL Server setup executable must be found." }, "ProductKey": { "type": "string", "title": "ProductKey", "description": "Specifies the product key to use for the installation or repair, e.g. '12345-12345-12345-12345-12345'. This parameter is mutually exclusive with the parameter Edition." }, "EditionUpgrade": { "type": "string", "title": "EditionUpgrade", "description": "Upgrades the edition of the installed product. Requires that either the ProductKey or the Edition parameter is also assigned. By default no edition upgrade is performed." }, "Edition": { "type": "string", "enum": [ "Developer", "Evaluation", "ExpressAdvanced" ], "title": "Edition", "description": "Specifies a free custom edition to use for the installation or repair. This parameter is mutually exclusive with the parameter ProductKey." }, "LogPath": { "type": "string", "title": "LogPath", "description": "Specifies the file path where to write the log files, e.g. 'C:\\Logs\\Install.log'. By default log files are created under %TEMP%." }, "InstallFolder": { "type": "string", "title": "InstallFolder", "description": "Specifies the folder where to install the product, e.g. 'C:\\Program Files\\SSRS'. By default the product is installed under the default installation folder. Reporting Services: %ProgramFiles%\\Microsoft SQL Server Reporting Services Power BI Report Server: %ProgramFiles%\\Microsoft Power BI Report Server" }, "SuppressRestart": { "type": "string", "title": "SuppressRestart", "description": "Suppresses the restart of the computer after the installation, repair, or uninstallation is finished. By default the computer is restarted after the operation is finished." }, "ForceRestart": { "type": "string", "title": "ForceRestart", "description": "Forces a restart of the computer after the installation, repair, or uninstallation is finished, regardless of the operation's outcome. This parameter overrides SuppressRestart." }, "VersionUpgrade": { "type": "string", "title": "VersionUpgrade", "description": "Specifies whether to upgrade the version of the installed product. By default, no version upgrade is performed. If this parameter is specified the installed product version will be compared against the product version of the setup executable. If the installed product version is lower than the product version of the setup executable, the setup will perform an upgrade. If the installed product version is equal to or higher than the product version of the setup executable, no upgrade will be performed." }, "Timeout": { "type": "string", "title": "Timeout", "description": "Specifies how long to wait for the setup process to finish. Default value is `7200` seconds (2 hours). If the setup process does not finish before this time, an exception will be thrown." } }, "description": "The `SqlRSSetup` DSC resource is used to install, repair, or uninstall SQL Server Reporting Services (SSRS) or Power BI Report Server (PBIRS).", "additionalProperties": false, "required": [ "InstanceName", "Action", "AcceptLicensingTerms", "MediaPath" ], "title": "SqlServerDsc/SqlRSSetup", "type": "object" } } } |