New-SPClaimsPrincipal

创建声明主体。

语法

STSIdentity

New-SPClaimsPrincipal
    [-ClaimValue] <String>
    [[-ClaimType] <String>]
    [-TrustedIdentityTokenIssuer] <SPTrustedIdentityTokenIssuerPipeBind>
    [-IdentifierClaim]
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

ClaimProvider

New-SPClaimsPrincipal
    [-ClaimValue] <String>
    [-ClaimType] <String>
    -ClaimProvider <SPClaimProvider>
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

BasicClaim

New-SPClaimsPrincipal
    [-EncodedClaim] <String>
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

IdentityType

New-SPClaimsPrincipal
    [-Identity] <String>
    [-IdentityType] <SPIdentifierTypes>
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

TrustIdentity

New-SPClaimsPrincipal
    [-Identity] <String>
    [-TrustedIdentityTokenIssuer] <SPTrustedIdentityTokenIssuerPipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

说明

此 cmdlet 包含多个参数集。 您可以只使用来自一个参数集的参数,也可以不合并来自不同参数集的参数。 若要详细了解如何使用参数集,请参阅 Cmdlet 参数集

New-SPClaimsPrincipal cmdlet 可创建声明主体。

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

示例

示例 1

New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal contoso\johndoe -TrustedIdentityTokenIssuer "NTLM")

此示例为 Windows 用户创建声明主体。

示例 2

New-SPSite https://localhost/sites/newsite -owner (New-SPClaimsPrincipal contoso\allusers -TrustedIdentityTokenIssuer "NTLM")

此示例为 Windows 组创建声明主体。

示例 3

New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal -ClaimValue "john@contoso.com" -ClaimType Email -TrustedIdentityTokenIssuer "LiveID STS" -IdentifierClaim Yes)

此示例为受信任的身份令牌颁发者声明创建声明主体。

示例 4

$ip = New-SPIdentityProvider -ASPNetMembershipProvider "myMembershipProvider" -ASPNetRoleProvider "myRoleProvider"
New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "john@contoso.com" -TrustedIdentityTokenIssuer $ip)

此示例为 ASPNet 成员关系用户创建声明主体。

示例 5

New-SPSite https://sitename/sites/newsite -owner (New-SPClaimsPrincipal "Sales Manager Role" -IdentityProvider "myRoleProvider")

此示例为 ASPNet 角色创建声明主体。

示例 6

$cp = New-SPClaimsPrincipal -Identity "redmond\SiteOwner" -IdentityType 1
New-SPSite https://servername:port -OwnerAlias $cp.ToEncodedString() -Template "STS#0"

此示例为基本声明角色创建声明主体(也称为编码声明)。

参数

-AssignmentCollection

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

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

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

参数属性

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

参数集

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

-ClaimProvider

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

指定将包含声明主体的安全令牌服务标识提供程序。

键入的值必须为 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;或标识提供程序的有效名称(例如,MyIDprovider1);或有效 SPIdentityProvider 对象的实例。

参数属性

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

参数集

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

-ClaimType

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

指定要创建的声明类型。 值 I 表示唯一用户标识声明,值 C 表示所有其他声明。

键入的值必须是下列值之一:I 或 C。

参数属性

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

参数集

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

-ClaimValue

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

指定声明对象的声明值。 声明值指定声明要验证的用户、组或计算机。

类型必须是有效的声明值;例如 。 john@contoso.com

参数属性

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

参数集

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

-EncodedClaim

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

将简单声明转换为完整编码的声明。

键入的值必须是有效的声明值;例如,i:001w|redmond\user。

参数属性

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

参数集

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

-IdentifierClaim

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

指定新声明是否为标识声明。

参数属性

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

参数集

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

-Identity

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

指定新声明主体的名称。

键入的值必须是声明主体的有效名称。

参数属性

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

参数集

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

-IdentityType

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

指定新声明主体的类型。

键入的值必须为下列值之一: WindowsSamAccountName 、 WindowsSecurityGroupSid 、 FormsUser 、 FormsRole 或 EncodedClaim 。

参数属性

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

参数集

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

-TrustedIdentityTokenIssuer

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

指定验证提供程序的 ID。

键入的值必须为 12345678-90ab-cdef-1234-567890bcdefgh 形式的有效 GUID;验证提供程序的有效名称(如 MyAuthprovider1);或有效 SPTrustedIdentityTokenIssuer 对象的实例。

参数属性

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

参数集

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

CommonParameters

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