Functions/Get-DbSettingsAsJson.ps1
|
<#
.SYNOPSIS Converts database settings to JSON format. .DESCRIPTION The Get-DbSettingsAsJson function serializes database deployment settings to JSON format. This is useful for storing settings, comparing configurations, or debugging deployment issues. .PARAMETER settings Specifies the settings object to convert to JSON format. .OUTPUTS String Returns a JSON representation of the settings object. .EXAMPLE $settings = @{ ServerName = "localhost"; DatabaseName = "MyDB"; Timeout = 60 } Get-DbSettingsAsJson -settings $settings Returns the settings object serialized as JSON. .EXAMPLE $deploySettings = Get-DeploymentSettings $jsonSettings = Get-DbSettingsAsJson -settings $deploySettings $jsonSettings | Out-File "deployment-settings.json" Exports deployment settings to a JSON file. .NOTES This function is a wrapper around the internal Get-SettingsAsJson function. The JSON output can be used for storage, comparison, or debugging purposes. #> function Get-DbSettingsAsJson { [CmdletBinding()] [OutputType([String])] param ( [Parameter(Mandatory = $true, HelpMessage = "Settings object to convert to JSON")] $settings ) return Get-SettingsAsJson -settings $settings } |