Add-ManagementRoleEntry
內部部署 Exchange 和雲端式服務有提供此 Cmdlet。 某些參數和設定可能僅限於一個環境或另一個環境。
使用 Add-ManagementRoleEntry Cmdlet 將管理角色項目新增至現有的管理角色。
如需下方<語法>一節中參數集的詳細資訊,請參閱 Exchange Cmdlet 語法。
語法
Identity
Add-ManagementRoleEntry
[-Identity] <RoleEntryIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-Parameters <String[]>]
[-PSSnapinName <String>]
[-Type <ManagementRoleEntryType>]
[-UnScopedTopLevel]
[-WhatIf]
[<CommonParameters>]
ParentRoleEntry
Add-ManagementRoleEntry
[-ParentRoleEntry] <RoleEntryIdParameter>
-Role <RoleIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-WhatIf]
[<CommonParameters>]
Description
您新增至角色項目的 Cmdlet 及其參數必須存在於父角色中。 您無法將角色項目新增至內建角色。
只有當角色的父角色中存在角色項目時,您才能將角色項目新增至管理角色。 例如,如果您嘗試將 Search-Mailbox 角色項目新增至「郵件收件者」角色的子系角色,就會收到錯誤。 發生此錯誤的原因是郵件收件者角色中不存在 Search-Mailbox 角色項目。 若要將 Search-Mailbox 角色項目新增至角色,您必須建立一個角色,該角色是信箱匯入匯出角色的子系,其中包含 Search-Mailbox 角色項目。 然後,您可以使用 Add-ManagementRoleEntry Cmdlet 將 Search-Mailbox 角色項目新增至新的子角色。
如需管理角色項目的詳細資訊,請參閱 瞭解管理角色。
您必須已獲指派權限,才能執行此指令程式。 雖然本文列出 Cmdlet 的所有參數,但如果指派給您的權限中未包含某些參數,您可能無法存取這些參數。 若要尋找在組織中執行任何 Cmdlet 或參數所需的權限,請參閱 Find the permissions required to run any Exchange cmdlet。
範例
範例 1
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox"
本範例會將 Get-Mailbox Cmdlet 的新角色項目新增至收件者系統管理員管理角色。 Get-Mailbox Cmdlet 的角色項目會完全按照收件者系統管理員父角色中的設定新增。
範例 2
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter"
本範例會將 Get-Mailbox Cmdlet 的新角色項目新增至收件者系統管理員角色。 只有 Identity、Anr、Server 和 Filter 參數會新增至新的角色項目。
範例 3
Get-ManagementRoleEntry "Mail Recipients\*Mailbox*" | Add-ManagementRoleEntry -Role "Mailbox Administrators"
此範例使用 Get-ManagementRoleEntry Cmdlet 擷取郵件收件者管理角色上存在之 Cmdlet 名稱中包含 “Mailbox” 字串的所有角色項目清單,然後使用 Add-ManagementRoleEntry Cmdlet 將它們新增至信箱系統管理員角色。 角色項目會完全按照在父角色上設定的方式新增至子角色。
範例 4
Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevel
在內部部署 Exchange 中,此範例會將具有部門和位置參數的 MailboxAudit 指令碼新增至 IT 指令碼未限定範圍的頂層角色。 UnScopedTopLevel 參數需要 UnScoped 角色管理角色,預設不會指派給任何角色群組。
參數
-Confirm
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
Confirm 參數會指定要顯示或隱藏確認提示。 此參數對 Cmdlet 的影響取決於 Cmdlet 是否需要確認才能繼續。
- 破壞性的 Cmdlet (如 Remove-* cmdlets) 有內建暫停,它會先強迫您確認命令才會繼續作業。 對於這些 Cmdlet,您可以使用以下確切語法來略過確認提示:
-Confirm:$false。 - 其他大部分的 Cmdlet (如 New-* 和 Set-* cmdlets) 則沒有內建暫停。 針對這些 Cmdlet,指定不帶值的 Confirm 參數會造成暫停,強制您在繼續之前先確認命令。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | CF |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-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 |
-Force
適用:Exchange Online、內部部署信箱的內建安全性附加元件
此參數只能在雲端式服務中使用。
強制開關會隱藏警告或確認訊息。 您不需要使用此參數指定值。
在不適合提示系統管理員輸入的場合中,您可以使用此參數來利用程式設計方式執行工作。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | 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 參數會指定您要新增的角色項目。 此參數使用語法: Management role\role entry name (例如, CustomRole\Set-Mailbox) 。
如需管理角色項目運作方式的詳細資訊,請參閱 瞭解管理角色。
您要新增的角色項目必須存在於父角色中。 如果角色項目名稱包含空格,您必須用引號 (“) 將名稱括住。
參數屬性
| 類型: | RoleEntryIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Overwrite
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
[覆寫] 參數會讓現有的角色項目被要新增的角色項目覆寫。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Parameters
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
Parameters 參數會指定要包含在要新增的角色中的參數。 指定的參數必須存在於與角色項目相關聯的 Cmdlet 上。 您可以指定多個參數,並以逗號分隔。
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ParentRoleEntry
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
ParentRoleEntry 參數會指定父角色中要新增至以 Role 參數指定的角色的角色項目。 此參數通常不會直接使用,但存在以啟用來自 Get-ManagementRoleEntry cmdlet 的角色項目管道。 如果您使用 ParentRoleEntry 參數,則無法使用 UnScopedTopLevel 切換。
參數屬性
| 類型: | RoleEntryIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ParentRoleEntry
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-PSSnapinName
適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此參數僅適用於內部部署 Exchange。
PSSnapinName 參數會指定包含與要新增的角色相關聯之 Cmdlet 的 Windows PowerShell 嵌入式管理單元。 使用 Get-PSSnapin Cmdlet 擷取可用Windows PowerShell嵌入式管理單元的清單。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Role
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
Role 參數會指定新增由 ParentRoleEntry 參數指定的新角色項目的角色。
參數屬性
| 類型: | RoleIdParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
ParentRoleEntry
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Type
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
Type 參數會指定要新增的角色項目類型。 有效值為 Cmdlet、Script 和 ApplicationPermission。
參數屬性
| 類型: | ManagementRoleEntryType |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UnScopedTopLevel
適用項目:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
此參數僅適用於內部部署 Exchange。
根據預設,此參數僅適用於 UnScoped 角色管理角色,且該角色不會指派給任何角色群組。 若要使用此參數,您必須將未限定範圍的角色管理角色新增至角色群組 (例如,新增至組織管理角色群組) 。 如需詳細資訊,請參閱 將角色新增至角色群組。
UnScopedTopLevel 參數會指定您要將角色項目新增至未設定範圍的最上層管理角色。 您不需要使用此參數指定值。
未設定範圍的頂層管理角色只能包含自訂指令碼或非 Exchange Cmdlet。 如需詳細資訊,請參閱 建立未限定範圍的角色。
您無法將此參數與 ParentRoleEntry 參數搭配使用。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
Identity
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
適用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、內部部署的內建安全性附加元件信箱
WhatIf 參數會顯示命令在不進行任何變更的情況下執行的動作。 您不需要使用此參數指定值。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | WI |
參數集
(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
若要查看此指令程式可接受的輸入類型,請參閱指令程式輸入和輸出類型。 如果指令程式的 [輸入類型] 欄位是空的,表示指令程式不接受輸入資料。
輸出
Output types
若要查看此指令程式可接受的傳回類型 (也就是所謂的輸出類型),請參閱指令程式輸入和輸出類型。 如果 [輸出類型] 欄位是空的,表示指令程式不會傳回資料。