Add-ManagementRoleEntry
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e definições podem ser exclusivos de um ambiente ou outro.
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.
Sintaxe
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
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, se tentar adicionar a entrada de função Search-Mailbox a uma função subordinada da função Destinatários de Correio, receberá 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ções de gestão, veja Compreender as funções de gestão.
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. 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. Apenas 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 utiliza o cmdlet Get-ManagementRoleEntry para obter uma lista de todas as entradas de função existentes na função de gestão Destinatários de Correio que contêm a cadeia "Caixa de Correio" no nome do cmdlet e, em seguida, adiciona-as à função Administradores da Caixa de Correio com 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" -UnScopedTopLevel
No Exchange no local, este exemplo adiciona o script MailboxAudit com os parâmetros Departamento e Localização à função de nível superior não âmbito dos Scripts de TI. O comutador UnScopedTopLevel requer a função Gestão de Funções UnScoped, que não está atribuída a nenhum grupo de funções por predefinição.
Parâmetros
-Confirm
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
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, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata:
-Confirm:$false. - A maioria dos outros cmdlets (por exemplo, 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-DomainController
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Propriedades do parâmetro
| Tipo: | Fqdn |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Aplicável: Exchange Online, Suplemento de segurança incorporado para caixas de correio no local
Esse parâmetro só está disponível no serviço baseado em nuvem.
O comutador 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Identity
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
O parâmetro Identidade especifica a entrada de função que pretende adicionar. Este parâmetro utiliza a sintaxe: Management role\role entry name (por exemplo, CustomRole\Set-Mailbox).
Para obter mais informações sobre como funcionam as entradas de funções de gestão, veja Compreender as funções de gestão.
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 (").
Propriedades do parâmetro
| Tipo: | RoleEntryIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Identity
| Cargo: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Overwrite
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
O comutador Substituir faz com que as entradas de função existentes sejam substituídas pelas entradas de função que estão a ser adicionadas. Não é preciso especificar um valor com essa opção.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Parameters
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
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.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Identity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ParentRoleEntry
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
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.
Propriedades do parâmetro
| Tipo: | RoleEntryIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ParentRoleEntry
| Cargo: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-PSSnapinName
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
O parâmetro PSSnapinName especifica o Windows PowerShell snap-in que contém o cmdlet associado à função que está a ser adicionada. Utilize o cmdlet Get-PSSnapin para obter uma lista de snap-ins Windows PowerShell disponíveis.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Identity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Role
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
O parâmetro Role especifica a entrada à qual a nova entrada de função especificada pelo parâmetro ParentRoleEntry é adicionada.
Propriedades do parâmetro
| Tipo: | RoleIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ParentRoleEntry
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Type
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
O parâmetro Type especifica o tipo de entrada de função adicionada. Os valores válidos são Cmdlet, Script e ApplicationPermission.
Propriedades do parâmetro
| Tipo: | ManagementRoleEntryType |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Identity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UnScopedTopLevel
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
Por predefinição, este parâmetro está disponível apenas na função Gestão de Funções Não Encriptadas e essa função não está atribuída a nenhum grupo de funções. Para utilizar este parâmetro, tem de adicionar a função Gestão de Funções UnScoped a um grupo de funções (por exemplo, ao grupo de funções Gestão de Organizações). Para obter mais informações, veja Adicionar uma função a um grupo de funções.
O comutador UnScopedTopLevel especifica que está a adicionar a entrada de função a uma função de gestão de nível superior não selecionada. Não é preciso especificar um valor com essa opção.
As funções de gestão de nível superior não selecionadas só podem conter scripts personalizados ou cmdlets não Exchange. Para obter mais informações, veja Criar uma função não selecionada.
Não pode utilizar este comutador com o parâmetro ParentRoleEntry.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Identity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-WhatIf
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio
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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.
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.