Set-AzStackHciUpdateRun
Put Update runs for a specified update
Syntax
PutExpanded (Default)
Set-AzStackHciUpdateRun
-ClusterName <String>
-Name <String>
-ResourceGroupName <String>
-UpdateName <String>
[-SubscriptionId <String>]
[-Duration <String>]
[-LastUpdatedTime <DateTime>]
[-Location <String>]
[-ProgressDescription <String>]
[-ProgressEndTimeUtc <DateTime>]
[-ProgressErrorMessage <String>]
[-ProgressLastUpdatedTimeUtc <DateTime>]
[-ProgressName <String>]
[-ProgressStartTimeUtc <DateTime>]
[-ProgressStatus <String>]
[-ProgressStep <IStep[]>]
[-State <UpdateRunPropertiesState>]
[-TimeStarted <DateTime>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Put
Set-AzStackHciUpdateRun
-ClusterName <String>
-Name <String>
-ResourceGroupName <String>
-UpdateName <String>
-UpdateRunsProperty <IUpdateRun>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Put Update runs for a specified update
Examples
Example 1:
Set-AzStackHciUpdateRun -ClusterName 'test-cluster' -ResourceGroupName 'test-rg' -UpdateRunName 'test-update-run' -UpdateName 'test-update'
Sets the update run
Parameters
-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
-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
-Duration
Duration of the update run.
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
-LastUpdatedTime
Timestamp of the most recently completed step in the update 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
-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
-Name
The name of the Update Run
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: UpdateRunName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProgressDescription
More detailed description of the step.
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
-ProgressEndTimeUtc
When the step reached a terminal state.
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
-ProgressErrorMessage
Error message, specified if the step is in a failed state.
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
-ProgressLastUpdatedTimeUtc
Completion time of this step or the last completed sub-step.
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
-ProgressName
Name of the step.
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
-ProgressStartTimeUtc
When the step started, or empty if it has not started executing.
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
-ProgressStatus
Status of the step, bubbled up from the ECE action plan for installation attempts.
Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
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
-ProgressStep
Recursive model for child steps of this step.
To construct, see NOTES section for PROGRESSSTEP properties and create a hash table.
Parameter properties
Type: IStep [ ]
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 run.
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
-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
-TimeStarted
Timestamp of the update run was started.
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
-UpdateName
The name of the Update
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
-UpdateRunsProperty
Details of an Update run
To construct, see NOTES section for UPDATERUNSPROPERTY properties and create a hash table.
Parameter properties
Type: IUpdateRun
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
-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
