ItemCmdletProvider Class

Definition

The base class for Cmdlet providers that expose an item as an MSH path.

public ref class ItemCmdletProvider abstract : System::Management::Automation::Provider::DriveCmdletProvider
public abstract class ItemCmdletProvider : System.Management.Automation.Provider.DriveCmdletProvider
type ItemCmdletProvider = class
    inherit DriveCmdletProvider
Public MustInherit Class ItemCmdletProvider
Inherits DriveCmdletProvider
Inheritance
Derived

Remarks

The ItemCmdletProvider class is a base class that a provider derives from to

inherit a set of methods that allows the Monad engine

to provide a core set of commands for getting and setting of data on one or

more items. A provider should derive from this class if they want

to take advantage of the item core commands that are

already implemented by the Monad engine. This allows users to have common

commands and semantics across multiple providers.

Constructors

ItemCmdletProvider()

Properties

Credential

Gets the credentials under which the operation should run.

(Inherited from CmdletProvider)
CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction

(Inherited from CmdletProvider)
DynamicParameters

The dynamic parameters object populated with the values as specified by the user.

(Inherited from CmdletProvider)
Exclude

Gets the exclude wildcard patterns which is used to determine which items will be excluded when taking an action.

(Inherited from CmdletProvider)
Filter

Gets the provider specific filter that was supplied by the caller.

(Inherited from CmdletProvider)
Force

Gets the force property.

(Inherited from CmdletProvider)
Host

Gets the host interaction APIs.

(Inherited from CmdletProvider)
Include

Gets the include wildcard patterns which is used to determine which items will be included when taking an action.

(Inherited from CmdletProvider)
InvokeCommand

Gets the instance of the command invocation APIs for the current runspace.

(Inherited from CmdletProvider)
InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from CmdletProvider)
ProviderInfo

The information about the provider that is stored in the runspace on behalf of the provider.

(Inherited from CmdletProvider)
PSDriveInfo

The drive information associated with the context of the current operation.

(Inherited from CmdletProvider)
SessionState

Gets the instance of session state for the current runspace.

(Inherited from CmdletProvider)
Stopping

Indicates whether stop has been requested on this provider.

(Inherited from CmdletProvider)

Methods

ClearItem(String)

Clears the item specified by the path.

ClearItemDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the clear-item cmdlet.

ExpandPath(String)

Expand a provider path that contains wildcards to a list of provider paths that the path represents.Only called for providers that declare the ExpandWildcards capability.

GetItem(String)

Gets the item at the specified path.

GetItemDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the get-item cmdlet.

GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from CmdletProvider)
InitializeDefaultDrives()

Gives the provider the ability to map drives after initialization.

(Inherited from DriveCmdletProvider)
InvokeDefaultAction(String)

Invokes the default action on the specified item.

InvokeDefaultActionDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the invoke-item cmdlet.

IsValidPath(String)

Providers must override this method to verify the syntax and semantics of their paths.

ItemExists(String)

Determines if an item exists at the specified path.

ItemExistsDynamicParameters(String)

Gives the provider an opportunity to attach additional parameters to the test-path cmdlet.

NewDrive(PSDriveInfo)

Gives the provider an opportunity to validate the drive that is being added. It also allows the provider to modify parts of the PSDriveInfo object. This may be done for performance or reliability reasons or to provide extra data to all calls using the Drive.

(Inherited from DriveCmdletProvider)
NewDriveDynamicParameters()

Gives the provider an opportunity to attach additional parameters to the New-PSDrive cmdlet.

(Inherited from DriveCmdletProvider)
RemoveDrive(PSDriveInfo)

Gives the provider an opportunity to clean up any provider specific data for the drive that is going to be removed.

(Inherited from DriveCmdletProvider)
SetItem(String, Object)

Sets the item specified by the path.

SetItemDynamicParameters(String, Object)

Gives the provider an opportunity to attach additional parameters to the set-item cmdlet.

ShouldContinue(String, String) (Inherited from CmdletProvider)
ShouldContinue(String, String, Boolean, Boolean) (Inherited from CmdletProvider)
ShouldProcess(String) (Inherited from CmdletProvider)
ShouldProcess(String, String) (Inherited from CmdletProvider)
ShouldProcess(String, String, String) (Inherited from CmdletProvider)
ShouldProcess(String, String, String, ShouldProcessReason) (Inherited from CmdletProvider)
Start(ProviderInfo)

Gives the provider the opportunity to initialize itself.

(Inherited from CmdletProvider)
StartDynamicParameters()

Gets an object that defines the additional parameters for the Start implementation for a provider.

(Inherited from CmdletProvider)
Stop()

Called by session state when the provider is being removed.

(Inherited from CmdletProvider)
StopProcessing() (Inherited from CmdletProvider)
ThrowTerminatingError(ErrorRecord) (Inherited from CmdletProvider)
TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from CmdletProvider)
WriteDebug(String) (Inherited from CmdletProvider)
WriteError(ErrorRecord) (Inherited from CmdletProvider)
WriteInformation(InformationRecord) (Inherited from CmdletProvider)
WriteInformation(Object, String[]) (Inherited from CmdletProvider)
WriteItemObject(Object, String, Boolean)

Writes an item to the output as a PSObject with extra data attached as notes.

(Inherited from CmdletProvider)
WriteProgress(ProgressRecord) (Inherited from CmdletProvider)
WritePropertyObject(Object, String)

Writes a property object to the output as a PSObject with extra data attached as notes.

(Inherited from CmdletProvider)
WriteSecurityDescriptorObject(ObjectSecurity, String)

Writes a Security Descriptor object to the output as a PSObject with extra data attached as notes.

(Inherited from CmdletProvider)
WriteVerbose(String) (Inherited from CmdletProvider)
WriteWarning(String) (Inherited from CmdletProvider)

Applies to