Skip to main content

Task 01: Check for Updates

Implementation Day 2

DOCUMENT CATEGORY: Implementation Runbook
SCOPE: A deployed Azure Local cluster
PURPOSE: Show what the update service has discovered and what Azure offers, and say what is next for each update. Changes nothing
MASTER REFERENCE: Update Azure Local by using PowerShell

Status: Active

A freshly deployed cluster does not show its first update on its own until later. The Lifecycle Manager discovers updates by itself (it also queries the hardware vendor's online SBE manifest), the update agent checks the cluster once a day, and Learn names no command that forces a check: Get-SolutionUpdate is how you "rediscover the updates", and Azure Update Manager has a Check for updates button. This task is the check the toolkit always runs after a deployment and then on a schedule. It starts nothing.


Values from infrastructure.yml​

The values for this task come from infrastructure.yml (schema 5). Every key, with its type, default and example, is in the variables reference.

KeyWhat the script does with it
cluster.nameThe cluster the PowerShell script connects to (or one node, with -ComputerName); the name of the cluster resource for the Azure CLI script
operations.updates.target_versionOptional. latest (default) or a solution version of four numbers. The report says whether that version is offered
azure.tenant_id, azure.subscription_id, azure.resource_groupAzure CLI script only: where the cluster resource is. The sign-in must be to this tenant

Execution Options​

PowerShell on a cluster machine​

When to use: One cluster, by hand

Sign in to a machine of the cluster as the deployment user, then read the update environment and the discovered updates (Learn: Update Azure Local by using PowerShell, steps 1 and 2):

Get-SolutionUpdateEnvironment | Format-List CurrentVersion, CurrentSbeVersion, State, HealthState, LastChecked
Get-SolutionUpdate | Format-Table DisplayName, PackageType, Version, SbeVersion, State

Review HealthState: Failure, Error or Warning has to be fixed before an update starts. Repeat Get-SolutionUpdate to rediscover. An update that is not listed may not be visible yet: a feature update can take a week after its release, until the hardware partner has validated it.


The verdict​

VerdictMeaningNext
UpToDateNo update is offered and none is runningNothing. Check again later
UpdateAvailableAn update is Ready or ReadyToInstallTask 02: prepare it, then start it
AdditionalContentRequiredAn update waits for the hardware vendor's SBE filesSBE update import, then check again
UpdateRunningAn update is Downloading, Preparing, HealthChecking or InstallingWait. Run this task again to follow it
AttentionNeededAn update failed or needs a prerequisite, the health is Failure, Error or Warning, the update environment is UpdateFailed, NeedsAttention or PreparationFailed, or (Azure CLI) a critical or warning readiness check failed or the update service has not checked for too longRead the [attention] lines. Fix them before an update is started

Exit codes: 0 the cluster was read and nothing needs attention (an update may be offered), 1 it could not be read, the verdict is AttentionNeeded, or (Azure CLI) the earlier subscription could not be put back, 2 a value in the file is missing or not usable (nothing is sent).

Validation​

  • The script ends with exit code 0, or the [attention] lines are understood
  • The installed version is the version you expect (CurrentVersion)
  • LastChecked is within a day (PowerShell script: printed; Azure CLI script: in the JSON)

Troubleshooting​

IssueCauseResolution
No update is offered after the deploymentDiscovery has not finished, or the release is not validated for your hardware yetRun the script with -WaitMinutes; check again the next day. A feature update can take a week after its release to be visible
AdditionalContentRequiredThe SBE on the cluster has no download connector (or no credentials) for this clusterImport the vendor files (SBE update import) or set the connector credentials with Set-SolutionExtensionSecretLocation
The Azure CLI script says the cluster resource was not foundWrong azure.resource_group or cluster.name, or the cluster is not registeredCheck both keys against the portal
AttentionNeeded with a health of WarningA readiness check warnsGet-SolutionHealthSummary on a machine shows the details (Learn: Troubleshoot readiness checks)

PreviousUpNext
Part 8: Day 2 OperationsPart 8 IndexTask 02: Start the Solution Update

Version Control​

VersionDateAuthorChanges
1.0.02026-11-15Azure Local CloudInitial release
1.0.12026-11-16Azure Local Cloud-WaitMinutes stops at once on something that needs attention; the Azure CLI script follows every page, uses the endpoint of the current cloud, raises AttentionNeeded on a blocking health and ends with exit code 1 when it cannot put the earlier subscription back