Add-ManagementRoleEntry
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.
Use o cmdlet Add-ManagementRoleEntry cmdlet para adicionar entradas de função de gerenciamento a uma função de gerenciamento existente.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
Add-ManagementRoleEntry
[-Identity] <RoleEntryIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-Parameters <String[]>]
[-PSSnapinName <String>]
[-Type <ManagementRoleEntryType>]
[-UnScopedTopLevel]
[-WhatIf]
[<CommonParameters>] Add-ManagementRoleEntry
[-ParentRoleEntry] <RoleEntryIdParameter>
-Role <RoleIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-WhatIf]
[<CommonParameters>] Description
O cmdlet e os parâmetros adicionados a uma entrada de função devem existir na função pai. Não é possível adicionar entradas de função para funções internas.
Só é possível adicionar uma entrada de função a uma função de gerenciamento se a entrada de função existir na função pai. Por exemplo, tentar adicionar a entrada de função Search-Mailbox a uma função filho da função Mail Recipients, retornará um erro. Este erro ocorre porque a entrada de função Search-Mailbox não existe na função Mail Recipients. Para adicionar a entrada de função Search-Mailbox a uma função, é necessário criar uma nova função que seja filha da função Mailbox Import Export, que contém a entrada de função Search-Mailbox. Então, é possível usar o cmdlet Add-ManagementRoleEntry para adicionar a entrada de função Search-Mailbox à nova função filho.
Para obter mais informações sobre entradas de função de gerenciamento, confira Entender funções de gerenciamento.
Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.
Exemplos
Exemplo 1
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox"Este exemplo adiciona uma nova entrada de função para o cmdlet Get-Mailbox para a função de gerenciamento de Administradores de Destinatários. A entrada de função para o cmdlet Get-Mailbox é adicionada exatamente como configurado na função pai dos Administradores de Destinatários.
Exemplo 2
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter"Este exemplo adiciona uma nova entrada de função para o cmdlet Get-Mailbox para a função de Administradores de Destinatários. Somente os parâmetros Identidade, Anr, Servidor e Filtro são adicionados à nova entrada de função.
Exemplo 3
Get-ManagementRoleEntry "Mail Recipients\*Mailbox*" | Add-ManagementRoleEntry -Role "Mailbox Administrators"Este exemplo usa o cmdlet Get-ManagementRoleEntry para recuperar uma lista de todas as entradas de função existentes na função de gerenciamento de Destinatários de Email que contêm a cadeia de caracteres "Caixa de Correio" no nome do cmdlet e, em seguida, adiciona-as à função Administradores de Caixa de Correio usando o cmdlet Add-ManagementRoleEntry. As entradas de função são adicionadas à função filha exatamente conforme configuradas na função pai.
Exemplo 4
Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevelNo Exchange local, este exemplo adiciona o script MailboxAudit com os parâmetros Departamento e Localização à função de nível superior nãocopada dos Scripts de TI. Observe que a opção UnScopedTopLevel requer a função De Gerenciamento de Funções UnScoped, que não é atribuída a nenhum grupo de funções por padrão.
Parâmetros
-Confirm
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.
- Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata:
-Confirm:$false. - A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o comando antes de continuar.
| Type: | SwitchParameter |
| Aliases: | cf |
| 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, Exchange Online Protection |
-DomainController
Este parâmetro está disponível somente no Exchange local.
O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, 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 |
-Force
Esse parâmetro só está disponível no serviço baseado em nuvem.
A opção Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.
Você pode usar essa opção para executar tarefas de modo programático onde a solicitação por entrada administrativa é inadequada.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Exchange Online Protection |
-Identity
O parâmetro Identity especifica a entrada de função que você deseja adicionar. Esse parâmetro usa a sintaxe: Management role\role entry name (por exemplo, CustomRole\Set-Mailbox).
Para obter mais informações sobre como as entradas de função de gerenciamento funcionam, consulte Noções básicas sobre funções de gerenciamento.
A entrada de função que você deseja adicionar deve existir na função pai. Se o nome da entrada da função contiver espaços, coloque-o entre aspas (").
| Type: | RoleEntryIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Overwrite
A opção Substituição faz com que as entradas de função existentes sejam substituídas pelas entradas de função que estão sendo adicionadas. Não é preciso especificar um valor com essa opção.
| 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, Exchange Online Protection |
-Parameters
O parâmetro Parameters especifica os parâmetros a serem incluídos na função adicionada. Os parâmetros especificados devem existir no cmdlet associado com a entrada de função. Vários parâmetros podem ser especificados, separados por vírgulas.
| 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, Exchange Online Protection |
-ParentRoleEntry
O parâmetro ParentRoleEntry especifica a entrada de função na função pai a ser adicionada à função especificada com o parâmetro Role. Este parâmetro geralmente não é usado diretamente, mas existe para habilitar a canalização das entradas de função do cmdlet Get-ManagementRoleEntry. Se o parâmetro ParentRoleEntry for utilizado, não será possível usar a opção UnScopedTopLevel.
| Type: | RoleEntryIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-PSSnapinName
Este parâmetro está disponível somente no Exchange local.
O parâmetro PSSnapinName especifica o snap-in Windows PowerShell que contém o cmdlet associado à função que está sendo adicionada. Use o cmdlet Get-PSSnapin para recuperar uma lista de snap-ins Windows PowerShell disponíveis.
| 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 |
-Role
O parâmetro Role especifica a entrada à qual a nova entrada de função especificada pelo parâmetro ParentRoleEntry é adicionada.
| Type: | RoleIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Type
O parâmetro Type especifica o tipo de entrada de função adicionada. Os valores válidos são Cmdlet, Script e ApplicationPermission.
| Type: | ManagementRoleEntryType |
| 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, Exchange Online Protection |
-UnScopedTopLevel
Este parâmetro está disponível somente no Exchange local.
Por padrão, esse parâmetro só está disponível na função De Gerenciamento de Funções Do UnScoped e essa função não é atribuída a nenhum grupo de funções. Para usar esse parâmetro, você precisa adicionar a função De Gerenciamento de Função UnScoped a um grupo de funções (por exemplo, ao grupo de funções gerenciamento de organização). Para obter mais informações, consulte Adicionar uma função a um grupo de funções.
A opção UnScopedTopLevel especifica que você está adicionando a entrada de função a uma função de gerenciamento de nível superior não copiada. Não é preciso especificar um valor com essa opção.
Funções de gerenciamento de nível superior não copiadas só podem conter scripts personalizados ou cmdlets não exchange. Para obter mais informações, consulte Criar uma função nãocopada.
Você não pode usar essa opção com o parâmetro ParentRoleEntry.
| 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 |
-WhatIf
A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.
| Type: | SwitchParameter |
| Aliases: | wi |
| 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, Exchange Online Protection |
Entradas
Input types
Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.
Saídas
Output types
Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.