Get-DistributionGroup

 

Aplica-se a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Tópico modificado em: 2010-04-27

Use o cmdlet Get-DistributionGroup para consultar sobre grupos de distribuição existentes.

Sintaxe

Get-DistributionGroup [-Identity <DistributionGroupIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-ManagedBy <GeneralRecipientIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Get-DistributionGroup [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-ManagedBy <GeneralRecipientIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Get-DistributionGroup [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-ManagedBy <GeneralRecipientIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Descrição detalhada

Você pode usar grupos de distribuição para criar listas de distribuição de email e grupos de segurança para atribuir permissões a recursos compartilhados. Os grupos de distribuição podem ser usados apenas com aplicativos de email (como o Exchange) para enviar mensagens de email a coleções de usuários. Você pode usar o cmdlet Get-DistributionGroup para consultar sobre grupos de distribuição existentes.

Para executar o cmdlet Get-DistributionGroup, você deve usar a conta à qual esteja delegada a seguinte função:

  • Função de Administrador Somente para Exibição do Exchange

Para obter mais informações sobre permissões, delegação de funções e os direitos necessários para administrar o Microsoft Exchange Server 2007, consulte Considerações sobre permissão.

Parâmetros

Parâmetro Necessário Tipo Descrição

ANR

Opcional

System.String

O parâmetro ANR indica que o argumento será resolvido com uma resolução de nomes ambíguos (ANR).

Credential

Opcional

System.Management.Automation.PSCredential

O parâmetro Credential indica o domínio e o nome de usuário da conta usada para ler o serviço de diretório do Active Directory.

DomainController

Opcional

Microsoft.Exchange.Data.Fqdn

Para especificar o nome de domínio totalmente qualificado (FQDN) do controlador de domínio que recupera dados do Active Directory, inclua o parâmetro DomainController no comando.

Filter

Opcional

System.String

O parâmetro Filter indica o filtro OPath usado para filtrar destinatários.

Para obter mais informações sobre as propriedades filtráveis, consulte Propriedades filtráveis do parâmetro -Filter.

Identity

Opcional

Microsoft.Exchange.Configuration.Tasks.DistributionGroupIdParameter

O parâmetro Identity do grupo de distribuição aceita um dos seguintes formatos:

  • GUID

  • Nome diferenciado (DN)

  • LegacyExchangeDN

  • Domínio\NomedaConta

  • Alias

IgnoreDefaultScope

Opcional

System.Management.Automation.SwitchParameter

O parâmetro IgnoreDefaultScope instrui o comando a ignorar a configuração padrão de escopo do destinatário do Shell de Gerenciamento do Exchange e usar toda a floresta como o escopo. Isso permite que o comando acesse objetos do Active Directory que não estão atualmente no escopo padrão. O uso do parâmetro IgnoreDefaultScope introduz as seguintes restrições:

  • Você não pode usar o parâmetro DomainController. O comando usará automaticamente um servidor de catálogo global adequado.

  • Você pode usar o DN somente para o parâmetro Identity. Outras formas de identificação, como alias ou GUID, não são aceitas.

  • Você não pode usar os parâmetros OrganizationalUnit e Identity juntos.

  • Você não pode usar o parâmetro Credential.

ManagedBy

Opcional

Microsoft.Exchange.Configuration.Tasks.GeneralRecipientIdParameter

O parâmetro ManagedBy indica o nome diferenciado do usuário ou contato que gerencia o grupo.

OrganizationalUnit

Opcional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

O parâmetro OrganizationalUnit limita os resultados a um contêiner de UO (unidade organizacional) específico.

ReadFromDomainController

Opcional

System.Management.Automation.SwitchParameter

O parâmetro ReadFromDomainController especifica se as informações do usuário são lidas a partir de um controlador de domínio no domínio do usuário. Se você definir o escopo do destinatário para incluir todos os destinatários da floresta e não usar este parâmetro, talvez as informações do usuário sejam lidas a partir de um catálogo global com informações desatualizadas. Se você usar este parâmetro, várias leituras poderão ser necessárias para obter as informações.

Dica

Por padrão, o escopo do destinatário é definido como o domínio que hospeda seus servidores Exchange.

RecipientTypeDetails

Opcional

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

O parâmetro RecipientTypeDetails especifica o tipo de destinatários que são retornados. Os tipos de destinatários no Microsoft Exchange Server 2007 são divididos em tipos e subtipos de destinatários. Cada tipo de destinatário contém todas as propriedades comuns para todos os subtipos. Por exemplo, o tipo UserMailbox representa uma conta de usuário no Active Directory com uma caixa de correio associada. Como há vários tipos de caixas de correio, cada tipo é identificado pelo parâmetro RecipientTypeDetails. Por exemplo, uma caixa de correio de sala de conferência tem RecipientTypeDetails definido como ConferenceRoomMailbox, enquanto uma caixa de correio de usuário tem RecipientTypeDetails definido como UserMailbox.

Para este comando, os detalhes de tipo de destinatário disponíveis são:

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

ResultSize

Opcional

Microsoft.Exchange.Data.Unlimited

O parâmetro ResultSize indica o número máximo de objetos de destinatários que serão retornados.

SortBy

Opcional

System.String

O atributo SortBy é usado para classificar os resultados.

Tipos de entrada

Tipos de retorno

Erros

Erro Descrição

  

Exceções

Exceções Descrição

  

Exemplo

O código a seguir é um exemplo do comando Get-DistributionGroup. Nesse exemplo, o comando Get-DistributionGroup recupera o Grupo de Distribuição 1 e canaliza o objeto para o comando Format-List para exibir as informações sobre o grupo de distribuição.

Get-DistributionGroup -Identity "Distribution Group1" | Format-List