CauBaseCommand Class

Article
10/10/2016

Provides cluster-aware updating (CAU) functionality for cmdlets.

Namespace: Microsoft.ClusterAwareUpdating.Commands
Assembly: ClusterAwareUpdating (in ClusterAwareUpdating.dll)

Inheritance Hierarchy

Syntax

public abstract class CauBaseCommand : PSCmdlet, IDisposable

public ref class CauBaseCommand abstract : PSCmdlet, IDisposable

[<AbstractClass>]
type CauBaseCommand = 
    class
        inherit PSCmdlet
        interface IDisposable
    end

Public MustInherit Class CauBaseCommand
    Inherits PSCmdlet
    Implements IDisposable

Constructors

	Name	Description
	CauBaseCommand()

Properties

	Name	Description
	CancelTS	An object that manages the cancellation of this command.
	CommandOrigin	(Inherited from InternalCommand.)
	CommandRuntime	(Inherited from Cmdlet.)
	CurrentPSTransaction	(Inherited from Cmdlet.)
	Disposed	Indicates whether the resources that are used by the cluster-aware updating (CAU) are released.
	Events	(Inherited from PSCmdlet.)
	Host	(Inherited from PSCmdlet.)
	InvokeCommand	(Inherited from PSCmdlet.)
	InvokeProvider	(Inherited from PSCmdlet.)
	IsOnPipelineThread	Indicates whether the command is on the pipeline thread.
	JobManager	(Inherited from PSCmdlet.)
	JobRepository	(Inherited from PSCmdlet.)
	MyInvocation	(Inherited from PSCmdlet.)
	PagingParameters	(Inherited from PSCmdlet.)
	ParameterSetName	(Inherited from PSCmdlet.)
	SessionState	(Inherited from PSCmdlet.)
	Stopping	(Inherited from Cmdlet.)
	SyncRoot	An object that is used to synchronize this command's access to the pipeline thread.

Methods

	Name	Description
	BeginProcessing()	Performs initialization before command execution.(Overrides Cmdlet.BeginProcessing().)
	CheckForCancellation()	Throws an exception if this command has had cancellation requested.
	CheckPrivilege(PSCredential)	Checks the user's privileges on the cluster.
	CurrentProviderLocation(String)	(Inherited from PSCmdlet.)
	Dispose()	Releases both unmanaged and managed resources that are used by the cluster-aware updating (CAU) without running the finalizer.
	Dispose(Boolean)	Releases unmanaged resources that are used by the cluster-aware updating (CAU) and optionally releases managed resources that are used by the CAU.
	EndProcessing()	Performs cleanup after the command execution.(Overrides Cmdlet.EndProcessing().)
	Equals(Object)	(Inherited from Object.)
	FailFast(String, Exception)	Handles an unexpected exception that was thrown during processing of a cmdlet.
	Finalize()	(Inherited from Object.)
	GetCommand()	Retrieves the command to invoke.
	GetHashCode()	(Inherited from Object.)
	GetNextActivityId()	Retrieves the identifier of the next activity in the pipeline thread.
	GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet.)
	GetResourceString(String, String)	(Inherited from Cmdlet.)
	GetType()	(Inherited from Object.)
	GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet.)
	GetVariableValue(String)	(Inherited from PSCmdlet.)
	GetVariableValue(String, Object)	(Inherited from PSCmdlet.)
	IgnorePipelineStopped(Action)	Attempts to process an action that is in the pipeline and ignores a PipelineStoppedException if it is thrown.
	Invoke()	(Inherited from Cmdlet.)
	MemberwiseClone()	(Inherited from Object.)
	ProcessRecord()	(Inherited from Cmdlet.)
	ProcessTaskActions(Task, String)	Allows a task to process a cmdlet's action.
	QueueSafeAction(Action)	Processes an action that is in the pipeline.
	SafeWriteDebug(String)
	SafeWriteDebug(String, Object[])
	SafeWriteError(ClusterUpdateException)
	SafeWriteError(ErrorRecord)
	SafeWriteError(Exception, String, ErrorCategory, Object)
	SafeWriteError(String, String, ErrorCategory, Exception)
	SafeWriteError(String, String, ErrorCategory, Object)
	SafeWriteObject(Object)
	SafeWriteProgress(ProgressRecord)
	SafeWriteVerbose(String)
	SafeWriteVerbose(String, Object[])
	SafeWriteWarning(String)
	SafeWriteWarning(String, Object[])
	ShouldContinue(String, String)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldContinue(String, String, Boolean, Boolean)	(Inherited from Cmdlet.)
	ShouldDoIt(String, String, String, Boolean)	Requests confirmation from the user before an operation is performed. This method combines the ShouldProcess and ShouldContinue methods.
	ShouldProcess(String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String)	(Inherited from Cmdlet.)
	ShouldProcess(String, String, String, ShouldProcessReason)	(Inherited from Cmdlet.)
	SignalDone()	Marks a task as complete when the task has completed the actions.
	StopProcessing()	(Overrides Cmdlet.StopProcessing().)
	ThrowTerminatingError(ClusterUpdateException)
	ThrowTerminatingError(ErrorRecord)
	ThrowTerminatingError(Exception, String, ErrorCategory, Object)
	ToString()	(Overrides Object.ToString().)
	TransactionAvailable()	(Inherited from Cmdlet.)
	Uninitialize()
	ValidateWarnStopAfter(TimeSpan, TimeSpan)
	WriteCommandDetail(String)	(Inherited from Cmdlet.)
	WriteDebug(String)
	WriteError(ClusterUpdateException)
	WriteError(ErrorRecord)
	WriteError(Exception, String, ErrorCategory, Object)
	WriteErrorsForAggregateException(AggregateException, String)
	WriteInformation(InformationRecord)	(Inherited from Cmdlet.)
	WriteInformation(Object, String[])	(Inherited from Cmdlet.)
	WriteObject(Object)	(Inherited from Cmdlet.)
	WriteObject(Object, Boolean)	(Inherited from Cmdlet.)
	WriteProgress(ProgressRecord)	(Inherited from Cmdlet.)
	WriteVerbose(String)
	WriteWarning(String)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.