Update sql-server-linux-sql-assessment-api.md

Author: rwestMSFT

docs/linux/sql-server-linux-sql-assessment-api.md

@@ -4,7 +4,7 @@ description: This article describes how to run the SQL Assessment API for SQL Se
 author: aravindmahadevan-ms
 ms.author: armaha
 ms.reviewer: amitkh-msft, randolphwest
-ms.date: 01/17/2023
+ms.date: 08/31/2023
 ms.service: sql
 ms.subservice: linux
 ms.topic: conceptual
@@ -110,17 +110,17 @@ if (-not ( Test-Path $outDir )) { mkdir $outDir }
 $outPath = Join-Path $outDir 'assessment-latest'
 
 $errorPath = Join-Path $outDir 'assessment-latest-errors'
-if( Test-Path $errorPath ) { remove-item $errorPath }
+if ( Test-Path $errorPath ) { remove-item $errorPath }
 
 function ConvertTo-LogOutput {
     [CmdletBinding()]
     param (
-        [Parameter(ValueFromPipeline=$true)]
+        [Parameter(ValueFromPipeline = $true)]
         $input
     )
     process {
-        switch($input){
-            { $_ -is [System.Management.Automation.WarningRecord] }{
+        switch ($input) {
+            { $_ -is [System.Management.Automation.WarningRecord] } {
                 $result = @{
                     'TimeStamp' = $(Get-Date).ToString("O");
                     'Warning'   = $_.Message
@@ -157,31 +157,31 @@ function Get-TargetsRecursive {
 
     [CmdletBinding()]
     Param (
-        [Parameter(ValueFromPipeline=$true)]
+        [Parameter(ValueFromPipeline = $true)]
         [Microsoft.SqlServer.Management.Smo.Server] $server
     )
 
     $server
     $server.Databases
 }
 
-function Get-ConfSetting{
+function Get-ConfSetting {
     [CmdletBinding()]
     param (
         $confFile,
         $section,
         $name,
-        $defaultValue=$null
+        $defaultValue = $null
     )
 
     $inSection = $false
 
-    switch -regex -file $confFile{
-        "^\s*\[\s*(.+?)\s*\]"{
+    switch -regex -file $confFile {
+        "^\s*\[\s*(.+?)\s*\]" {
             $inSection = $matches[1] -eq $section
         }
-        "^\s*$($name)\s*=\s*(.+?)\s*$"{
-            if($inSection){
+        "^\s*$($name)\s*=\s*(.+?)\s*$" {
+            if ($inSection) {
                 return $matches[1]
             }
         }
@@ -191,31 +191,31 @@ function Get-ConfSetting{
 }
 
 try {
-
     Write-Verbose "Acquiring credentials"
 
-    $login, $pwd    = Get-Content '/var/opt/mssql/secrets/assessment' -Encoding UTF8NoBOM -TotalCount 2
+    $login, $pwd = Get-Content '/var/opt/mssql/secrets/assessment' -Encoding UTF8NoBOM -TotalCount 2
     $securePassword = ConvertTo-SecureString $pwd -AsPlainText -Force
-    $credential     = New-Object System.Management.Automation.PSCredential ($login, $securePassword)
+    $credential = New-Object System.Management.Automation.PSCredential ($login, $securePassword)
     $securePassword.MakeReadOnly()
     
     Write-Verbose "Acquired credentials"
 
     $serverInstance = '.'
 
-    if(Test-Path /var/opt/mssql/mssql.conf) {
+    if (Test-Path /var/opt/mssql/mssql.conf) {
         $port = Get-ConfSetting /var/opt/mssql/mssql.conf network tcpport
 
 
-        if(-not [string]::IsNullOrWhiteSpace($port)) {
+        if (-not [string]::IsNullOrWhiteSpace($port)) {
             Write-Verbose "Using port $($port)"
             $serverInstance = "$($serverInstance),$($port)"
         }
     }
 
-    # IMPORTANT: If the script is run in trusted environments and there is a prelogin handshake error, add -TrustServerCertificate flag in the commands for $serverName, $hostName and Get-SqlInstance lines below.
+    # IMPORTANT: If the script is run in trusted environments and there is a prelogin handshake error,
+    # add -TrustServerCertificate flag in the commands for $serverName, $hostName and Get-SqlInstance lines below.
     $serverName = (Invoke-SqlCmd -ServerInstance $serverInstance -Credential $credential -Query "SELECT @@SERVERNAME")[0]
-    $hostName   = (Invoke-SqlCmd -ServerInstance $serverInstance -Credential $credential -Query "SELECT HOST_NAME()")[0]
+    $hostName = (Invoke-SqlCmd -ServerInstance $serverInstance -Credential $credential -Query "SELECT HOST_NAME()")[0]
 
     # Invoke assessment and store results.
     # Replace 'ConvertTo-Json' with 'ConvertTo-Csv' to change output format.
@@ -224,14 +224,13 @@ try {
 
     Get-SqlInstance -ServerInstance $serverInstance -Credential $credential -ErrorAction Stop
     | Get-TargetsRecursive
-    | %{ Write-Verbose "Invoke assessment on $($_.Urn)"; $_ }
+    | ForEach-Object { Write-Verbose "Invoke assessment on $($_.Urn)"; $_ }
     | Invoke-SqlAssessment 3>&1
     | ConvertTo-LogOutput
     | ConvertTo-Json -AsArray
     | Set-Content $outPath -Encoding UTF8NoBOM
 }
 finally {
-
     Write-Verbose "Error count: $($Error.Count)"
 
     if ($Error) {
@@ -243,7 +242,7 @@ finally {
 }
 ```
 > [!NOTE]  
-> In the above script, when it is run in trusted environments and there is a prelogin handshake error, add -TrustServerCertificate flag in the commands for $serverName, $hostName and Get-SqlInstance lines in the above code. .
+> When you run the previous script in trusted environments, and you get a prelogin handshake error, add the `-TrustServerCertificate` flag in the commands for `$serverName`, `$hostName` and `Get-SqlInstance` lines in the code.
 
 ### Run the assessment