loading

Documentation

Automatic Update Installation

Follow guided workflows for first-time setup, updates, and migration.

Step 1

Verify & Enable Download Connector

Required Check and enable automatic download connector for seamless updates

Check and configure download connector status

Check Current Status

First, check if download connector is already enabled on your cluster.

PowerShell Commands
Get-SolutionExtensionProperty
  • If EnableSBEDownload = 'true', connector is already enabled
  • If EnableSBEDownload = 'false' or not found, follow the enable step below
Enable Download Connector

If the status check shows download connector is disabled, run this command to enable it.

PowerShell Commands
Set-SolutionExtensionProperty -PropertyHash @{EnableSBEDownload='true'}
  • After enabling, the download connector will handle file downloads automatically
  • This setting persists for all future updates
  • Proceed to next step once successfully enabled

Step 2

Discover Available Updates

Establish connection to cluster and check for updates

Prerequisites
Connect to Your Azure Local

Open a remote PowerShell session to one machine in the system using the deployment user account.

PowerShell Commands
$cred = Get-Credential
Enter-PSSession -ComputerName "{{CLUSTER_NODE}}" -Credential $cred
  • Sign in with the deployment user account created during Active Directory prep.
Confirm Software and Verify System Health

Ensure the system is on Azure Local 2311+ and is healthy before proceeding.

PowerShell Commands
whoami
Get-SolutionUpdateEnvironment
Discover Available Updates

List update candidates and inspect details of the one you plan to install.

PowerShell Commands
Get-SolutionUpdate | Where-Object {$_.State -like "Ready*" -or $_.State -like "Additional*"} | FL DisplayName, Description, ResourceId, State, PackageType
Get-SolutionUpdate | FL DisplayName, Description, ResourceId, State, PackageType
$Update = Get-SolutionUpdate -Id
$Update.ComponentVersions
  • You may see both Solution and SBE (Solution Builder Extension) items.
  • If the expected update isn't Ready, remove filters to see non-ready states.

Step 3

Verify Downloaded Packages & Check Readiness

Confirm automatic downloads completed and run health checks

Follow these steps to prepare for SBE installation by downloading packages and running readiness checks.

Step 1: Check Update Availability

First, verify that the SBE update is in 'Ready' state before proceeding with preparation.

PowerShell Commands
Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE'} | ft Version,State,UpdateStateProperties,HealthState
Important: Ensure the State shows 'Ready' before proceeding to the next step. If not Ready, wait for package discovery or import to complete.
Step 2: Start Preparation (PrepareOnly)

Once the update is in 'Ready' state, start the preparation process to download packages and run readiness checks without starting installation.

PowerShell Commands
Get-SolutionUpdate | Where-Object {$_.State -imatch "Ready" -and $_.PackageType -eq "SBE"} | Sort-Object -Property ResourceID -Descending | Select-Object -First 1 | Start-SolutionUpdate -PrepareOnly
Command Options:
  • Recommended (above): Automatically selects the latest Ready SBE package by ResourceID
  • Alternative - Specific Version:
    Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE' -and $_.State -eq 'Ready' -and $_.Sbeversion -eq '4.2.2510.730' } | Start-SolutionUpdate -PrepareOnly
    Example with version 4.2.2510.730:
    Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE' -and $_.State -eq 'Ready' -and $_.Sbeversion -eq '4.2.2510.730' } | Start-SolutionUpdate -PrepareOnly
If SBE packages are imported already with Add-SolutionUpdate, PrepareOnly performs health-checks only. For subsequent SBE updates with download connector enabled, PrepareOnly performs downloads and health-checks
Step 3: Monitor Preparation Progress

Check the status of the preparation process.

PowerShell Commands
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
States You May See:
  • Downloading
  • HealthChecking
  • ReadyToInstall
  • HealthCheckFailed (troubleshoot if seen)

Step 4

Start Installation

Begin the update installation process

Begin installation and monitor progress. Machines may reboot; sessions can drop and need re-establishing.

Start the Installation

Execute the installation command to begin the SBE update process.

PowerShell Commands
$InstanceId = Get-SolutionUpdate | Where-Object {$_.State -imatch "Ready" -and $_.PackageType -eq "SBE"} | Sort-Object -Property ResourceID -Descending | Select-Object -First 1 | Start-SolutionUpdate
If you skipped PrepareOnly, Start-SolutionUpdate will download and health-check first. Save $InstanceId for troubleshooting reference.
Resume Commands (if needed):
  • Get-SolutionUpdate -Id $InstanceId | Start-SolutionUpdate
  • Get-SolutionUpdate -Id $InstanceId | Start-SolutionUpdate -IgnoreWarnings - Use this to resume after readiness checks that are in Warning state if acceptable.
Track Installation Progress

Monitor the installation progress using PowerShell commands.

PowerShell Commands
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
Installation States:
  • Downloading - Downloading update packages (if not predownloaded)
  • Preparing - Preparing for installation
  • HealthChecking - Running health checks
  • Installing - Installation in progress
  • Installed - Installation completed successfully
Tip: Track progress in Azure portal for better visibility. If monitoring with PowerShell, connect to the last server updated to minimize session drops during reboots.