New-PSSessionConfigurationFile

创建用于定义会话配置的文件。

语法

New-PSSessionConfigurationFile
   [-Path] <String>
   [-SchemaVersion <Version>]
   [-Guid <Guid>]
   [-Author <String>]
   [-Description <String>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-SessionType <SessionType>]
   [-TranscriptDirectory <String>]
   [-RunAsVirtualAccount]
   [-RunAsVirtualAccountGroups <String[]>]
   [-MountUserDrive]
   [-UserDriveMaximumSize <Int64>]
   [-GroupManagedServiceAccount <String>]
   [-ScriptsToProcess <String[]>]
   [-RoleDefinitions <IDictionary>]
   [-RequiredGroups <IDictionary>]
   [-LanguageMode <PSLanguageMode>]
   [-ExecutionPolicy <ExecutionPolicy>]
   [-PowerShellVersion <Version>]
   [-ModulesToImport <Object[]>]
   [-VisibleAliases <String[]>]
   [-VisibleCmdlets <Object[]>]
   [-VisibleFunctions <Object[]>]
   [-VisibleExternalCommands <String[]>]
   [-VisibleProviders <String[]>]
   [-AliasDefinitions <IDictionary[]>]
   [-FunctionDefinitions <IDictionary[]>]
   [-VariableDefinitions <Object>]
   [-EnvironmentVariables <IDictionary>]
   [-TypesToProcess <String[]>]
   [-FormatsToProcess <String[]>]
   [-AssembliesToLoad <String[]>]
   [-Full]
   [<CommonParameters>]

说明

New-PSSessionConfigurationFile cmdlet 可创建用于定义会话配置以及通过使用该会话配置创建的会话环境的设置文件。 若要在会话配置中使用文件,请使用 Register-PSSessionConfigurationSet-PSSessionConfiguration cmdlet 的 Path 参数。

New-PSSessionConfigurationFile 创建的会话配置文件是一个包含哈希表的用户可读的文本文件,哈希表中包含会话配置的属性和值。 该文件具有 .pssc 文件扩展名。

Path 参数外,New-PSSessionConfigurationFile 的所有参数均为可选项。 如果省略一个参数,则将注释掉会话配置文件中的相应键,已在参数说明中注明的除外。

会话配置(也称为终结点)是本地计算机上的设置集合,用于定义连接到计算机的 PowerShell 会话 (PSSessions) 的环境。 所有 Pssession 都使用会话配置。 要指定特定会话配置,请使用创建会话的 cmdlet(例如 New-PSSession cmdlet)的 ConfigurationName 参数。

session configuration file 可以轻松地定义会话配置,无需复杂的脚本或代码程序集。 文件中的设置与可选启动脚本和会话配置中的任何程序集一起使用。

有关会话配置和会话配置文件的详细信息,请参阅 about_Session_Configurationsabout_Session_Configuration_Files

此 cmdlet 是在 PowerShell 3.0 中引入的。 从 PowerShell 6.0 开始,此 cmdlet 仅在 Windows 平台上可用。 在 PowerShell 7.3 上,此 cmdlet 在所有受支持的平台上都可用。

示例

示例 1:创建和使用 NoLanguage 会话

此示例展示如何创建无语言会话以及使用无语言会话的效果。

步骤包括:

  1. 创建新配置文件。
  2. 注册配置。
  3. 创建一个使用该配置的新会话。
  4. 在该新会话中运行命令。

若要运行此示例中的命令,请使用“以管理员身份运行”选项启动 PowerShell。 需要此选项才能运行 Register-PSSessionConfiguration cmdlet。

New-PSSessionConfigurationFile -Path .\NoLanguage.pssc -LanguageMode NoLanguage
Register-PSSessionConfiguration -Path .\NoLanguage.pssc -Name NoLanguage -Force
$NoLanguageSession = New-PSSession -ComputerName Srv01 -ConfigurationName NoLanguage
Invoke-Command -Session $NoLanguageSession -ScriptBlock {
  if ((Get-Date) -lt '1January2099') {'Before'} else {'After'}
}

The syntax is not supported by this runspace. This might be because it is in no-language mode.
    + CategoryInfo          : ParserError: (if ((Get-Date) ...') {'Before'}  :String) [], ParseException
    + FullyQualifiedErrorId : ScriptsNotAllowed
    + PSComputerName        : localhost

在此示例中,Invoke-Command 失败,因为 LanguageMode 设置为 NoLanguage

示例 2:创建和使用 RestrictedLanguage 会话

此示例展示如何创建无语言会话以及使用无语言会话的效果。

步骤包括:

  1. 创建新配置文件。
  2. 注册配置。
  3. 创建一个使用该配置的新会话。
  4. 在该新会话中运行命令。

若要运行此示例中的命令,请使用“以管理员身份运行”选项启动 PowerShell。 需要此选项才能运行 Register-PSSessionConfiguration cmdlet。

New-PSSessionConfigurationFile -Path .\NoLanguage.pssc -LanguageMode RestrictedLanguage
Register-PSSessionConfiguration -Path .\NoLanguage.pssc -Name RestrictedLanguage -Force
$RestrictedSession = New-PSSession -ComputerName Srv01 -ConfigurationName RestrictedLanguage
Invoke-Command -Session $RestrictedSession -ScriptBlock {
  if ((Get-Date) -lt '1January2099') {'Before'} else {'After'}
}

Before

在此示例中,Invoke-Command 成功,因为 LanguageMode 设置为 RestrictedLanguage

示例 3:更改会话配置文件

此示例演示如何更改名为“ITTasks”的现有会话中使用的会话配置文件。 以前,这些会话仅具有核心模块和内部 ITTasks 模块。 管理员想要将 PSScheduledJob 模块添加到使用 ITTasks 会话配置创建的会话中。

New-PSSessionConfigurationFile -Path .\New-ITTasks.pssc -ModulesToImport Microsoft*, ITTasks, PSScheduledJob
Set-PSSessionConfiguration -Name ITTasks -Path .\New-ITTasks.pssc

New-PSSessionConfigurationFile cmdlet 用于创建导入所需模块的会话配置文件。 Set-PSSessionConfiguration cmdlet 将当前配置文件替换为新配置文件。 此新配置仅影响更改后创建的新会话。 现有的“ITTasks”会话不受影响。

示例 4:编辑会话配置文件

此示例显示了如何通过编辑配置文件的主动会话配置副本来更改会话配置。 若要修改配置文件的会话配置副本,必须对该文件具有完全控制访问权限。 这可能需要更改对文件的权限。

在此方案中,我们希望通过编辑活动配置文件为 Select-String cmdlet 添加新的别名。

下面的示例代码执行以下步骤来进行此更改:

  1. 获取 ITConfig 会话的配置文件路径。
  2. 用户使用 Notepad.exe 编辑配置文件以更改 AliasDefinitions 值,如下所示:AliasDefinitions = @(@{Name='slst';Value='Select-String'})
  3. 测试更新后的配置文件。
$ITConfig = Get-PSSessionConfiguration -Name ITConfig
notepad.exe $ITConfig.ConfigFilePath
Test-PSSessionConfigurationFile -Path $ITConfig.ConfigFilePath

True

Verbose 参数与 Test-PSSessionConfigurationFile 结合使用可显示检测到的任何错误。 如果文件中未检测到错误,cmdlet 将返回 $True

示例 5:创建示例配置文件

此示例显示使用所有 cmdlet 参数的 New-PSSessionConfigurationFile 命令。 包含此示例以显示每个参数对应的正确输入格式。

生成的 SampleFile.pssc 将显示在输出中。

$configSettings = @{
    Path = '.\SampleFile.pssc'
    SchemaVersion = '1.0.0.0'
    Author = 'User01'
    Copyright = '(c) Fabrikam Corporation. All rights reserved.'
    CompanyName = 'Fabrikam Corporation'
    Description = 'This is a sample file.'
    ExecutionPolicy = 'AllSigned'
    PowerShellVersion = '3.0'
    LanguageMode = 'FullLanguage'
    SessionType = 'Default'
    EnvironmentVariables = @{TESTSHARE='\\Test2\Test'}
    ModulesToImport = @{ModuleName='PSScheduledJob'; ModuleVersion='1.0.0.0'; GUID='50cdb55f-5ab7-489f-9e94-4ec21ff51e59'},'PSDiagnostics'
    AssembliesToLoad = 'System.Web.Services','FSharp.Compiler.CodeDom.dll'
    TypesToProcess = 'Types1.ps1xml','Types2.ps1xml'
    FormatsToProcess = 'CustomFormats.ps1xml'
    ScriptsToProcess = 'Get-Inputs.ps1'
    AliasDefinitions = @{Name='hlp';Value='Get-Help';Description='Gets help.';Options='AllScope'},
        @{Name='Update';Value='Update-Help';Description='Updates help';Options='ReadOnly'}
    FunctionDefinitions = @{Name='Get-Function';ScriptBlock={Get-Command -CommandType Function};Options='ReadOnly'}
    VariableDefinitions = @{Name='WarningPreference';Value='SilentlyContinue'}
    VisibleAliases = 'c*','g*','i*','s*'
    VisibleCmdlets = 'Get*'
    VisibleFunctions = 'Get*'
    VisibleProviders = 'FileSystem','Function','Variable'
    RunAsVirtualAccount = $true
    RunAsVirtualAccountGroups = 'Backup Operators'
}
New-PSSessionConfigurationFile @configSettings
Get-Content SampleFile.pssc

@{

# Version number of the schema used for this document
SchemaVersion = '1.0.0.0'

# ID used to uniquely identify this document
GUID = '1caeff7f-27ca-4360-97cf-37846f594235'

# Author of this document
Author = 'User01'

# Description of the functionality provided by these settings
Description = 'This is a sample file.'

# Company associated with this document
CompanyName = 'Fabrikam Corporation'

# Copyright statement for this document
Copyright = '(c) Fabrikam Corporation. All rights reserved.'

# Session type defaults to apply for this session configuration. Can be 'RestrictedRemoteServer' (recommended), 'Empty', or 'Default'
SessionType = 'Default'

# Directory to place session transcripts for this session configuration
# TranscriptDirectory = 'C:\Transcripts\'

# Whether to run this session configuration as the machine's (virtual) administrator account
RunAsVirtualAccount = $true

# Groups associated with machine's (virtual) administrator account
RunAsVirtualAccountGroups = 'Backup Operators'

# Scripts to run when applied to a session
ScriptsToProcess = 'Get-Inputs.ps1'

# User roles (security groups), and the role capabilities that should be applied to them when applied to a session
# RoleDefinitions = @{ 'CONTOSO\SqlAdmins' = @{ RoleCapabilities = 'SqlAdministration' }; 'CONTOSO\SqlManaged' = @{ RoleCapabilityFiles = 'C:\RoleCapability\SqlManaged.psrc' }; 'CONTOSO\ServerMonitors' = @{ VisibleCmdlets = 'Get-Process' } }

# Language mode to apply when applied to a session. Can be 'NoLanguage' (recommended), 'RestrictedLanguage', 'ConstrainedLanguage', or 'FullLanguage'
LanguageMode = 'FullLanguage'

# Execution policy to apply when applied to a session
ExecutionPolicy = 'AllSigned'

# Version of the PowerShell engine to use when applied to a session
PowerShellVersion = '3.0'

# Modules to import when applied to a session
ModulesToImport = @{
    'GUID' = '50cdb55f-5ab7-489f-9e94-4ec21ff51e59'
    'ModuleName' = 'PSScheduledJob'
    'ModuleVersion' = '1.0.0.0' }, 'PSDiagnostics'

# Aliases to make visible when applied to a session
VisibleAliases = 'c*', 'g*', 'i*', 's*'

# Cmdlets to make visible when applied to a session
VisibleCmdlets = 'Get*'

# Functions to make visible when applied to a session
VisibleFunctions = 'Get*'

# Providers to make visible when applied to a session
VisibleProviders = 'FileSystem', 'Function', 'Variable'

# Aliases to be defined when applied to a session
AliasDefinitions = @{
    'Description' = 'Gets help.'
    'Name' = 'hlp'
    'Options' = 'AllScope'
    'Value' = 'Get-Help' }, @{
    'Description' = 'Updates help'
    'Name' = 'Update'
    'Options' = 'ReadOnly'
    'Value' = 'Update-Help' }

# Functions to define when applied to a session
FunctionDefinitions = @{
    'Name' = 'Get-Function'
    'Options' = 'ReadOnly'
    'ScriptBlock' = {Get-Command -CommandType Function} }

# Variables to define when applied to a session
VariableDefinitions = @{
    'Name' = 'WarningPreference'
    'Value' = 'SilentlyContinue' }

# Environment variables to define when applied to a session
EnvironmentVariables = @{
    'TESTSHARE' = '\\Test2\Test' }

# Type files (.ps1xml) to load when applied to a session
TypesToProcess = 'Types1.ps1xml', 'Types2.ps1xml'

# Format files (.ps1xml) to load when applied to a session
FormatsToProcess = 'CustomFormats.ps1xml'

# Assemblies to load when applied to a session
AssembliesToLoad = 'System.Web.Services', 'FSharp.Compiler.CodeDom.dll'

}

参数

-AliasDefinitions

将指定的别名添加到使用该会话配置的会话中。 输入一个包含以下键的哈希表:

  • Name - 别名的名称。 此键是必需的。
  • Value - 别名所表示的命令。 此键是必需的。
  • Description - 描述别名的文本字符串。 此键是可选的。
  • Options - 别名选项。 此键是可选的。 默认值为。 此参数的可接受值为:None、ReadOnly、Constant、Private 或 AllScope。

例如:@{Name='hlp';Value='Get-Help';Description='Gets help';Options='ReadOnly'}

类型:IDictionary[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-AssembliesToLoad

指定要加载到使用该会话配置的会话中的程序集。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Author

指定会话配置或配置文件的作者。 默认为当前用户。 此参数的值在会话配置文件中可见,但是它不是会话配置对象的属性。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CompanyName

指定创建了会话配置或配置文件的公司。 默认值为 Unknown。 此参数的值在会话配置文件中可见,但是它不是会话配置对象的属性。

类型:String
Position:Named
默认值:Unknown
必需:False
接受管道输入:False
接受通配符:False

指定会话配置文件的版权。 此参数的值在会话配置文件中可见,但是它不是会话配置对象的属性。

如果省略此参数,New-PSSessionConfigurationFile 将使用 Author 参数的值生成版权声明。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Description

指定会话配置或会话配置文件的说明。 此参数的值在会话配置文件中可见,但是它不是会话配置对象的属性。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnvironmentVariables

将环境变量添加到会话中。 输入一个哈希表,其中的键是环境变量名称,而值是环境变量值。

例如:EnvironmentVariables=@{TestShare='\\Server01\TestShare'}

类型:IDictionary
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ExecutionPolicy

指定使用该会话配置的会话的执行策略。 如果省略此参数,则会话配置文件中的 ExecutionPolicy 键的值为 Restricted。 有关 PowerShell 中的执行策略的信息,请参阅 about_Execution_Policies

类型:ExecutionPolicy
接受的值:Unrestricted, RemoteSigned, AllSigned, Restricted, Default, Bypass, Undefined
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FormatsToProcess

指定在使用该会话配置的会话中运行的格式设置文件 (.ps1xml)。 此参数的值必须为这些格式设置文件的完整或绝对路径。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Full

指示此操作包括会话配置文件中所有可能的配置属性。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-FunctionDefinitions

将指定函数添加到使用该会话配置的会话中。 输入一个包含以下键的哈希表:

  • Name - 函数的名称。 此键是必需的。
  • ScriptBlock - 函数正文。 输入一个脚本块。 此键是必需的。
  • Options - 选项函数。 此键是可选的。 默认值为。 此参数的可接受值为:None、ReadOnly、Constant、Private 或 AllScope。

例如:@{Name='Get-PowerShellProcess';ScriptBlock={Get-Process PowerShell};Options='AllScope'}

类型:IDictionary[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-GroupManagedServiceAccount

使用此会话配置将会话配置为在指定的组托管服务帐户的上下文中运行。 注册此会话配置的计算机必须有权请求 gMSA 密码才能成功创建会话。 此字段不能与 RunAsVirtualAccount 参数一起使用。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Guid

为会话配置文件指定唯一标识符。 如果省略此参数,New-PSSessionConfigurationFile 会生成该文件的 GUID。 若要在 PowerShell 中创建新的 GUID,请键入 New-Guid

类型:Guid
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-LanguageMode

确定使用此会话配置的会话中允许 PowerShell 语言的哪些元素。 可以使用此参数来限制特定用户可以在计算机上运行的命令。

此参数的可接受值为:

  • FullLanguage - 允许所有语言元素。
  • ConstrainedLanguage - 不允许包含要计算的脚本的命令。 ConstrainedLanguage 模式限制用户对 Microsoft .NET Framework 类型、对象或方法的访问权限。
  • NoLanguage - 用户可以运行 cmdlet 和函数,但是不允许使用任何语言元素,如脚本块、变量或运算符。
  • RestrictedLanguage - 用户可以运行 cmdlet 和函数,但是不允许使用脚本块或变量(以下允许的变量除外):$PSCulture$PSUICulture$True$False$Null。 用户仅可使用基本比较运算符(-eq-gt-lt)。 不允许使用赋值语句、属性引用和方法调用。

LanguageMode 参数的默认值取决于 SessionType 参数的值。

  • 空 - NoLanguage
  • RestrictedRemoteServer - NoLanguage
  • 默认值 - FullLanguage
类型:PSLanguageMode
接受的值:FullLanguage, RestrictedLanguage, NoLanguage, ConstrainedLanguage
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ModulesToImport

指定自动导入使用该会话配置的会话的模块和管理单元。

默认情况下,仅将 Microsoft.PowerShell.Core 管理单元导入到远程会话中,但除非排除该 cmdlet,否则用户可以使用 Import-ModuleAdd-PSSnapin cmdlet 将模块和管理单元添加到会话。

此参数的值中的每个模块或管理单元都可以由字符串表示或以哈希表的形式表示。 模块字符串仅包含模块或管理单元的名称。 模块哈希表可以包含 ModuleNameModuleVersionGUID 键。 只有 ModuleName 键是必需的。

例如,下面的值由字符串和哈希表组成。 字符串和哈希表的任何组合(采用任何顺序)都是有效的。

'TroubleshootingPack', @{ModuleName='PSDiagnostics'; ModuleVersion='1.0.0.0';GUID='c61d6278-02a3-4618-ae37-a524d40a7f44'}

Register-PSSessionConfiguration cmdlet 的 ModulesToImport 参数的值优先于会话配置文件中的 ModulesToImport 键的值。

类型:Object[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-MountUserDrive

配置使用此会话配置的会话以公开 User: PSDrive。 用户驱动器对于每个连接用户来说都是唯一的,并且允许用户将数据复制到 PowerShell 终结点或从 PowerShell 终结点复制数据,即使文件系统提供程序未公开也是如此。 用户驱动器根目录在 $env:LOCALAPPDATA\Microsoft\PowerShell\DriveRoots\下创建。 对于连接到终结点的每位用户,将创建一个具有 $env:USERDOMAIN\$env:USERNAME 名称的文件夹。 对于工作组中的计算机,$env:USERDOMAIN 的值是主机名。

用户驱动器中的内容在用户会话中持续存在,并且不会自动删除。 默认情况下,用户只能在用户驱动器中存储最多 50MB 的数据。 可以使用 UserDriveMaximumSize 参数对此进行自定义。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Path

指定会话配置文件的路径和文件名。 该文件必须具有 .pssc 文件扩展名。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-PowerShellVersion

指定使用该会话配置的会话中 PowerShell 引擎的版本。 此参数的可接受的值是 2.0 和 3.0。 如果省略此参数,则将注释禁止 PowerShellVersion 键,并在会话中运行最新版本的 PowerShell。

Register-PSSessionConfiguration cmdlet 的 PSVersion 参数的值优先于会话配置文件中的 PowerShellVersion 键的值。

类型:Version
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RequiredGroups

为连接到使用此会话配置的会话的用户指定条件访问规则。

输入哈希表以组成规则列表,每个哈希表仅使用 1 个键“And”或“Or”,并将值设置为安全组名称或其他哈希表的数组。

要求连接用户成为单个组成员的示例:@{ And = 'MyRequiredGroup' }

要求用户属于组 A 或同时属于组 B 和 C 才能访问终结点的示例:@{ Or = 'GroupA', @{ And = 'GroupB', 'GroupC' } }

类型:IDictionary
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RoleDefinitions

指定安全组(或用户)与角色功能之间的映射。 用户将被授予访问创建会话时适用于其组成员身份的所有角色功能的权限。

输入一个哈希表,其中键是安全组的名称,值是包含应可供安全组使用的角色功能列表的哈希表。

例如:@{'Contoso\Level 2 Helpdesk Users' = @{ RoleCapabilities = 'Maintenance', 'ADHelpDesk' }}

类型:IDictionary
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RunAsVirtualAccount

使用此会话配置将会话配置为以计算机(虚拟)管理员帐户运行。 该字段不能与 GroupManagedServiceAccount 参数一起使用。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RunAsVirtualAccountGroups

指定当使用会话配置的会话作为虚拟帐户运行时要与虚拟帐户关联的安全组。 如果省略,则虚拟帐户属于域控制器上的域管理员和所有其他计算机上的管理员。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SchemaVersion

指定会话配置文件架构的版本。 默认值为“1.0.0.0”。

类型:Version
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ScriptsToProcess

将指定脚本添加到使用该会话配置的会话中。 请输入脚本的路径和文件名。 此参数的值必须为脚本文件名的完整或绝对路径。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SessionType

指定通过使用该会话配置创建的会话的类型。 默认值为 Default。 此参数的可接受值为:

  • 空 - 默认情况下,不向会话添加任何模块。 使用此 cmdlet 的参数将模块、函数、脚本和其他功能添加到会话。 此选项旨在通过添加选定的命令创建自定义会话。 如果没有将命令添加到空会话中,则该会话将限于表达式,并且可能不可用。
  • 默认 - 将 Microsoft.PowerShell.Core 模块添加到会话中。 此模块包含 Import-Module cmdlet,除非你明确禁止此 cmdlet,否则用户可以使用它来导入其他模块。
  • RestrictedRemoteServer。 仅包括以下代理函数:Exit-PSSessionGet-CommandGet-FormatDataGet-HelpMeasure-ObjectOut-DefaultSelect-Object。 使用此 cmdlet 的参数将模块、函数、脚本和其他功能添加到会话。
类型:SessionType
接受的值:Empty, RestrictedRemoteServer, Default
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TranscriptDirectory

指定放置使用此会话配置的会话的会话脚本的目录。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TypesToProcess

将指定 .ps1xml 类型文件添加到使用该会话配置的会话中。 输入类型文件名。 此参数的值必须为类型文件名的完整或绝对路径。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-UserDriveMaximumSize

指定在使用此会话配置的会话中公开的用户驱动器的最大大小。 如果省略,每个 User: 驱动器根的默认大小为 50MB。

此参数应与 MountUserDrive 一起使用。

类型:Int64
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-VariableDefinitions

将指定变量添加到使用该会话配置的会话中。 输入一个包含以下键的哈希表:

  • Name - 变量的名称。 此键是必需的。
  • Value - 变量值。 此键是必需的。

例如:@{Name='WarningPreference';Value='SilentlyContinue'}

类型:Object
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-VisibleAliases

将会话中的别名限制为在此参数的值中指定的别名以及在 AliasDefinition 参数中定义的任何别名。 支持使用通配符。 默认情况下,由 PowerShell 引擎定义的所有别名和模块导出的所有别名都在会话中可见。

例如:VisibleAliases='gcm', 'gp'

当会话配置文件中包含任何 Visible 参数时,PowerShell 将从会话中删除 Import-Module cmdlet 及其 ipmo 别名。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-VisibleCmdlets

将会话中的 cmdlet 限制为在此参数的值中指定的 cmdlet。 支持通配符和模块限定名称。

默认情况下,会话中的模块导出的所有 cmdlet 都在该会话中可见。 使用 SessionTypeModulesToImport 参数来确定哪些模块和管理单元已导入到会话中。 如果 ModulesToImport 中没有公开该 cmdlet,则会尝试自动加载相应的模块。

当会话配置文件中包含任何 Visible 参数时,PowerShell 将从会话中删除 Import-Module cmdlet 及其 ipmo 别名。

类型:Object[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-VisibleExternalCommands

将会话中可以执行的外部二进制文件、脚本和命令限制为此参数值中指定的内容。 支持使用通配符。

默认情况下,会话中不显示任何外部命令。

当会话配置文件中包含任何 Visible 参数时,PowerShell 将从会话中删除 Import-Module cmdlet 及其 ipmo 别名。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-VisibleFunctions

将会话中的函数限制为在此参数的值中指定的函数以及在 FunctionDefinition 参数中定义的任何函数。 支持使用通配符。

默认情况下,会话中的模块导出的所有函数都在该会话中可见。 使用 SessionTypeModulesToImport 参数来确定哪些模块和管理单元已导入到会话中。

当会话配置文件中包含任何 Visible 参数时,PowerShell 将从会话中删除 Import-Module cmdlet 及其 ipmo 别名。

类型:Object[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-VisibleProviders

将会话中的 PowerShell 提供程序限制为在此参数的值中指定的提供程序。 支持使用通配符。

默认情况下,会话中的模块导出的所有提供程序都在该会话中可见。 使用 SessionTypeModulesToImport 参数来确定哪些模块已导入到会话中。

当会话配置文件中包含任何 Visible 参数时,PowerShell 将从会话中删除 Import-Module cmdlet 及其 ipmo 别名。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

输入

None

无法通过管道将对象传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

备注

  • 参数(如 VisibleCmdletVisibleProviders)不会将项导入会话。 而会从导入到会话中的项中进行选择。 例如,如果 VisibleProviders 参数的值为 Certificate 提供程序,但 ModulesToImport 参数没有指定包含 Certificate 提供程序的 Microsoft.PowerShell.Security 模块,则 Certificate 提供程序在该会话中将不可见。

  • New-PSSessionConfigurationFile 将在 Path 参数中指定的路径中创建文件扩展名为 .pssc 的会话配置文件。 使用会话配置文件创建会话配置时,Register-PSSessionConfiguration cmdlet 会复制配置文件并将该文件的活动副本保存在 $PSHOME 目录的 SessionConfig 子目录中。

    会话配置的 ConfigFilePath 属性包含活动会话配置文件的完全限定的路径。 可以随时使用任何文本编辑器修改 $PSHOME 目录中的活动配置文件。 所做的更改会影响使用该会话配置的所有新会话,但不会影响现有会话。

    在使用编辑的会话配置文件之前,请使用 Test-PSSessionConfigurationFile cmdlet 验证配置文件条目是否有效。