Artifacts/windows-install-windows-ms-updates/artifact.ps1

###################################################################################################
#
# PowerShell configurations
#


[CmdletBinding()]
param(
    [switch] $IncludeMicrosoftUpdates
)

# NOTE: Because the $ErrorActionPreference is "Stop", this script will stop on first failure.
#       This is necessary to ensure we capture errors inside the try-catch-finally block.
$ErrorActionPreference = "Stop"

# Hide any progress bars, due to downloads and installs of remote components.
$ProgressPreference = "SilentlyContinue"

# Ensure we force use of TLS 1.2 for all downloads.
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

# Discard any collected errors from a previous execution.
$Error.Clear()

# Allow certian operations, like downloading files, to execute.
Set-ExecutionPolicy Bypass -Scope Process -Force

###################################################################################################
#
# Handle all errors in this script.
#

trap
{
    # NOTE: This trap will handle all errors. There should be no need to use a catch below in this
    #       script, unless you want to ignore a specific error.
    $message = $Error[0].Exception.Message
    if ($message)
    {
        Write-Host -Object "`nERROR: $message" -ForegroundColor Red
    }

    Write-Host "`nThe artifact failed to apply.`n"

    # IMPORTANT NOTE: Throwing a terminating error (using $ErrorActionPreference = "Stop") still
    # returns exit code zero from the PowerShell script when using -File. The workaround is to
    # NOT use -File when calling this script and leverage the try-catch-finally block and return
    # a non-zero exit code from the catch block.
    exit -1
}

###################################################################################################
#
# Functions used in this script.
#

function Test-PowerShellVersion
{
    [CmdletBinding()]
    param(
        [double] $Version
    )

    $currentVersion = [double] "$($PSVersionTable.PSVersion.Major).$($PSVersionTable.PSVersion.Minor)"
    if ($currentVersion -lt $Version)
    {
        throw "The current version of PowerShell is $currentVersion. Prior to running this artifact, ensure you have PowerShell version $Version or higher installed."
    }
}

###################################################################################################
#
# Main execution block.
#

try
{
    Write-Host 'Validating local version of Powershell is higher than required for PSwindowsUpdate module.'
    Test-PowerShellVersion -Version 3.0

    Write-Host "Updating NuGet provider to a version higher than 2.8.5.201."
    Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force | Out-Null

    Write-Host "Installing Powershell module 'PSWindowsUpdate'"
    Install-Module -Name PSWindowsUpdate -MinimumVersion 2.2.0.2 -Force | Out-Null
    Import-Module PSWindowsUpdate
    
    Write-Host 'Installing Windows Updates.'
    Get-WUInstall -IgnoreUserInput -Acceptall -Download -Install -Verbose -IgnoreReboot -MicrosoftUpdate:$IncludeMicrosoftUpdates
    
    Write-Host "Windows Update finished. Rebooting..."
    Write-Host "`nThe artifact was applied successfully.`n"

    # Forcing the restart in script, as the artifact’s postDeployActions may timeout prematurely, prior to the Windows Updates completing, causing undesirable side effects.
    Restart-Computer -Force
}
finally
{
    Pop-Location
}