update_summaries

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

Overview

Name	update_summaries
Type	Resource
Id	azure_stack.azure_stack_hci.update_summaries

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.
currentOemVersion	string	Current OEM Version.
currentSbeVersion	string	Current Sbe version of the stamp.
currentVersion	string	Current Solution Bundle version of the stamp.
hardwareModel	string	Name of the hardware model.
healthCheckDate	string (date-time)	Last time the package-specific checks were run.
healthCheckResult	array	An array of pre-check result 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)
lastChecked	string (date-time)	Last time the update service successfully checked for updates.
lastUpdated	string (date-time)	Last time an update installation completed successfully.
location	string	The geo-location where the resource lives.
oemFamily	string	OEM family name.
packageVersions	array	Current version of each updatable component.
provisioningState	string	Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary 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)
state	string	Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. Known values are: "Unknown", "AppliedSuccessfully", "UpdateAvailable", "UpdateInProgress", "UpdateFailed", "NeedsAttention", "PreparationInProgress", and "PreparationFailed". (Unknown, AppliedSuccessfully, UpdateAvailable, UpdateInProgress, UpdateFailed, NeedsAttention, PreparationInProgress, PreparationFailed)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Get all Update summaries under the HCI cluster.
delete	delete	resource_group_name, cluster_name, subscription_id		Delete Update Summaries.
put	exec	resource_group_name, cluster_name, subscription_id		Put Update summaries under the HCI cluster.
list_raw	exec	resource_group_name, cluster_name, subscription_id		List all Update summaries under the HCI cluster.

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

SELECT examples

get

Get all Update summaries under the HCI cluster.

SELECT
id,
name,
currentOemVersion,
currentSbeVersion,
currentVersion,
hardwareModel,
healthCheckDate,
healthCheckResult,
healthState,
lastChecked,
lastUpdated,
location,
oemFamily,
packageVersions,
provisioningState,
state,
systemData,
type
FROM azure_stack.azure_stack_hci.update_summaries
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

DELETE examples

delete

Delete Update Summaries.

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

Lifecycle Methods

put

Put Update summaries under the HCI cluster.

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

list_raw

List all Update summaries under the HCI cluster.

EXEC azure_stack.azure_stack_hci.update_summaries.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;