Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2026-04-01-preview
- 2026-03-01-preview
- 2026-02-15-preview
- 2026-02-01
- 2025-12-01-preview
- 2025-11-01-preview
- 2025-10-01
- 2025-09-15-preview
- 2025-02-01-preview
- 2024-12-01-preview
- 2024-09-01-preview
- 2024-04-01
- 2024-02-15-preview
- 2024-01-01
- 2023-11-01-preview
- 2023-08-01
- 2023-08-01-preview
- 2023-06-01
- 2023-03-01
- 2023-02-01
- 2022-12-15-preview
- 2022-12-01
- 2022-10-01
Bicep resource definition
The clusters/updateSummaries resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/clusters/updateSummaries resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AzureStackHCI/clusters/updateSummaries@2026-03-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'default'
properties: {
currentOemVersion: 'string'
currentSbeVersion: 'string'
currentVersion: 'string'
hardwareModel: 'string'
healthCheckDate: 'string'
healthCheckResult: [
{
additionalData: 'string'
description: 'string'
displayName: 'string'
healthCheckSource: 'string'
healthCheckTags: any(...)
name: 'string'
remediation: 'string'
severity: 'string'
status: 'string'
tags: {
key: 'string'
value: 'string'
}
targetResourceID: 'string'
targetResourceName: 'string'
targetResourceType: 'string'
timestamp: 'string'
title: 'string'
}
]
healthState: 'string'
lastChecked: 'string'
lastUpdated: 'string'
oemFamily: 'string'
packageVersions: [
{
lastUpdated: 'string'
packageType: 'string'
version: 'string'
}
]
state: 'string'
}
}
Property Values
Microsoft.AzureStackHCI/clusters/updateSummaries
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | 'default' (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: clusters |
| properties | Update summaries properties | UpdateSummariesProperties |
PackageVersionInfo
| Name | Description | Value |
|---|---|---|
| lastUpdated | Last time this component was updated. | string |
| packageType | Package type | string |
| version | Package version | string |
PrecheckResult
| Name | Description | Value |
|---|---|---|
| additionalData | Property bag of key value pairs for additional information. | string |
| description | Detailed overview of the issue and what impact the issue has on the stamp. | string |
| displayName | The health check DisplayName localized of the individual test executed. | string |
| healthCheckSource | The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). | string |
| healthCheckTags | Key-value pairs that allow grouping/filtering individual tests. | any |
| name | Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. | string |
| remediation | Set of steps that can be taken to resolve the issue found. | string |
| severity | Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. | 'Critical' 'Hidden' 'Informational' 'Warning' |
| status | Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. | 'ConnectedRecently' 'DeploymentFailed' 'DeploymentInProgress' 'DeploymentSuccess' 'Disconnected' 'Error' 'NotConnectedRecently' 'NotSpecified' 'NotYetRegistered' 'ValidationFailed' 'ValidationInProgress' 'ValidationSuccess' |
| tags | Key-value pairs that allow grouping/filtering individual tests. | PrecheckResultTags |
| targetResourceID | The unique identifier for the affected resource (such as a node or drive). | string |
| targetResourceName | The name of the affected resource. | string |
| targetResourceType | The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). | string |
| timestamp | The time in which the HealthCheck was called. | string |
| title | User-facing name; one or more sentences indicating the direct issue. | string |
PrecheckResultTags
| Name | Description | Value |
|---|---|---|
| key | Key that allow grouping/filtering individual tests. | string |
| value | Value of the key that allow grouping/filtering individual tests. | string |
UpdateSummariesProperties
| Name | Description | Value |
|---|---|---|
| currentOemVersion | Current OEM Version. | string |
| currentSbeVersion | Current Sbe version of the stamp. | string |
| currentVersion | Current Solution Bundle version of the stamp. | string |
| hardwareModel | Name of the hardware model. | string |
| healthCheckDate | Last time the package-specific checks were run. | string |
| healthCheckResult | An array of pre-check result objects. | PrecheckResult[] |
| healthState | Overall health state for update-specific health checks. | 'Error' 'Failure' 'InProgress' 'Success' 'Unknown' 'Warning' |
| lastChecked | Last time the update service successfully checked for updates | string |
| lastUpdated | Last time an update installation completed successfully. | string |
| oemFamily | OEM family name. | string |
| packageVersions | Current version of each updatable component. | PackageVersionInfo[] |
| state | Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. | 'AppliedSuccessfully' 'NeedsAttention' 'PreparationFailed' 'PreparationInProgress' 'Unknown' 'UpdateAvailable' 'UpdateFailed' 'UpdateInProgress' |
ARM template resource definition
The clusters/updateSummaries resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/clusters/updateSummaries resource, add the following JSON to your template.
{
"type": "Microsoft.AzureStackHCI/clusters/updateSummaries",
"apiVersion": "2026-03-01-preview",
"name": "string",
"location": "string",
"properties": {
"currentOemVersion": "string",
"currentSbeVersion": "string",
"currentVersion": "string",
"hardwareModel": "string",
"healthCheckDate": "string",
"healthCheckResult": [
{
"additionalData": "string",
"description": "string",
"displayName": "string",
"healthCheckSource": "string",
"healthCheckTags": {},
"name": "string",
"remediation": "string",
"severity": "string",
"status": "string",
"tags": {
"key": "string",
"value": "string"
},
"targetResourceID": "string",
"targetResourceName": "string",
"targetResourceType": "string",
"timestamp": "string",
"title": "string"
}
],
"healthState": "string",
"lastChecked": "string",
"lastUpdated": "string",
"oemFamily": "string",
"packageVersions": [
{
"lastUpdated": "string",
"packageType": "string",
"version": "string"
}
],
"state": "string"
}
}
Property Values
Microsoft.AzureStackHCI/clusters/updateSummaries
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-03-01-preview' |
| location | The geo-location where the resource lives | string |
| name | The resource name | 'default' (required) |
| properties | Update summaries properties | UpdateSummariesProperties |
| type | The resource type | 'Microsoft.AzureStackHCI/clusters/updateSummaries' |
PackageVersionInfo
| Name | Description | Value |
|---|---|---|
| lastUpdated | Last time this component was updated. | string |
| packageType | Package type | string |
| version | Package version | string |
PrecheckResult
| Name | Description | Value |
|---|---|---|
| additionalData | Property bag of key value pairs for additional information. | string |
| description | Detailed overview of the issue and what impact the issue has on the stamp. | string |
| displayName | The health check DisplayName localized of the individual test executed. | string |
| healthCheckSource | The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). | string |
| healthCheckTags | Key-value pairs that allow grouping/filtering individual tests. | any |
| name | Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. | string |
| remediation | Set of steps that can be taken to resolve the issue found. | string |
| severity | Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. | 'Critical' 'Hidden' 'Informational' 'Warning' |
| status | Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. | 'ConnectedRecently' 'DeploymentFailed' 'DeploymentInProgress' 'DeploymentSuccess' 'Disconnected' 'Error' 'NotConnectedRecently' 'NotSpecified' 'NotYetRegistered' 'ValidationFailed' 'ValidationInProgress' 'ValidationSuccess' |
| tags | Key-value pairs that allow grouping/filtering individual tests. | PrecheckResultTags |
| targetResourceID | The unique identifier for the affected resource (such as a node or drive). | string |
| targetResourceName | The name of the affected resource. | string |
| targetResourceType | The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). | string |
| timestamp | The time in which the HealthCheck was called. | string |
| title | User-facing name; one or more sentences indicating the direct issue. | string |
PrecheckResultTags
| Name | Description | Value |
|---|---|---|
| key | Key that allow grouping/filtering individual tests. | string |
| value | Value of the key that allow grouping/filtering individual tests. | string |
UpdateSummariesProperties
| Name | Description | Value |
|---|---|---|
| currentOemVersion | Current OEM Version. | string |
| currentSbeVersion | Current Sbe version of the stamp. | string |
| currentVersion | Current Solution Bundle version of the stamp. | string |
| hardwareModel | Name of the hardware model. | string |
| healthCheckDate | Last time the package-specific checks were run. | string |
| healthCheckResult | An array of pre-check result objects. | PrecheckResult[] |
| healthState | Overall health state for update-specific health checks. | 'Error' 'Failure' 'InProgress' 'Success' 'Unknown' 'Warning' |
| lastChecked | Last time the update service successfully checked for updates | string |
| lastUpdated | Last time an update installation completed successfully. | string |
| oemFamily | OEM family name. | string |
| packageVersions | Current version of each updatable component. | PackageVersionInfo[] |
| state | Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. | 'AppliedSuccessfully' 'NeedsAttention' 'PreparationFailed' 'PreparationInProgress' 'Unknown' 'UpdateAvailable' 'UpdateFailed' 'UpdateInProgress' |
Usage Examples
Terraform (AzAPI provider) resource definition
The clusters/updateSummaries resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/clusters/updateSummaries resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureStackHCI/clusters/updateSummaries@2026-03-01-preview"
name = "string"
parent_id = "string"
location = "string"
body = {
properties = {
currentOemVersion = "string"
currentSbeVersion = "string"
currentVersion = "string"
hardwareModel = "string"
healthCheckDate = "string"
healthCheckResult = [
{
additionalData = "string"
description = "string"
displayName = "string"
healthCheckSource = "string"
healthCheckTags = ?
name = "string"
remediation = "string"
severity = "string"
status = "string"
tags = {
key = "string"
value = "string"
}
targetResourceID = "string"
targetResourceName = "string"
targetResourceType = "string"
timestamp = "string"
title = "string"
}
]
healthState = "string"
lastChecked = "string"
lastUpdated = "string"
oemFamily = "string"
packageVersions = [
{
lastUpdated = "string"
packageType = "string"
version = "string"
}
]
state = "string"
}
}
}
Property Values
Microsoft.AzureStackHCI/clusters/updateSummaries
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string |
| name | The resource name | 'default' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: clusters |
| properties | Update summaries properties | UpdateSummariesProperties |
| type | The resource type | "Microsoft.AzureStackHCI/clusters/updateSummaries@2026-03-01-preview" |
PackageVersionInfo
| Name | Description | Value |
|---|---|---|
| lastUpdated | Last time this component was updated. | string |
| packageType | Package type | string |
| version | Package version | string |
PrecheckResult
| Name | Description | Value |
|---|---|---|
| additionalData | Property bag of key value pairs for additional information. | string |
| description | Detailed overview of the issue and what impact the issue has on the stamp. | string |
| displayName | The health check DisplayName localized of the individual test executed. | string |
| healthCheckSource | The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). | string |
| healthCheckTags | Key-value pairs that allow grouping/filtering individual tests. | any |
| name | Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. | string |
| remediation | Set of steps that can be taken to resolve the issue found. | string |
| severity | Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. | 'Critical' 'Hidden' 'Informational' 'Warning' |
| status | Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. | 'ConnectedRecently' 'DeploymentFailed' 'DeploymentInProgress' 'DeploymentSuccess' 'Disconnected' 'Error' 'NotConnectedRecently' 'NotSpecified' 'NotYetRegistered' 'ValidationFailed' 'ValidationInProgress' 'ValidationSuccess' |
| tags | Key-value pairs that allow grouping/filtering individual tests. | PrecheckResultTags |
| targetResourceID | The unique identifier for the affected resource (such as a node or drive). | string |
| targetResourceName | The name of the affected resource. | string |
| targetResourceType | The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). | string |
| timestamp | The time in which the HealthCheck was called. | string |
| title | User-facing name; one or more sentences indicating the direct issue. | string |
PrecheckResultTags
| Name | Description | Value |
|---|---|---|
| key | Key that allow grouping/filtering individual tests. | string |
| value | Value of the key that allow grouping/filtering individual tests. | string |
UpdateSummariesProperties
| Name | Description | Value |
|---|---|---|
| currentOemVersion | Current OEM Version. | string |
| currentSbeVersion | Current Sbe version of the stamp. | string |
| currentVersion | Current Solution Bundle version of the stamp. | string |
| hardwareModel | Name of the hardware model. | string |
| healthCheckDate | Last time the package-specific checks were run. | string |
| healthCheckResult | An array of pre-check result objects. | PrecheckResult[] |
| healthState | Overall health state for update-specific health checks. | 'Error' 'Failure' 'InProgress' 'Success' 'Unknown' 'Warning' |
| lastChecked | Last time the update service successfully checked for updates | string |
| lastUpdated | Last time an update installation completed successfully. | string |
| oemFamily | OEM family name. | string |
| packageVersions | Current version of each updatable component. | PackageVersionInfo[] |
| state | Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. | 'AppliedSuccessfully' 'NeedsAttention' 'PreparationFailed' 'PreparationInProgress' 'Unknown' 'UpdateAvailable' 'UpdateFailed' 'UpdateInProgress' |