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 ambiente ou de 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 você tentar adicionar a entrada de função Search-Mailbox a uma função que é filho da função Destinatários de Email, 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ção de gerenciamento, consulte Noções básicas sobre funções de gerenciamento.
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo 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 Identity, Anr, Server e Filter 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 que existem na função de gerenciamento 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" -UnScopedTopLevel
No Exchange local, este exemplo adiciona o script MailboxAudit com os parâmetros Departamento e Local à função de nível superior sem escopo de Scripts de TI. A opção UnScopedTopLevel requer a função Gerenciamento de Função Sem Escopo, que não é atribuída a nenhum grupo de funções por padrão.
Parâmetros
-Confirm
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Complemento de segurança interna para segurança local caixas de correio
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer 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 reconhecer 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, complemento de segurança interno para caixas de correio locais
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.
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, Complemento de segurança interna para segurança local caixas de correio
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 funcionam as entradas de função de gerenciamento, 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 (").
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, Complemento de segurança interna para segurança local caixas de correio
A opção Substituir 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.
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, Complemento de segurança interna para segurança 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, Complemento de segurança interna para segurança 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 snap-in do 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.
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, Complemento de segurança interna para segurança 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, Complemento de segurança interna para segurança 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 padrão, esse parâmetro está disponível apenas na função Gerenciamento de Funções Sem Escopo 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 Gerenciamento de Função Sem Escopo a um grupo de funções (por exemplo, ao grupo de funções Gerenciamento da 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 sem escopo. Não é preciso especificar um valor com essa opção.
As funções de gerenciamento de nível superior sem escopo só podem conter scripts personalizados ou cmdlets que não sejam do Exchange. Para obter mais informações, consulte Criar uma função sem escopo.
Não é possível usar essa opção 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, Complemento de segurança interna para segurança local caixas de correio
A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. 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 dá suporte aos 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.