Set-AzStackHciUpdateRun

Reference

Module:: Az.StackHCI

Put Update runs for a specified update

Syntax

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>]

Set-AzStackHciUpdateRun
   -ClusterName <String>
   -Name <String>
   -ResourceGroupName <String>
   -UpdateName <String>
   [-SubscriptionId <String>]
   -UpdateRunsProperty <IUpdateRun>
   [-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.

Type:	String
Position:	Named
Default value:	None
Required:	True
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

-Duration

Duration of the update run.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LastUpdatedTime

Timestamp of the most recently completed step in the update run.

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

-Name

The name of the Update Run

Type:	String
Aliases:	UpdateRunName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressDescription

More detailed description of the step.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressEndTimeUtc

When the step reached a terminal state.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressErrorMessage

Error message, specified if the step is in a failed state.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressLastUpdatedTimeUtc

Completion time of this step or the last completed sub-step.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressName

Name of the step.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressStartTimeUtc

When the step started, or empty if it has not started executing.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressStatus

Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressStep

Recursive model for child steps of this step. To construct, see NOTES section for PROGRESSSTEP properties and create a hash table.

Type:	IStep[]
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 run.

Type:	UpdateRunPropertiesState
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

-TimeStarted

Timestamp of the update run was started.

Type:	DateTime
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UpdateName

The name of the Update

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-UpdateRunsProperty

Details of an Update run To construct, see NOTES section for UPDATERUNSPROPERTY properties and create a hash table.

Type:	IUpdateRun
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

IUpdateRun

Outputs