NewPSSessionConfigurationFileCommand NewPSSessionConfigurationFileCommand NewPSSessionConfigurationFileCommand NewPSSessionConfigurationFileCommand Class

Definition

New-PSSessionConfigurationFile command implementation

See Declarative Initial Session State (DISC)

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

Constructors

NewPSSessionConfigurationFileCommand() NewPSSessionConfigurationFileCommand() NewPSSessionConfigurationFileCommand() NewPSSessionConfigurationFileCommand()

Properties

AliasDefinitions AliasDefinitions AliasDefinitions AliasDefinitions

A list of alises

AssembliesToLoad AssembliesToLoad AssembliesToLoad AssembliesToLoad

A list of assemblies to load

Author Author Author Author

Author of the configuration file

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

Company name

Copyright Copyright Copyright Copyright

Copyright information

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

Description

EnvironmentVariables EnvironmentVariables EnvironmentVariables EnvironmentVariables

A list of environment variables

Events Events Events Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
ExecutionPolicy ExecutionPolicy ExecutionPolicy ExecutionPolicy

Execution policy

FormatsToProcess FormatsToProcess FormatsToProcess FormatsToProcess

A list of format data to process

Full Full Full 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 FunctionDefinitions FunctionDefinitions FunctionDefinitions

A list of functions

GroupManagedServiceAccount GroupManagedServiceAccount GroupManagedServiceAccount GroupManagedServiceAccount

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

Guid Guid Guid Guid

Configuration file GUID

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

Languange mode

ModulesToImport ModulesToImport ModulesToImport ModulesToImport

A list of modules to import

MountUserDrive MountUserDrive MountUserDrive 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 MyInvocation MyInvocation MyInvocation

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

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

Destination path

PowerShellVersion PowerShellVersion PowerShellVersion PowerShellVersion

PowerShell version

RequiredGroups RequiredGroups RequiredGroups RequiredGroups

Specifies account groups that are membership requirements for this session

RoleDefinitions RoleDefinitions RoleDefinitions RoleDefinitions

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

RunAsVirtualAccount RunAsVirtualAccount RunAsVirtualAccount RunAsVirtualAccount

Specifies whether to run this configuration under a virtual account.

RunAsVirtualAccountGroups RunAsVirtualAccountGroups RunAsVirtualAccountGroups RunAsVirtualAccountGroups

Specifies groups a virtual account is part of.

SchemaVersion SchemaVersion SchemaVersion SchemaVersion

Configuration file schema version

ScriptsToProcess ScriptsToProcess ScriptsToProcess ScriptsToProcess

Scripts to process

SessionState SessionState SessionState SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
SessionType SessionType SessionType SessionType

Specifies type of initial session state to use.

Stopping Stopping Stopping Stopping

Is this command stopping?

(Inherited from Cmdlet)
TranscriptDirectory TranscriptDirectory TranscriptDirectory TranscriptDirectory

Specifies the directory for transcripts to be placed.

TypesToProcess TypesToProcess TypesToProcess TypesToProcess

A list of types to process

UserDriveMaximumSize UserDriveMaximumSize UserDriveMaximumSize 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 VariableDefinitions VariableDefinitions VariableDefinitions

A list of variables

VisibleAliases VisibleAliases VisibleAliases VisibleAliases

A list of visible aliases

VisibleCmdlets VisibleCmdlets VisibleCmdlets VisibleCmdlets

A list of visible cmdlets

VisibleExternalCommands VisibleExternalCommands VisibleExternalCommands VisibleExternalCommands

A list of visible external commands (scripts and applications)

VisibleFunctions VisibleFunctions VisibleFunctions VisibleFunctions

A list of visible functions

VisibleProviders VisibleProviders VisibleProviders VisibleProviders

A list of providers

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