ImportModuleCommand ImportModuleCommand ImportModuleCommand ImportModuleCommand Class

Definition

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=141553")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.Management.Automation.PSModuleInfo) })]
public sealed class ImportModuleCommand : Microsoft.PowerShell.Commands.ModuleCmdletBase, IDisposable
type ImportModuleCommand = class
    inherit ModuleCmdletBase
    interface IDisposable
Public NotInheritable Class ImportModuleCommand
Inherits ModuleCmdletBase
Implements IDisposable
Inheritance
Attributes
Implements

Constructors

ImportModuleCommand() ImportModuleCommand() ImportModuleCommand() ImportModuleCommand()

Properties

AddToAppDomainLevelCache AddToAppDomainLevelCache AddToAppDomainLevelCache AddToAppDomainLevelCache

Add module path to app domain level module path cache if name is not rooted

(Inherited from ModuleCmdletBase)
Alias Alias Alias Alias

This parameter specifies the aliases to import from the module...

ArgumentList ArgumentList ArgumentList ArgumentList

The arguments to pass to the module script.

AsCustomObject AsCustomObject AsCustomObject AsCustomObject

This parameter causes the session state instance to be written as a custom object...

Assembly Assembly Assembly Assembly

A list of assembly objects to process as modules.

BaseArgumentList BaseArgumentList BaseArgumentList BaseArgumentList

The arguments to pass to the scriptblock used to create the module

(Inherited from ModuleCmdletBase)
BaseDisableNameChecking BaseDisableNameChecking BaseDisableNameChecking BaseDisableNameChecking

Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun.

(Inherited from ModuleCmdletBase)
CimNamespace CimNamespace CimNamespace CimNamespace

For interoperability with 3rd party CIM servers, user can specify custom namespace

CimResourceUri CimResourceUri CimResourceUri CimResourceUri

For interoperability with 3rd party CIM servers, user can specify custom resource URI

CimSession CimSession CimSession CimSession

If specified, then Import-Module will attempt to import PS-CIM modules from a remote computer using the specified session

Cmdlet Cmdlet Cmdlet Cmdlet

This patterns matching the names of cmdlets to import from the module...

CommandOrigin CommandOrigin CommandOrigin CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime CommandRuntime CommandRuntime CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction CurrentPSTransaction

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

(Inherited from Cmdlet)
DisableNameChecking DisableNameChecking DisableNameChecking DisableNameChecking

Disable warnings on cmdlet and function names that have non-standard verbs or non-standard characters in the noun.

Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Force Force Force Force

This parameter causes a module to be loaded over top of the current one...

FullyQualifiedName FullyQualifiedName FullyQualifiedName FullyQualifiedName

This parameter specifies the current pipeline object

Function Function Function Function

This patterns matching the names of functions to import from the module...

Global Global Global Global

This parameter specifies whether to import to the current session state or to the global / top-level session state

Host Host Host Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InvokeCommand InvokeCommand InvokeCommand InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider InvokeProvider InvokeProvider InvokeProvider

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

(Inherited from PSCmdlet)
JobManager JobManager JobManager JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository JobRepository JobRepository JobRepository

Repostiory for jobs

(Inherited from PSCmdlet)
MaximumVersion MaximumVersion MaximumVersion MaximumVersion

The maximum version of the module to load.

MinimumVersion MinimumVersion MinimumVersion MinimumVersion

The minimum version of the module to load.

ModuleInfo ModuleInfo ModuleInfo ModuleInfo

This parameter specifies the current pipeline object

MyInvocation MyInvocation MyInvocation MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
Name Name Name Name

This parameter names the module to load.

NoClobber NoClobber NoClobber NoClobber

Does not import a command if a command with same name exists on the target sessionstate.

PagingParameters PagingParameters PagingParameters 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 ParameterSetName ParameterSetName ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
PassThru PassThru PassThru PassThru

This parameter causes the session state instance to be written...

Prefix Prefix Prefix Prefix

This parameter specified a prefix used to modify names of imported commands

PSSession PSSession PSSession PSSession

If specified, then Import-Module will attempt to import PowerShell modules from a remote computer using the specified session

RequiredVersion RequiredVersion RequiredVersion RequiredVersion

The version of the module to load.

Scope Scope Scope Scope

Imports a command to the scope specified

SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SkipEditionCheck SkipEditionCheck SkipEditionCheck SkipEditionCheck
Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
Variable Variable Variable Variable

This parameter specifies the variables to import from the module...

Methods

BeginProcessing() BeginProcessing() BeginProcessing() 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) CurrentProviderLocation(String) CurrentProviderLocation(String) CurrentProviderLocation(String) Inherited from PSCmdlet
Dispose() Dispose() Dispose() Dispose()

Releases resources associated with this object

EndProcessing() EndProcessing() EndProcessing() 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) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) GetResolvedProviderPathFromPSPath(String, ProviderInfo) Inherited from PSCmdlet
GetResourceString(String, String) GetResourceString(String, String) GetResourceString(String, String) 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) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) GetUnresolvedProviderPathFromPSPath(String) Inherited from PSCmdlet
GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) GetVariableValue(String) Inherited from PSCmdlet
GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) GetVariableValue(String, Object) Inherited from PSCmdlet
ImportModuleMembers(PSModuleInfo, String) ImportModuleMembers(PSModuleInfo, String) ImportModuleMembers(PSModuleInfo, String) ImportModuleMembers(PSModuleInfo, String)

Import the script-level functions from one session state to another, calling WriteVerbose for each imported member...

(Inherited from ModuleCmdletBase)
ImportModuleMembers(PSModuleInfo, String, ModuleCmdletBase+ImportModuleOptions) ImportModuleMembers(PSModuleInfo, String, ModuleCmdletBase+ImportModuleOptions) ImportModuleMembers(PSModuleInfo, String, ModuleCmdletBase+ImportModuleOptions) 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)
Invoke() Invoke() Invoke() Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>() Invoke<T>() Invoke<T>() Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord() ProcessRecord() ProcessRecord() ProcessRecord()

When overridden in the derived class, performs execution of the command.

(Inherited from Cmdlet)
ShouldContinue(String, String) ShouldContinue(String, String) ShouldContinue(String, String) 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)
ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean) 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, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) ShouldContinue(String, String, Boolean, Boolean, Boolean) 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)
ShouldProcess(String) ShouldProcess(String) ShouldProcess(String) 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)
ShouldProcess(String, String) ShouldProcess(String, String) ShouldProcess(String, String) 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, String, String) ShouldProcess(String, String, String) ShouldProcess(String, String, String) 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, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) ShouldProcess(String, String, String, ShouldProcessReason) 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)
StopProcessing() StopProcessing() StopProcessing() 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) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord) ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error

(Inherited from Cmdlet)
TransactionAvailable() TransactionAvailable() TransactionAvailable() TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String) WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String) WriteDebug(String) WriteDebug(String) WriteDebug(String)

Display debug information

(Inherited from Cmdlet)
WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord) WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord) WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[]) WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object) WriteObject(Object) WriteObject(Object) WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean) WriteObject(Object, Boolean) WriteObject(Object, Boolean) 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)
WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord) WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String) WriteVerbose(String) WriteVerbose(String) WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String) WriteWarning(String) WriteWarning(String) WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to