updates

Creates, updates, deletes, gets or lists a updates resource.

Overview

Name	updates
Type	Resource
Id	azure_stack.azure_stack_hci.updates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalProperties	string	Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availabilityType	string	Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. Known values are: "Local", "Online", and "Notify". (Local, Online, Notify)
componentVersions	array	An array of component versions for a Solution Bundle update, and an empty array otherwise.
description	string	Description of the update.
displayName	string	Display name of the Update.
healthCheckDate	string (date-time)	Last time the package-specific checks were run.
healthCheckResult	array	An array of PrecheckResult objects.
healthState	string	Overall health state for update-specific health checks. Known values are: "Unknown", "Success", "Failure", "Warning", "Error", and "InProgress". (Unknown, Success, Failure, Warning, Error, InProgress)
installedDate	string (date-time)	Date that the update was installed.
location	string	The geo-location where the resource lives.
minSbeVersionRequired	string	Minimum Sbe Version of the update.
packagePath	string	Path where the update package is available.
packageSizeInMb	number	Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageType	string	Customer-visible type of the update.
prerequisites	array	If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
provisioningState	string	Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
publisher	string	Publisher of the update package.
rebootRequired	string	Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. Known values are: "Unknown", "True", and "False". (Unknown, True, False)
releaseLink	string	Link to release notes for the update.
state	string	Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. Known values are: "HasPrerequisite", "Obsolete", "Ready", "NotApplicableBecauseAnotherUpdateIsInProgress", "Preparing", "Installing", "Installed", "PreparationFailed", "InstallationFailed", "Invalid", "Recalled", "Downloading", "DownloadFailed", "HealthChecking", "HealthCheckFailed", "ReadyToInstall", "ScanInProgress", "ScanFailed", "AdditionalContentRequired", "HealthCheckExpired", and "PendingOEMValidation". (HasPrerequisite, Obsolete, Ready, NotApplicableBecauseAnotherUpdateIsInProgress, Preparing, Installing, Installed, PreparationFailed, InstallationFailed, Invalid, Recalled, Downloading, DownloadFailed, HealthChecking, HealthCheckFailed, ReadyToInstall, ScanInProgress, ScanFailed, AdditionalContentRequired, HealthCheckExpired, PendingOEMValidation)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStateProperties	object	Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.
version	string	Version of the update.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalProperties	string	Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availabilityType	string	Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. Known values are: "Local", "Online", and "Notify". (Local, Online, Notify)
componentVersions	array	An array of component versions for a Solution Bundle update, and an empty array otherwise.
description	string	Description of the update.
displayName	string	Display name of the Update.
healthCheckDate	string (date-time)	Last time the package-specific checks were run.
healthCheckResult	array	An array of PrecheckResult objects.
healthState	string	Overall health state for update-specific health checks. Known values are: "Unknown", "Success", "Failure", "Warning", "Error", and "InProgress". (Unknown, Success, Failure, Warning, Error, InProgress)
installedDate	string (date-time)	Date that the update was installed.
location	string	The geo-location where the resource lives.
minSbeVersionRequired	string	Minimum Sbe Version of the update.
packagePath	string	Path where the update package is available.
packageSizeInMb	number	Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageType	string	Customer-visible type of the update.
prerequisites	array	If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
provisioningState	string	Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
publisher	string	Publisher of the update package.
rebootRequired	string	Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. Known values are: "Unknown", "True", and "False". (Unknown, True, False)
releaseLink	string	Link to release notes for the update.
state	string	Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. Known values are: "HasPrerequisite", "Obsolete", "Ready", "NotApplicableBecauseAnotherUpdateIsInProgress", "Preparing", "Installing", "Installed", "PreparationFailed", "InstallationFailed", "Invalid", "Recalled", "Downloading", "DownloadFailed", "HealthChecking", "HealthCheckFailed", "ReadyToInstall", "ScanInProgress", "ScanFailed", "AdditionalContentRequired", "HealthCheckExpired", and "PendingOEMValidation". (HasPrerequisite, Obsolete, Ready, NotApplicableBecauseAnotherUpdateIsInProgress, Preparing, Installing, Installed, PreparationFailed, InstallationFailed, Invalid, Recalled, Downloading, DownloadFailed, HealthChecking, HealthCheckFailed, ReadyToInstall, ScanInProgress, ScanFailed, AdditionalContentRequired, HealthCheckExpired, PendingOEMValidation)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updateStateProperties	object	Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.
version	string	Version of the update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, update_name, subscription_id		Get specified Update.
list	select	resource_group_name, cluster_name, subscription_id		List all Updates.
delete	delete	resource_group_name, cluster_name, update_name, subscription_id		Delete specified Update.
put	exec	resource_group_name, cluster_name, update_name, subscription_id		Put specified Update.
post	exec	resource_group_name, cluster_name, update_name, subscription_id		Apply Update.
prepare	exec	resource_group_name, cluster_name, update_name, subscription_id		Prepare Update.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	The name of the cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
update_name	string	The name of the Update. Required.

SELECT examples

get

Get specified Update.

SELECT
id,
name,
additionalProperties,
availabilityType,
componentVersions,
description,
displayName,
healthCheckDate,
healthCheckResult,
healthState,
installedDate,
location,
minSbeVersionRequired,
packagePath,
packageSizeInMb,
packageType,
prerequisites,
provisioningState,
publisher,
rebootRequired,
releaseLink,
state,
systemData,
type,
updateStateProperties,
version
FROM azure_stack.azure_stack_hci.updates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND update_name = '{{ update_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all Updates.

SELECT
id,
name,
additionalProperties,
availabilityType,
componentVersions,
description,
displayName,
healthCheckDate,
healthCheckResult,
healthState,
installedDate,
location,
minSbeVersionRequired,
packagePath,
packageSizeInMb,
packageType,
prerequisites,
provisioningState,
publisher,
rebootRequired,
releaseLink,
state,
systemData,
type,
updateStateProperties,
version
FROM azure_stack.azure_stack_hci.updates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete specified Update.

DELETE FROM azure_stack.azure_stack_hci.updates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND update_name = '{{ update_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

put

Put specified Update.

EXEC azure_stack.azure_stack_hci.updates.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@update_name='{{ update_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"location": "{{ location }}"
}'
;

post

Apply Update.

EXEC azure_stack.azure_stack_hci.updates.post 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@update_name='{{ update_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

prepare

Prepare Update.

EXEC azure_stack.azure_stack_hci.updates.prepare 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@update_name='{{ update_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;