Get-SPUser
返回符合给定搜索条件的用户帐户或帐户。
语法
Get-SPUser
[[-Identity] <SPUserPipeBind>]
-Web <SPWebPipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-Group <SPGroupPipeBind>]
[-Limit <String>]
[<CommonParameters>]
说明
Get-SPUser cmdlet 返回符合由 Identity、Web 或 Group 参数给定的范围的所有 SharePoint 用户帐户。
Identity 参数可以使用用户的别名返回完全匹配项。
有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息,请参阅 SharePoint Server cmdlet。
示例
------------------示例 1------------------
Get-SPUser -Web 'https://sharepoint.contoso.com' -Group 'Viewers'
此示例返回网站上的 https://sharepoint.contoso.comSharePoint 组“查看者”的所有成员。
------------------示例 2------------------
Get-SPUser -Identity 'i:0#.w|contoso\jdoe' -Web 'https://sharepoint.contoso.com'
此示例返回通过站点 https://sharepoint.contoso.com上的 Windows 声明标识的特定用户。
------------------示例 3------------------
Get-SPUser -Identity 'contoso\jdoe' -Web 'https://sharepoint.contoso.com'
此示例返回通过网站上的https://sharepoint.contoso.com经典Windows 身份验证标识的特定用户。
参数
-AssignmentCollection
管理对象以便正确进行处理。 使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。 通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。 在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。
在使用 Global 参数时,所有对象均包含在全局存储中。 如果未立即使用对象,或未通过使用 Stop-SPAssignment 命令来处理对象,则可能会发生内存不足的情况。
Type: | SPAssignmentCollection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Group
指定新用户所属的用户组。
Type: | SPGroupPipeBind |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Identity
指定要返回的用户的 ID 或登录名。
类型必须是有效的 ID 或登录名,例如经典 Windows 身份验证的“CONTOSO\jdoe”格式或“i:0#.w|适用于 Windows 声明的 CONTOSO\jdoe' 。
Type: | SPUserPipeBind |
Aliases: | UserAlias |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Limit
指定要返回的用户的最大数目。 默认值为 500。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Web
指定要用作范围的网站。
类型必须是有效的 GUID,格式为 12345678-90ab-cdef-1234-567890bcdefgh;SharePoint Foundation 网站的有效名称 (例如 MySPSite1) ;或有效 SPWeb 对象的实例。
Type: | SPWebPipeBind |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |