Set-AzStackHciUpdate
Put specified Update
Syntax
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>] Set-AzStackHciUpdate
-ClusterName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-UpdateProperty <IUpdate>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Put specified Update
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailabilityType
Indicates the way the update content can be downloaded.
| Type: | AvailabilityType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClusterName
The name of the cluster.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | IPackageVersionInfo[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Description of the update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Display name of the Update
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HealthCheckDate
Last time the package-specific checks were run.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HealthCheckResult
An array of PrecheckResult objects. To construct, see NOTES section for HEALTHCHECKRESULT properties and create a hash table.
| Type: | IPrecheckResult[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HealthState
Overall health state for update-specific health checks.
| Type: | HealthState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InstalledDate
Date that the update was installed.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
The geo-location where the resource lives
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MinSbeVersionRequired
Minimum Sbe Version of the update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The name of the Update
| Type: | String |
| Aliases: | UpdateName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PackagePath
Path where the update package is available.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Single |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PackageType
Customer-visible type of the update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | IUpdatePrerequisite[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Publisher
Publisher of the update package.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RebootRequired
.
| Type: | RebootRequirement |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReleaseLink
Link to release notes for the update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-State
State of the update as it relates to this stamp.
| Type: | State |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
| Type: | String |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateProperty
Update details To construct, see NOTES section for UPDATEPROPERTY properties and create a hash table.
| Type: | IUpdate |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UpdateStatePropertyNotifyMessage
Brief message with instructions for updates of AvailabilityType Notify.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Single |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
Version of the update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell