ImportModuleCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

Implements a cmdlet that loads a module.

public ref class ImportModuleCommand sealed : Microsoft::PowerShell::Commands::ModuleCmdletBase, IDisposable

[System.Management.Automation.Cmdlet("Import", "Module", DefaultParameterSetName="Name", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096585")]
[System.Management.Automation.OutputType(typeof(System.Management.Automation.PSModuleInfo))]
public sealed class ImportModuleCommand : Microsoft.PowerShell.Commands.ModuleCmdletBase, IDisposable

[<System.Management.Automation.Cmdlet("Import", "Module", DefaultParameterSetName="Name", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096585")>]
[<System.Management.Automation.OutputType(typeof(System.Management.Automation.PSModuleInfo))>]
type ImportModuleCommand = class
    inherit ModuleCmdletBase
    interface IDisposable

Public NotInheritable Class ImportModuleCommand
Inherits ModuleCmdletBase
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

ModuleCmdletBase

ImportModuleCommand

Attributes

CmdletAttribute OutputTypeAttribute

Implements

IDisposable

Constructors

ImportModuleCommand()

Properties

AddToAppDomainLevelCache	Add module path to app domain level module path cache if name is not rooted. (Inherited from ModuleCmdletBase)
Alias	This parameter specifies the aliases to import from the module...
ArgumentList	The arguments to pass to the module script.
AsCustomObject	This parameter causes the session state instance to be written as a custom object...
Assembly	A list of assembly objects to process as modules.
BaseArgumentList	The arguments to pass to the scriptblock used to create the module. (Inherited from ModuleCmdletBase)
BaseDisableNameChecking	Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun. (Inherited from ModuleCmdletBase)
CimNamespace	For interoperability with 3rd party CIM servers, user can specify custom namespace.
CimResourceUri	For interoperability with 3rd party CIM servers, user can specify custom resource URI.
CimSession	If specified, then Import-Module will attempt to import PS-CIM modules from a remote computer using the specified session.
Cmdlet	This patterns matching the names of cmdlets to import from the module...
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
DisableNameChecking	Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Force	This parameter causes a module to be loaded over top of the current one...
FullyQualifiedName	This parameter specifies the current pipeline object.
Function	This patterns matching the names of functions to import from the module...
Global	This parameter specifies whether to import to the current session state or to the global / top-level session state.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
MaximumVersion	The maximum version of the module to load.
MinimumVersion	The minimum version of the module to load.
ModuleInfo	This parameter specifies the current pipeline object.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
Name	This parameter names the module to load.
NoClobber	Does not import a command if a command with same name exists on the target sessionstate.
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
PassThru	This parameter causes the session state instance to be written...
Prefix	This parameter specified a prefix used to modify names of imported commands.
PSSession	If specified, then Import-Module will attempt to import PowerShell modules from a remote computer using the specified session.
RequiredVersion	The version of the module to load.
Scope	Imports a command to the scope specified.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
SkipEditionCheck	Skips the check on CompatiblePSEditions for modules loaded from the System32 module path. This is mutually exclusive with UseWindowsPowerShell parameter.
Stopping	Is this command stopping? (Inherited from Cmdlet)
UseWindowsPowerShell	This parameter causes a module to be loaded into Windows PowerShell. This is mutually exclusive with SkipEditionCheck parameter.
Variable	This parameter specifies the variables to import from the module...

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	Releases resources associated with this object.
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
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 Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
ImportModuleMembers(PSModuleInfo, String, ModuleCmdletBase+ImportModuleOptions)	Import the script-level functions from one session state to another, calling WriteVerbose for each imported member... (Inherited from ModuleCmdletBase)
ImportModuleMembers(PSModuleInfo, String)	Import the script-level functions from one session state to another, calling WriteVerbose for each imported member... (Inherited from ModuleCmdletBase)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	When overridden in the derived class, performs execution of the command. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
StopProcessing()	When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns. (Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)