loading

Documentation

Update with Download Connector

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

Generic Guide

Select Family and Version

Choose a package to tailor file lists and verification commands throughout this guide.

Use This Workflow When

Use this workflow when SBE is already installed and the download connector is enabled or ready to enable.

Outcome

SBE update packages are discovered through the connector, checked for readiness, and installed without manual package import.

Before You Start

  • SBE version 4.1.2411.xxxx or higher is installed
  • The cluster is registered with the DataON portal
  • The cluster can reach Microsoft Update services and the DataON portal

Step 1

Verify Download Connector

Check the connector setting and enable it if needed

Check and configure download connector status.

Check Current Status

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

PowerShell Commands
Get-SolutionExtensionProperty
Download connector property output
PowerShell output for Get-SolutionExtensionProperty showing SBE download connector property values
If EnableSBEDownload is false or missing, enable the connector before continuing.
  • If EnableSBEDownload = 'true', connector is already enabled.
  • If EnableSBEDownload = 'false' or not found, follow the enable step below.
Enable Download Connector

If the status property does not exist or shows false, the status check indicates the download connector is disabled. Enable it.

PowerShell Commands
Set-SolutionExtensionProperty -PropertyHash @{EnableSBEDownload='true'}
  • This setting persists for future updates.
  • Proceed once EnableSBEDownload shows true.

Step 2

Discover Available Updates

Establish connection to cluster and check for updates

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
$Update = Get-SolutionUpdate
$Update | ft DisplayName, PackageType, Version, SbeVersion, State
Manual import signal Sample output 
PS C:\Users\lcmuser> $Update = Get-SolutionUpdate
PS C:\Users\lcmuser> $Update | ft DisplayName, PackageType, Version, SbeVersion, State

DisplayName                      PackageType Version          SbeVersion                        State
-----------                      ----------- -------          ----------                        -----
SBE_DataON_AZS1_5.0.2604.700     SBE         5.0.2604.700     5.0.2604.700                     AdditionalContentRequired
2026.03 Cumulative Update        Solution    12.2603.1002.502                                    Ready
AdditionalContentRequired means vendor package files must be imported before installation.
Download connector signal Sample output 
PS C:\Users\lcmuser> $Update = Get-SolutionUpdate
PS C:\Users\lcmuser> $Update | ft DisplayName, PackageType, Version, SbeVersion, State

DisplayName                      PackageType Version          SbeVersion     State
-----------                      ----------- -------          ----------     -----
SBE_DataON_AZS1_5.0.2604.700     SBE         5.0.2604.700     5.0.2604.700   Ready
2026.03 Cumulative Update        Solution    12.2603.1002.502                Ready
Ready means the update can continue without manual package import when the connector is enabled.
  • You may see both Solution and SBE (Solution Builder Extension) items.
  • Review the State column before choosing a workflow: Ready usually points to the download connector workflow, while AdditionalContentRequired points to manual package import.
  • If the expected update isn't Ready or AdditionalContentRequired, remove filters to see non-ready states.
Important Notes
  • If SBE is below 4.1.2411.xxxx, the connector cannot be enabled, or the SBE update shows AdditionalContentRequired, use Manual Update Installation instead.

Step 3

Verify Downloaded Packages & Check Readiness

Confirm connector downloads completed and run health checks

Run preparation so Azure Local can validate the selected SBE update before installation.

Start Preparation (PrepareOnly)

Start preparation to run health and 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
PrepareOnly command output
PowerShell output after starting SBE preparation with Start-SolutionUpdate -PrepareOnly
PrepareOnly starts readiness checks without installing the update.
  • Manual package download is skipped in this workflow. After the download connector is verified, continue to preparation/readiness checks. If automatic download fails during preparation, use the manual update workflow.
  • If no Ready SBE package is selected, return to the import or connector verification step before starting preparation.
  • The recommended command selects the latest Ready SBE package by ResourceID. To target a specific version, filter Get-SolutionUpdate by Sbeversion before running Start-SolutionUpdate -PrepareOnly.
  • For manual imports, PrepareOnly primarily performs health checks. For download connector updates, it may also download package content before health checks.
Monitor Preparation Progress

Check the status of the preparation process.

PowerShell Commands
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
Preparation status check
PowerShell output showing SBE preparation status after PrepareOnly
Continue once readiness checks complete successfully.
  • States you may see: Downloading, HealthChecking, ReadyToInstall, and HealthCheckFailed. Troubleshoot if HealthCheckFailed appears.

Step 4

Start Installation

Start installation after readiness checks pass

Start installation only after preparation completes and the selected SBE update is ready to install. Machines may reboot; sessions can drop and need re-establishing.

Start the Installation

Run the installation command after readiness checks complete successfully.

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
Installation start output
PowerShell output after starting SBE installation with Start-SolutionUpdate
Save the returned instance ID for tracking or troubleshooting.
  • Save $InstanceId for troubleshooting reference.
  • If installation is interrupted, resume with Get-SolutionUpdate -Id $InstanceId | Start-SolutionUpdate.
  • Use the next step to track installation progress and verify completion.

Step 5

Track Progress & Verify

Monitor installation and verify completion

Track Progress

Track installation progress preferably in Azure portal. PowerShell monitoring is available if portal status is not enough.

PowerShell Commands
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
Installation status check
PowerShell output showing SBE installation status during Start-SolutionUpdate
Status values change while the update progresses.
Successful installation status
PowerShell output showing successful SBE installation status
Use the verification commands after installation reports success.
States You May See
Downloading
Preparing
HealthChecking
Installing
Installed
Notes:
  • If monitoring with PowerShell, connect to the last server updated to minimize session drops during reboots.
  • If you saved $InstanceId from the install step, use Get-SolutionUpdate -Id $InstanceId for targeted status checks.
Verify Installation

Confirm solution version and OS version post-install.

PowerShell Commands
Get-SolutionUpdateEnvironment | ft State, CurrentSbeVersion, CurrentVersion
cmd /c ver
Sample environment output
PowerShell output for Get-SolutionUpdateEnvironment showing successful Azure Local update environment state and current version
Use this as the final confirmation that the environment reports the expected version.
Notes:
  • State: AppliedSuccessfully
  • CurrentVersion matches the installed SBE version
  • OS build matches the installed recipe