Set-SPProfileServiceApplication

设置 User Profile Service 应用程序的属性。

语法

Default

Set-SPProfileServiceApplication
    [-Identity] <SPServiceApplicationPipeBind>
    [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-GetNonImportedObjects <Boolean>]
    [-MySiteHostLocation <SPSitePipeBind>]
    [-ProfileDBCredentials <PSCredential>]
    [-ProfileSyncDBCredentials <PSCredential>]
    [-ProfileSyncDBFailoverServer <String>]
    [-PurgeNonImportedObjects <Boolean>]
    [-SocialDBCredentials <PSCredential>]
    [-SocialDBFailoverServer <String>]
    [-Name <String>]
    [-UseOnlyPreferredDomainControllers <Boolean>]
    [-WhatIf]
    [-ProfileDBFailoverServer <String>]
    [<CommonParameters>]

MySiteSettings

Set-SPProfileServiceApplication
    [-Identity] <SPServiceApplicationPipeBind>
    -MySiteHostLocation <SPSitePipeBind>
    [-ApplicationPool <SPIisWebServiceApplicationPoolPipeBind>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Confirm]
    [-GetNonImportedObjects <Boolean>]
    [-MySiteManagedPath <SPPrefixPipeBind>]
    [-ProfileDBCredentials <PSCredential>]
    [-ProfileSyncDBCredentials <PSCredential>]
    [-ProfileSyncDBFailoverServer <String>]
    [-PurgeNonImportedObjects <Boolean>]
    [-SiteNamingConflictResolution <String>]
    [-SocialDBCredentials <PSCredential>]
    [-SocialDBFailoverServer <String>]
    [-Name <String>]
    [-UseOnlyPreferredDomainControllers <Boolean>]
    [-WhatIf]
    [-ProfileDBFailoverServer <String>]
    [<CommonParameters>]

说明

此 cmdlet 包含多个参数集。 只能使用一个参数集中的参数,而不能结合使用不同参数集中的参数。 若要详细了解如何使用参数集,请参阅 Cmdlet 参数集

Set-SPProfileServiceApplication cmdlet 设置用户配置文件服务应用程序的属性。

有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息,请参阅 SharePoint Server cmdlet

示例

$sa = Get-SPServiceApplication | ?{$_.TypeName -eq 'User Profile Service Application'}
Set-SPProfileServiceApplication -Identity $sa -PurgeNonImportedObjects:$true

本示例从配置文件数据库中清除不在用户配置文件导入范围内的对象。

参数

-ApplicationPool

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要在其中运行服务应用程序的 Web 服务的现有 IIS 应用程序池。

键入的值必须为 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;应用程序池的有效名称(如 AppPoolName1);或有效 IISWebServiceApplicationPool 对象的实例。

参数属性

类型:SPIisWebServiceApplicationPoolPipeBind
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-AssignmentCollection

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

管理对象以便正确进行处理。 使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。 通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。 在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。

使用全局参数时,所有对象均包含在全局存储中。 如果未立即使用对象,或未通过使用 Stop-SPAssignment 命令来处理对象,则可能会发生内存不足的情况。

参数属性

类型:SPAssignmentCollection
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

执行命令前,看到确认提示。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-GetNonImportedObjects

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定是否通知未来自导入管道并将标记为删除的用户。 标记为删除的用户列表将显示在控制台窗口中。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Identity

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要更新的用户配置文件服务应用程序。

键入的值必须为 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;订阅设置服务应用程序的有效名称(例如,SubscriptionSettingsApp1);或者有效 SPServiceApplication 对象的实例。

参数属性

类型:SPServiceApplicationPipeBind
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-MySiteHostLocation

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定要在其中预配“我的网站”的网站集。

键入的值必须是格式为 https://server_name 的有效 URL;格式为 12345678-90ab-cdef-1234-567890bcdefgh 的有效 GUID;网站订阅的有效名称(例如,SiteSubscription1);或有效 SiteSubscription 对象的实例。

参数属性

类型:SPSitePipeBind
默认值:None
支持通配符:False
不显示:False

参数集

Default
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False
MySiteSettings
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-MySiteManagedPath

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定个人网站的托管路径位置。

类型必须是有效的 URL,格式为 https://server_name.

参数属性

类型:SPPrefixPipeBind
默认值:None
支持通配符:False
不显示:False

参数集

MySiteSettings
Position:Named
必需:False
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定新 User Profile Service 应用程序的显示名称。 使用的名称必须是该服务器场中唯一的 User Profile Service 应用程序名称。 名称最多可包含 128 个字符。

类型必须是用户配置文件服务应用程序的有效名称;例如 UserProfileSvcApp1。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProfileDBCredentials

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定用于连接到此 cmdlet 创建的用户配置文件数据库的一组安全凭据,例如用户名和密码。

键入的值必须是有效的 PSCredential 对象。

参数属性

类型:PSCredential
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProfileDBFailoverServer

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定配置文件数据库的故障转移 SQL 服务器的名称。 它用于生成配置文件数据库的连接字符串。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProfileSyncDBCredentials

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定用于连接到 ProfileSyncDBName 参数中指定的配置文件同步数据库的一组安全凭据,例如用户名和密码。

键入的值必须是有效的 PSCredential 对象。

参数属性

类型:PSCredential
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProfileSyncDBFailoverServer

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定配置文件数据库的故障转移 SQL 服务器的名称。 它用于生成配置文件数据库的连接字符串。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PurgeNonImportedObjects

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定是否在配置文件存储中标记要删除的非导入用户,然后通知未来自导入管道的用户,该管道将被标记为删除。 标记为删除的用户列表显示在控制台窗口中

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SiteNamingConflictResolution

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定命名个人网站所采用的格式。

使用下列整数值之一:

1 --个人网站集基于用户名,无需任何冲突解决。 例如,https://portal_site/location/username/

2 -- 个人网站集应基于用户名,并使用域名解决冲突。 例如,.../username/ 或 .../domain_username/

3 应始终使用域和用户名来命名个人网站集,以避免任何冲突。 例如,https://portal_site/location/domain_username/

默认值为 1(不解决冲突)。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

MySiteSettings
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SocialDBCredentials

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

用于连接到此 cmdlet 创建的社交数据库的一组安全凭据,包括用户名和密码。

键入的值必须是有效的 PSCredential 对象。

参数属性

类型:PSCredential
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SocialDBFailoverServer

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

指定社交数据库的故障转移 SQL Server 的名称。 它用于生成社交数据库的连接字符串。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-UseOnlyPreferredDomainControllers

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

将配置文件同步通信限制为特定的域控制器。

有效值为 $true 或 $false。

参数属性

类型:Boolean
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

适用:SharePoint Server 2010、SharePoint Server 2013、SharePoint Server 2016 SharePoint Server 2019

显示一条描述命令作用的消息,而不执行命令。 有关详细信息,请键入以下命令:get-help about_commonparameters

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

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