Set-AzStackHciUpdate
Syntax
PutExpanded (Default)
Set-AzStackHciUpdate
-ClusterName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AdditionalProperty <String>]
[-AvailabilityType <AvailabilityType>]
[-ComponentVersion <IPackageVersionInfo[]>]
[-Description <String>]
[-DisplayName <String>]
[-HealthCheckDate <DateTime>]
[-HealthCheckResult <IPrecheckResult[]>]
[-HealthState <HealthState>]
[-InstalledDate <DateTime>]
[-Location <String>]
[-MinSbeVersionRequired <String>]
[-PackagePath <String>]
[-PackageSizeInMb <Single>]
[-PackageType <String>]
[-Prerequisite <IUpdatePrerequisite[]>]
[-Publisher <String>]
[-RebootRequired <RebootRequirement>]
[-ReleaseLink <String>]
[-State <State>]
[-UpdateStatePropertyNotifyMessage <String>]
[-UpdateStatePropertyProgressPercentage <Single>]
[-Version <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Put
Set-AzStackHciUpdate
-ClusterName <String>
-Name <String>
-ResourceGroupName <String>
-UpdateProperty <IUpdate>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1:
Set-AzStackHciUpdate -ClusterName 'test-cluster' -ResourceGroupName 'test-rg' -Name 'test-update'
Sets the update
Parameters
-AdditionalProperty
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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AvailabilityType
Indicates the way the update content can be downloaded.
Parameter properties
Type: AvailabilityType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ClusterName
The name of the cluster.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ComponentVersion
An array of component versions for a Solution Bundle update, and an empty array otherwise.
To construct, see NOTES section for COMPONENTVERSION properties and create a hash table.
Parameter properties
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Description
Description of the update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayName
Display name of the Update
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-HealthCheckDate
Last time the package-specific checks were run.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-HealthCheckResult
An array of PrecheckResult objects.
To construct, see NOTES section for HEALTHCHECKRESULT properties and create a hash table.
Parameter properties
Type: IPrecheckResult [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-HealthState
Overall health state for update-specific health checks.
Parameter properties
Type: HealthState
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-InstalledDate
Date that the update was installed.
Parameter properties
Type: DateTime
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The geo-location where the resource lives
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MinSbeVersionRequired
Minimum Sbe Version of the update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the Update
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: UpdateName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PackagePath
Path where the update package is available.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PackageSizeInMb
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.
Parameter properties
Type: Single
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PackageType
Customer-visible type of the update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Prerequisite
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update.
Otherwise, it is empty.
To construct, see NOTES section for PREREQUISITE properties and create a hash table.
Parameter properties
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Publisher
Publisher of the update package.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RebootRequired
.
Parameter properties
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ReleaseLink
Link to release notes for the update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-State
State of the update as it relates to this stamp.
Parameter properties
Type: State
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UpdateProperty
Update details
To construct, see NOTES section for UPDATEPROPERTY properties and create a hash table.
Parameter properties
Type: IUpdate
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Put
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-UpdateStatePropertyNotifyMessage
Brief message with instructions for updates of AvailabilityType Notify.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UpdateStatePropertyProgressPercentage
Progress percentage of ongoing operation.
Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
Parameter properties
Type: Single
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Version
Version of the update.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PutExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
