NewModuleManifestCommand Class

Definition

Cmdlet to create a new module manifest file.

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

Constructors

NewModuleManifestCommand()

Properties

AliasesToExport

Gets or sets the aliases to export from this manifest.

Author

Gets or sets the author string in the manifest.

ClrVersion

Gets or sets the CLR version required by the module.

CmdletsToExport

Gets or sets the 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

Gets or sets the company name in the manifest.

CompatiblePSEditions

Gets or sets the compatible PSEditions of this module.

Copyright

Gets or sets 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

Gets or sets the Default Command Prefix.

Description

Gets or sets the module description.

DotNetFrameworkVersion

Gets or sets the version of .NET Framework required by the module.

DscResourcesToExport

Gets or sets the dsc resources to export from this manifest.

Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
ExternalModuleDependencies

Gets or sets the external module dependencies.

FileList

Gets or sets the additional files used by this module.

FormatsToProcess

Gets or sets the list of formats files for the module.

FunctionsToExport

Gets or sets the functions to export from this manifest.

Guid

Gets or sets the GUID in the manifest file.

HelpInfoUri

Gets or sets the HelpInfo URI.

Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
IconUri

Gets or sets 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

Repository for jobs.

(Inherited from PSCmdlet)
LicenseUri

Gets or sets the LicenseUri.

ModuleList

Gets or sets the 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

Gets or sets the module version.

MyInvocation

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

(Inherited from PSCmdlet)
NestedModules

Gets or 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

Gets or sets whether the module manifest string should go to the output stream.

Path

Gets or sets the output path for the generated file.

PowerShellHostName

Gets or sets the name of PowerShell host required by the module.

PowerShellHostVersion

Gets or sets the version of PowerShell host required by the module.

PowerShellVersion

Gets or sets the PowerShell version required by this module.

Prerelease

Gets or sets whether or not the module is a prerelease.

PrivateData

Gets or sets the module-specific private data here.

ProcessorArchitecture

Gets or sets the ProcessorArchitecture required by this module.

ProjectUri

Gets or sets the ProjectUri.

ReleaseNotes

Gets or sets the ReleaseNotes.

RequiredAssemblies

Gets or sets the list of assemblies to load for this module.

RequiredModules

Gets or sets the list of Dependencies for the module.

RequireLicenseAcceptance

Gets or sets whether or not the module requires explicit user acceptance for install/update/save.

RootModule

Gets or sets the root module.

ScriptsToProcess

Gets or 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

Gets or sets the Tags.

TypesToProcess

Gets or sets the list of types files for the module.

VariablesToExport

Gets or sets the 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