Get-SecurityPrincipal
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 有些參數和設定可能是某一個環境所專屬。
使用 Get-SecurityPrincipal Cmdlet 傳回安全性主體清單。 安全性主體是可指派許可權和使用者權限的實體,例如使用者或安全性群組。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
Syntax
Get-SecurityPrincipal
[[-Identity] <ExtendedSecurityPrincipalIdParameter>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IncludeDomainLocalFrom <SmtpDomain>]
[-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-RoleGroupAssignable]
[-Types <MultiValuedProperty>]
[<CommonParameters>]
Description
Exchange 系統管理中心會使用 Get-SecurityPrincipal Cmdlet 來填入顯示收件者資訊的欄位。
您必須已獲指派權限,才能執行此指令程式。 雖然本主題已列出這個指令程式的所有參數,不過,如果某些參數並未包含在指派給您的權限中,您可能就無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet。
範例
範例 1
Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com
此範例會從 人員 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
此範例會擷取已知的安全性主體,並在結果中只顯示 Name 和 SID 屬性。
參數
-DomainController
此參數僅適用於內部部署 Exchange。
DomainController 參數會指定此 Cmdlet 用來向 Active Directory 讀取或寫入資料的網域控制站。 您可以透過網域控制站的完整網域名稱 (FQDN) 來識別網域控制站。 例如,dc01.contoso.com。
Type: | Fqdn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
Filter 參數會使用 OPATH 語法,依指定的屬性和值來篩選結果。 搜尋準則使用語法 "Property -ComparisonOperator 'Value'"
。
- 以雙引號 「」 括住整個 OPATH 篩選準則。 如果篩選條件包含系統值 (例如
$true
、$false
或$null
),請改為使用單引號 ' '。 雖然此參數是字串 (不是系統區塊),您也可以使用大括弧 { },但只有在篩選條件不包含變數時。 - Property 是可篩選的屬性。 如需 Exchange Server 和 Exchange Online 中可篩選屬性的詳細資訊,請參閱Filter 參數的可篩選屬性。
- ComparisonOperator 是 OPATH 比較運算子 (例如
-eq
equals 和-like
字串比較) 。 如需比較運算子的詳細資訊,請參閱 about_Comparison_Operators。 - Value 是要搜尋的屬性值。 以單引號括住文字值和變數 (
'Value'
或'$Variable'
)。 如果變數值包含單引號,您必須識別 (逸出) 單引號,以正確展開變數。 例如,使用'$($User -Replace "'","''")'
,而不是'$User'
。 請勿以引號括住整數或系統值 (例如,請改用500
、$true
、$false
或$null
) 。
您可以使用邏輯運算子 -and
和 -or
將多個搜尋準則鏈結在一起。 例如,"Criteria1 -and Criteria2"
或 "(Criteria1 -and Criteria2) -or Criteria3"
。
如需 Exchange 中 OPATH 篩選的詳細資訊,請參閱 其他 OPATH 語法資訊。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Identity
Identity 參數會指定安全性主體。 使用此參數明確指定安全性主體時,不會傳回任何其他安全性主體。
Type: | ExtendedSecurityPrincipalIdParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IncludeDomainLocalFrom
此參數僅適用於內部部署 Exchange。
IncludeDomainLocalFrom 參數會指定是否要從指定 Active Directory 網域的 FQDN 傳回網域本機群組 (例如,在結果中 contoso.com) 。
請勿將此參數與 Filter 或 Identity 參數搭配使用。
Type: | SmtpDomain |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-OrganizationalUnit
OrganizationalUnit 參數會根據物件在 Active Directory 中的位置來篩選結果。 系統只會傳回存在於指定位置的物件。 此參數的有效輸入是組織單位 (OU) 或由 Get-OrganizationalUnit Cmdlet 傳回的網域。 您可以使用唯一識別 OU 或網域的任何值。 例如:
- 名稱
- 名稱
- 辨別名稱 (DN)
- GUID
Type: | ExtendedOrganizationalUnitIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ResultSize
ResultSize 參數會指定傳回的結果筆數上限。 若要傳回符合查詢的所有要求,請使用 unlimited 作為此參數的值。 預設值為 1000。
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RoleGroupAssignable
RoleGroupAssignable 參數只會傳回可指派給 RBAC 角色群組的物件,藉此篩選安全性主體。 您不需要使用此參數指定值。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Types
Types 參數會依物件類型篩選結果。 有效值為:
- 電腦
- GlobalSecurityGroup
- 群組
- UniversalSecurityGroup
- 使用者
- WellknownSecurityPrincipal
您可以指定多個以逗號分隔的值。
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
輸入
Input types
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。