Partager via

IPropertyCmdletProvider Interface

  • Reference

Definition

Namespace:
System.Management.Automation.Provider
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

An interface that can be implemented by a Cmdlet provider to expose properties of an item.

public interface class IPropertyCmdletProvider
public interface IPropertyCmdletProvider
[System.Runtime.CompilerServices.NullableContext(1)]
public interface IPropertyCmdletProvider
type IPropertyCmdletProvider = interface
[<System.Runtime.CompilerServices.NullableContext(1)>]
type IPropertyCmdletProvider = interface
Public Interface IPropertyCmdletProvider
Derived
Attributes
NullableContextAttribute

Remarks

An IPropertyCmdletProvider provider implements a set of methods that allows the use of a set of core commands against the data store that the provider gives access to. By implementing this interface users can take advantage the commands that expose the contents of an item. get-itemproperty set-itemproperty etc. This interface should only be implemented on derived classes of CmdletProvider, ItemCmdletProvider, ContainerCmdletProvider, or NavigationCmdletProvider.

A namespace provider should implemented this interface if items in the namespace have properties the provide wishes to expose.

Methods

ClearProperty(String, Collection<String>)

Clears a property of the item at the specified path.
ClearPropertyDynamicParameters(String, Collection<String>)

Gives the provider an opportunity to attach additional parameters to the clear-itemproperty cmdlet.
GetProperty(String, Collection<String>)

Gets the properties of the item specified by the path.
GetPropertyDynamicParameters(String, Collection<String>)

Gives the provider an opportunity to attach additional parameters to the get-itemproperty cmdlet.
SetProperty(String, PSObject)

Sets the specified properties of the item at the specified path.
SetPropertyDynamicParameters(String, PSObject)

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

Applies to