NewModuleManifestCommand Class

Definition

Cmdlet to create a new module manifest file.

public ref class NewModuleManifestCommand sealed : System::Management::Automation::PSCmdlet
[System.Management.Automation.Cmdlet("New", "ModuleManifest", HelpUri="https://go.microsoft.com/fwlink/?LinkID=141555", SupportsShouldProcess=true)]
[System.Management.Automation.OutputType(new System.Type[] { typeof(System.String) })]
[System.Management.Automation.Cmdlet("New", "ModuleManifest", ConfirmImpact=System.Management.Automation.ConfirmImpact.Low, HelpUri="https://go.microsoft.com/fwlink/?LinkID=141555", SupportsShouldProcess=true)]
public sealed class NewModuleManifestCommand : System.Management.Automation.PSCmdlet
type NewModuleManifestCommand = class
    inherit PSCmdlet
Public NotInheritable Class NewModuleManifestCommand
Inherits PSCmdlet
Inheritance
NewModuleManifestCommand
Attributes

Constructors

NewModuleManifestCommand()

Properties

AliasesToExport

Specify any aliases to export from this manifest.

Author

Set the author string in the manifest

ClrVersion

Set the CLR version required by the module.

CmdletsToExport

Specify any cmdlets to export from this manifest.

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)
CompanyName

Set the company name in the manifest

CompatiblePSEditions

Specify compatible PSEditions of this module.

Copyright

Set the copyright string in the module manifest

CurrentPSTransaction

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

(Inherited from Cmdlet)
DefaultCommandPrefix

Specify the Default Command Prefix

Description

Set the module description

DotNetFrameworkVersion

Set the version of .NET Framework required by the module.

DscResourcesToExport

Specify any dsc resources to export from this manifest.

Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
FileList

Specify any additional files used by this module.

FormatsToProcess

Sets the list of formats files for the module

FunctionsToExport

Specify any functions to export from this manifest.

Guid

Set the GUID in the manifest file

HelpInfoUri

Specify the HelpInfo URI

Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
IconUri

Specify the IconUri.

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

Repostiory for jobs

(Inherited from PSCmdlet)
LicenseUri

Specify the LicenseUri.

ModuleList

List of other modules included with this module. Like the RequiredModules key, this list can be a simple list of module names or a complex list of module hashtables.

ModuleVersion

Set the module version...

MyInvocation

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

(Inherited from PSCmdlet)
NestedModules

Sets the list of files to load by default...

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 module manifest string to be to the output stream...

Path

The output path for the generated file...

PowerShellHostName

Set the name of PowerShell host required by the module.

PowerShellHostVersion

Set the version of PowerShell host required by the module.

PowerShellVersion

Set the PowerShell version required by this module

PrivateData

Specify any module-specific private data here.

ProcessorArchitecture

Set the ProcessorArchitecture required by this module

ProjectUri

Specify the ProjectUri.

ReleaseNotes

Specify the ReleaseNotes.

RequiredAssemblies

Set the list of assemblies to load for this module.

RequiredModules

Sets the list of Dependencies for the module

RootModule

Set the module version...

ScriptsToProcess

Sets the list of ps1 scripts to run in the session state of the import-module invocation.

SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
Stopping

Is this command stopping?

(Inherited from Cmdlet)
Tags

Specify any Tags.

TypesToProcess

Sets the list of types files for the module

VariablesToExport

Specify any variables to export from this manifest.

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)
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) (Inherited from PSCmdlet)
GetVariableValue(String, Object) (Inherited from PSCmdlet)
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)

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)

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)

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)

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)

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)

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)

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()

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)

Writes the object to the output pipe.

(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)
WriteProgress(ProgressRecord)

Display progress information

(Inherited from Cmdlet)
WriteVerbose(String)

Display verbose information

(Inherited from Cmdlet)
WriteWarning(String)

Display warning information

(Inherited from Cmdlet)

Applies to