Share via


Remove-ServiceFabricRepairTask

Removes a completed repair task.

Syntax

Default (Default)

Remove-ServiceFabricRepairTask
    [-TaskId] <String>
    [[-Version] <Int64>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The Remove-ServiceFabricRepairTask cmdlet removes a completed Service Fabric repair task. In order to delete a repair task, it must be in the completed state.

This cmdlet supports the Service Fabric platform. Do not run this cmdlet directly.

This cmdlet requires that you connect to the cluster with credentials that are granted administrator access to the cluster. Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

Examples

Example 1: Remove a single repair task

PS C:\> Remove-ServiceFabricRepairTask -TaskId "MyRepairTaskID"

This command removes the repair task that has the ID MyRepairTaskID if it is completed.

Example 2: Remove all completed repair tasks

PS C:\> Get-ServiceFabricRepairTask -State Completed | Remove-ServiceFabricRepairTask

This command removes all completed repair tasks.

Parameters

-TaskId

Specifies the ID of the completed repair task that this cmdlet removes.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Parameter properties

Type:Int32
Default value:None
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

-Version

Specifies the current version of the repair task. The request can succeed only if the value that this parameter specifies matches the current value of the repair task. Specify a value of zero (0) to skip version check.

Parameter properties

Type:Int64
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
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.

Inputs

System.String

System.Int64

Outputs

System.Object