Register-PSSessionConfiguration

Register-PSSessionConfiguration
    [-Name] <String>
    [-ProcessorArchitecture <String>]
    [-ApplicationBase <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-PSVersion <Version>]
    [-SessionTypeOption <PSSessionTypeOption>]
    [-TransportOption <PSTransportOption>]
    [-ModulesToImport <Object[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Register-PSSessionConfiguration
    [-Name] <String>
    [-AssemblyName] <String>
    [-ConfigurationTypeName] <String>
    [-ProcessorArchitecture <String>]
    [-ApplicationBase <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-PSVersion <Version>]
    [-SessionTypeOption <PSSessionTypeOption>]
    [-TransportOption <PSTransportOption>]
    [-ModulesToImport <Object[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Register-PSSessionConfiguration
    [-Name] <String>
    -Path <String>
    [-ProcessorArchitecture <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-TransportOption <PSTransportOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

此 cmdlet 仅在 Windows 平台上可用。

Register-PSSessionConfiguration cmdlet 在本地计算机上创建并注册新的会话配置。 这是一个高级 cmdlet，可用于为远程用户创建自定义会话。

每个 PowerShell 会话（PSSession）都使用会话配置，也称为终结点。 当用户创建连接到计算机的会话时，可以选择会话配置或使用启用 PowerShell 远程处理时注册的默认会话配置。 用户还可以设置$PSSessionConfigurationName首选项变量，该变量指定在当前会话中创建的远程会话的默认配置。

会话配置定义远程会话的环境。 配置可以确定会话中可用的命令和语言元素，并且可以包括保护计算机的设置，例如限制会话可以在单个对象或命令中远程接收的数据量的设置。 会话配置的安全描述符确定哪些用户有权使用会话配置。

可以使用实现新配置类的程序集以及使用在会话中运行的脚本来定义配置的元素。 从 PowerShell 3.0 开始，还可以使用会话配置文件来定义会话配置。

有关会话配置的信息，请参阅 about_Session_Configurations。 有关会话配置文件的信息，请参阅 about_Session_Configuration_Files。

在此示例中，我们将注册 NewShell 会话配置。 AssemblyName 和 ApplicationBase 参数指定 MyShell.dll 文件的位置，该文件指定会话配置中的 cmdlet 和提供程序。 ConfigurationTypeName 参数指定要从程序集中使用的配置类。

$sessionConfiguration = @{
    Name='NewShell'
    ApplicationBase='C:\MyShells\'
    AssemblyName='MyShell.dll'
    ConfigurationTypeName='MyClass'
}
Register-PSSessionConfiguration @sessionConfiguration

若要使用此配置，请键入 New-PSSession -ConfigurationName NewShell。

此示例在本地计算机上注册 MaintenanceShell 会话配置。 StartupScript 参数指定 Maintenance.ps1 脚本。

Register-PSSessionConfiguration -Name MaintenanceShell -StartupScript C:\ps-test\Maintenance.ps1

当用户使用 New-PSSession 命令并选择 MaintenanceShell 配置时，Maintenance.ps1 脚本在新会话中运行。 该脚本可以配置会话。 这包括导入模块和设置会话的执行策略。 如果脚本生成任何错误（包括非终止错误），New-PSSession 命令将失败。

此示例注册 AdminShell 会话配置。

$sessionParams 变量是包含所有参数值的哈希表。 此哈希表使用 PowerShell splatting 传递到 cmdlet。 Register-PSSessionConfiguration 命令使用 SecurityDescriptorSDDL 参数在 $sddl 变量的值中指定 SDDL，并使用 MaximumReceivedObjectSizeMB 参数来增加对象大小限制。 它还使用 StartupScript 参数来指定配置会话的脚本。

$sddl = "O:NSG:BAD:P(A;;GA;;;BA)S:P(AU;FA;GA;;;WD)(AU;FASA;GWGX;;;WD)"
$sessionParams = @{
    Name="AdminShell"
    SecurityDescriptorSDDL=$sddl
    MaximumReceivedObjectSizeMB=20
    StartupScript="C:\scripts\AdminShell.ps1"
}
Register-PSSessionConfiguration @sessionParams

此示例演示如何注册 MaintenanceShell 配置。 Register-PSSessionConfiguration 返回存储在 变量中的 $s 对象。 Format-List 显示返回的对象的所有属性。 PSPath 属性显示对象存储在 WSMan： 驱动器的目录中。 Get-ChildItem（别名 dir）显示 WSMan:\LocalHost\PlugIn 路径中的项。 其中包括新的 MaintenanceShell 配置和 PowerShell 附带的两个默认配置。

$s = Register-PSSessionConfiguration -Name MaintenanceShell -StartupScript C:\ps-test\Maintenance.ps1
$s | Format-List -Property *
dir WSMan:\LocalHost\Plugin

PSPath            : Microsoft.WSMan.Management\WSMan::localhost\Plugin\MaintenanceShell
PSParentPath      : Microsoft.WSMan.Management\WSMan::localhost\Plugin
PSChildName       : MaintenanceShell
PSDrive           : WSMan
PSProvider        : Microsoft.WSMan.Management\WSMan
PSIsContainer     : True
Keys              : {Name=MaintenanceShell}
Name              : MaintenanceShell
TypeNameOfElement : Container

Name                      Type                 Keys
----                      ----                 ----
MaintenanceShell          Container            {Name=MaintenanceShell}
microsoft.powershell      Container            {Name=microsoft.powershell}
microsoft.powershell32    Container            {Name=microsoft.powershell32}

在此示例中，我们将创建并注册 WithProfile 会话配置。 StartupScript 参数指示 PowerShell 为使用会话配置的任何会话运行指定的脚本。

Register-PSSessionConfiguration -Name WithProfile -StartupScript Add-Profile.ps1

该脚本包含一个命令，该命令使用点溯在会话的当前范围内运行用户的 CurrentUserAllHosts 配置文件。

有关配置文件的详细信息，请参阅 about_Profiles。 有关点溯的详细信息，请参阅 about_Scopes。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

不能用管道将对象传送到此 cmdlet。

此 cmdlet 仅在 Windows 平台上可用。

若要运行此 cmdlet，必须使用 以管理员身份运行 选项启动 PowerShell。

此 cmdlet 生成表示 Web Services for Management （WS-Management） 插件配置的 XML，并将 XML 发送到 WS-Management，后者在本地计算机上注册插件（New-Item WSMan:\localhost\plugin）。

会话配置对象的属性因为会话配置设置的选项以及这些选项的值而有所不同。 此外，使用会话配置文件的会话配置具有其他属性。