NewPSSessionConfigurationFileCommand Class

Definition

New-PSSessionConfigurationFile command implementation

See Declarative Initial Session State (DISC)

public ref class NewPSSessionConfigurationFileCommand : System::Management::Automation::PSCmdlet
public class NewPSSessionConfigurationFileCommand : System.Management.Automation.PSCmdlet
[System.Management.Automation.Cmdlet("New", "PSSessionConfigurationFile", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096791")]
public class NewPSSessionConfigurationFileCommand : System.Management.Automation.PSCmdlet
type NewPSSessionConfigurationFileCommand = class
    inherit PSCmdlet
[<System.Management.Automation.Cmdlet("New", "PSSessionConfigurationFile", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096791")>]
type NewPSSessionConfigurationFileCommand = class
    inherit PSCmdlet
Public Class NewPSSessionConfigurationFileCommand
Inherits PSCmdlet
Inheritance
NewPSSessionConfigurationFileCommand
Attributes

Constructors

NewPSSessionConfigurationFileCommand()

Properties

AliasDefinitions

A list of aliases.

AssembliesToLoad

A list of assemblies to load.

Author

Author of the configuration file.

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

Company name.

Copyright

Copyright information.

CurrentPSTransaction

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

(Inherited from Cmdlet)
Description

Description.

EnvironmentVariables

A list of environment variables.

Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
ExecutionPolicy

Execution policy.

FormatsToProcess

A list of format data to process.

Full

Gets or sets whether to include a full expansion of all possible session configuration keys as comments when creating the session configuration file.

FunctionDefinitions

A list of functions.

GroupManagedServiceAccount

Optional parameter that specifies a Group Managed Service Account name in which the configuration is run.

Guid

Configuration file GUID.

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

Language mode.

ModulesToImport

A list of modules to import.

MountUserDrive

Creates a User PSDrive in the session. The User drive is used with Copy-Item for file transfer when the FileSystem provider is not visible in the session.

MyInvocation

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

(Inherited from PSCmdlet)
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)
Path

Destination path.

PowerShellVersion

PowerShell version.

RequiredGroups

Specifies account groups that are membership requirements for this session.

RoleDefinitions

Role definitions for this session configuration (Role name -> Role capability)

RunAsVirtualAccount

Specifies whether to run this configuration under a virtual account.

RunAsVirtualAccountGroups

Specifies groups a virtual account is part of.

SchemaVersion

Configuration file schema version.

ScriptsToProcess

Scripts to process.

SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SessionType

Specifies type of initial session state to use.

Stopping

Is this command stopping?

(Inherited from Cmdlet)
TranscriptDirectory

Specifies the directory for transcripts to be placed.

TypesToProcess

A list of types to process.

UserDriveMaximumSize

Optional parameter that specifies a maximum size in bytes for the User: drive created with the MountUserDrive parameter. If no maximum size is specified then the default drive maximum size is 50MB.

VariableDefinitions

A list of variables.

VisibleAliases

A list of visible aliases.

VisibleCmdlets

A list of visible cmdlets.

VisibleExternalCommands

A list of visible external commands (scripts and applications)

VisibleFunctions

A list of visible functions.

VisibleProviders

A list of providers.

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