Get-SecurityPrincipal
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能是一个环境或另一个环境独占。
使用 Get-SecurityPrincipal cmdlet 返回安全主体列表。 安全主体是实体,例如用户或安全组,可以分配权限和用户权限。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Default (默认值)
Get-SecurityPrincipal
[[-Identity] <ExtendedSecurityPrincipalIdParameter>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IncludeDomainLocalFrom <SmtpDomain>]
[-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-RoleGroupAssignable]
[-Types <MultiValuedProperty>]
[<CommonParameters>]
说明
Exchange 管理中心使用 Get-SecurityPrincipal cmdlet 填充显示收件人信息的字段。
您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果分配给你的权限中未包含某些参数,则可能无权访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com
此示例从 People OU 检索安全主体。
示例 2
Get-SecurityPrincipal -Filter "Department -eq 'Legal'"
此示例使用 Filter 参数从法务部门检索安全主体。 仅检索与筛选条件匹配的安全主体。
示例 3
Get-SecurityPrincipal -Identity Administrator
此示例检索使用 Identity 参数显式指定的单个安全主体。
示例 4
Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize
此示例检索已知的安全主体,并在结果中仅显示名称和 SID 属性。
参数
-DomainController
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此参数只在本地 Exchange 中可用。
DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。
参数属性
| 类型: | Fqdn |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Filter
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全性 & 合规性、内置安全性本地邮箱的加载项
Filter 参数使用 OPATH 语法按指定的属性和值筛选结果。 搜索条件使用语法 "Property -ComparisonOperator 'Value'"。
- 请用双引号“ ”括住整个 OPATH 筛选器。 如果筛选器包含系统值 (例如
$true、 或$false$null) ,请改用单引号 ' '。 尽管此参数是字符串 (而不是系统块) ,但您也可以使用大括号 { },但前提是筛选器不包含变量。 - 属性是可筛选的属性。 有关 Exchange 服务器和 Exchange Online 中可筛选属性的详细信息,请参阅 Filter 参数的可筛选属性。
- ComparisonOperator 是一个 OPATH 比较运算符 (例如
-eq,对于等值和-like字符串比较) 。 有关比较运算符的详细信息,请参阅 about_Comparison_Operators。 - 值是要搜索的属性值。 请将文本值和变量括在单引号 (
'Value'或'$Variable') 中。 如果变量值包含单引号,则需要标识单引号 (转义) 正确展开变量。 例如,'$User'使用'$($User -Replace "'","''")'. 而不是 。 不要将整数或系统值括在引号中,例如,使用500、$true($false$null或改为) 。
可以使用逻辑运算符 -and 和 -or将多个搜索条件链接在一起。 例如,"Criteria1 -and Criteria2" 或 "(Criteria1 -and Criteria2) -or Criteria3"。
有关 Exchange 中 OPATH 筛选器的详细信息,请参阅 其他 OPATH 语法信息。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Identity
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全性 & 合规性、内置安全性本地邮箱的加载项
标识参数指定安全主体。 使用此参数显式指定安全主体时,不会返回其他安全主体。
注意: Identity 参数的值$null或不存在值将返回 所有 对象,就像您在没有 Identity 参数的情况下运行 Get- 命令一样。 验证 Identity 参数的任何值列表是否准确,且不包含不存在的$null值。
参数属性
| 类型: | ExtendedSecurityPrincipalIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 1 |
| 必需: | False |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-IncludeDomainLocalFrom
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此参数只在本地 Exchange 中可用。
IncludeDomainLocalFrom 参数指定是否从指定的 Active Directory 域的 FQDN 返回域本地组 (例如,在结果中 contoso.com) 。
请勿将此参数与 Filter 或 Identity 参数一起使用。
参数属性
| 类型: | SmtpDomain |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-OrganizationalUnit
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全性 & 合规性、内置安全性本地邮箱的加载项
OrganizationalUnit 参数根据对象在 Active Directory 中的位置筛选结果。 只返回存在于指定位置的对象。 此参数的有效输入是 Get-OrganizationalUnit cmdlet 返回 (OU) 或域的组织单位。 可以使用任何能够唯一标识此 OU 或域的值。 例如:
- 名称
- 名称
- 可分辨名称 (DN)
- GUID
参数属性
| 类型: | ExtendedOrganizationalUnitIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ResultSize
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全性 & 合规性、内置安全性本地邮箱的加载项
ResultSize 参数指定了要返回的结果的最大数量。 若要返回所有与查询相匹配的请求,则请将此参数的值设为无限制。 默认值为 1000。
参数属性
| 类型: | Unlimited |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RoleGroupAssignable
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全性 & 合规性、内置安全性本地邮箱的加载项
RoleGroupAssignable 开关通过仅返回可分配给 RBAC 角色组的对象来筛选安全主体。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Types
适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、安全性 & 合规性、内置安全性本地邮箱的加载项
类型参数按对象类型筛选结果。 有效值包含:
- 计算机
- GlobalSecurityGroup
- 组
- UniversalSecurityGroup
- 用户
- WellknownSecurityPrincipal
可以指定用逗号分隔的多个值。
参数属性
| 类型: | MultiValuedProperty |
| 默认值: | 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。
输入
Input types
若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。
输出
Output types
若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。