Get-EXORecipient

Módulo:
Exchange PowerShell

Este cmdlet está disponível somente no módulo do PowerShell do Exchange Online. Para obter mais informações, consulte Sobre o módulo do PowerShell do Exchange Online.

Use o cmdlet Get-EXORecipient para exibir objetos de destinatário existentes em sua organização. Este cmdlet retorna todos os objetos habilitados para email (por exemplo, caixas de correio, usuários de email, contatos de email e grupos de distribuição).

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Sintaxe

Identity (Default) 

Get-EXORecipient
    [[-Identity] <String>]
    [-ExternalDirectoryObjectId <Guid>]
    [-Filter <String>]
    [-IncludeSoftDeletedRecipients]
    [-OrganizationalUnit <String>]
    [-PrimarySmtpAddress <String>]
    [-Properties <String[]>]
    [-PropertySets <PropertySet[]>]
    [-RecipientPreviewFilter <String>]
    [-RecipientType <String[]>]
    [-RecipientTypeDetails <String[]>]
    [-ResultSize <Unlimited>]
    [-UserPrincipalName <String>]
    [<CommonParameters>]

Anr 

Get-EXORecipient
    [-Anr <String>]
    [-Filter <String>]
    [-IncludeSoftDeletedRecipients]
    [-OrganizationalUnit <String>]
    [-Properties <String[]>]
    [-PropertySets <PropertySet[]>]
    [-RecipientPreviewFilter <String>]
    [-RecipientType <String[]>]
    [-RecipientTypeDetails <String[]>]
    [-ResultSize <Unlimited>]
    [<CommonParameters>]

Description

Get-EXORecipient cmdlet pode ser usado para exibir objetos de destinatário existentes em sua organização. Este cmdlet retorna todos os objetos habilitados para email (por exemplo, caixas de correio, usuários de email, contatos de email e grupos de distribuição).

Exemplos

Exemplo 1

Get-EXORecipient -ResultSize 100

Este exemplo retorna os primeiros 100 objetos destinatários em ordem de classificação de nome.

Exemplo 2

Get-EXORecipient -Identity john@contoso.com

Este exemplo retorna os detalhes do atributo de destinatário para o usuário john@contoso.com

Parâmetros

-Anr

Aplicável: Exchange Online

O parâmetro Anr especifica uma cadeia de caracteres na qual executar uma pesquisa ANR (resolução de nomes ambíguos). Você pode especificar uma cadeia de caracteres parcial para objetos com um atributo correspondente a esta cadeia de caracteres. Os atributos padrão pesquisados são:

  • Nome comum (CN)
  • DisplayName
  • FirstName
  • Sobrenome
  • Alias

Não é possível usar esse parâmetro com os parâmetros ExternalDirectoryObjectId, Identity, PrimarySmtpAddress ou UserPrincipalName.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Anr
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ExternalDirectoryObjectId

Aplicável: Exchange Online

O parâmetro ExternalDirectoryObjectId identifica o destinatário que você deseja exibir pela ObjectId no Microsoft Entra ID.

Não é possível usar esse parâmetro com os parâmetros Anr, Identity, PrimarySmtpAddress ou UserPrincipalName.

Propriedades do parâmetro

Tipo:Guid
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:True
Valor dos argumentos restantes:False

-Filter

Aplicável: Exchange Online

O parâmetro Filter usa a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. O critério de pesquisa usa a sintaxe "Property -ComparisonOperator 'Value'".

  • Coloque todo o filtro OPATH entre aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo, $true, $false, ou $null), use aspas simples " '. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também poderá usar chaves { }, mas somente se o filtro não contiver variáveis.
  • A propriedade é uma propriedade filtrável. Para obter mais informações sobre as propriedades filtráveis, consulte Conjuntos de propriedades Get-EXORecipient e Propriedades filtráveis para o parâmetro Filter.
  • ComparisonOperator é um operador de comparação OPATH (por exemplo, -eq para igual e -like para comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators.
  • Valor é o valor da propriedade a ser pesquisado. Coloque os valores de texto e variáveis entre aspas simples ('Value' ou '$Variable'). Se um valor de variável contiver aspas simples, você precisará identificar (escapar) as aspas simples para expandir a variável corretamente. Por exemplo, em vez de '$User', use '$($User -Replace "'","''")'. Não coloque números inteiros ou valores do sistema entre aspas (por exemplo, use 500, $true, $false, ou $null em vez disso).

Você pode encadear vários critérios de pesquisa usando os operadores -and lógicos e -or. Por exemplo: "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".

Para obter informações detalhadas sobre filtros OPATH no Exchange, consulte Informações adicionais de sintaxe OPATH.

Propriedades do parâmetro

Tipo:String
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 Online

O parâmetro Identity especifica o objeto destinatário que você deseja visualizar. Para obter o melhor desempenho, recomendamos o uso dos seguintes valores para identificar o destinatário:

  • ID de usuário ou nome UPN
  • GUID

Caso contrário, você poderá usar qualquer valor que identifique exclusivamente o destinatário. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Domínio\Nome de usuário
  • Endereço de email
  • LegacyExchangeDN
  • SamAccountName

Não é possível usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.

Cuidado: O valor $null ou um valor inexistente para o parâmetro Identity retorna todos os objetos como se você tivesse executado o comando Get- sem o parâmetro Identity. Verifique se todas as listas de valores para o parâmetro Identity são precisas e não contêm valores de $null inexistentes.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Identity
Cargo:0
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-IncludeSoftDeletedRecipients

Aplicável: Exchange Online

A opção IncludeSoftDeletedRecipients especifica se os destinatários excluídos temporariamente devem ser incluídos nos resultados. Não é preciso especificar um valor com essa opção.

Os destinatários excluídos temporariamente são destinatários excluídos que ainda podem ser recuperados.

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

-OrganizationalUnit

Aplicável: Exchange Online

O parâmetro OrganizationalUnit filtra os resultados com base na localização do objeto no Active Directory. Somente objetos que existem na localização especificada são retornados. A entrada válida para esse parâmetro é uma UO (unidade organizacional) ou um domínio que fique visível na utilização do cmdlet Get-OrganizationalUnit. É possível usar qualquer valor que identifique a UO ou o domínio com exclusividade. Por exemplo:

  • Nome
  • Nome
  • Nome diferenciado (DN)
  • GUID

Propriedades do parâmetro

Tipo:String
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

-PrimarySmtpAddress

Aplicável: Exchange Online

O PrimarySmtpAddress identifica o destinatário que você deseja exibir pelo endereço de email SMTP primário (por exemplo, navin@contoso.com).

Não é possível usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, Identity ou UserPrincipalName.

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:True
Valor dos argumentos restantes:False

-Properties

Aplicável: Exchange Online

O parâmetro Properties especifica as propriedades retornadas na saída desse cmdlet. Vários valores, separados por vírgulas, podem ser especificados.

Para obter mais informações sobre as propriedades disponíveis, consulte Conjuntos de propriedades Get-EXORecipient.

Propriedades do parâmetro

Tipo:

String[]

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

-PropertySets

Aplicável: Exchange Online

O parâmetro PropertySets especifica um agrupamento lógico de propriedades que são retornadas na saída desse cmdlet. Os valores válidos são:

  • Mínimo (este é o valor padrão)
  • Arquivar
  • Personalizado
  • MailboxMove
  • Política

Para obter mais informações sobre as propriedades incluídas em cada conjunto de propriedades, consulte Conjuntos de propriedades Get-EXORecipient.

Propriedades do parâmetro

Tipo:

PropertySet[]

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

-RecipientPreviewFilter

Aplicável: Exchange Online

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:String
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

-RecipientType

Aplicável: Exchange Online

O parâmetro RecipientType filtra os resultados pelo tipo de destinatário especificado. Os valores válidos são:

  • DynamicDistributionGroup
  • MailContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • UserMailbox

Vários valores, separados por vírgulas, podem ser especificados.

Propriedades do parâmetro

Tipo:

String[]

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

-RecipientTypeDetails

Aplicável: Exchange Online

O parâmetro RecipientTypeDetails filtra os resultados pelo subtipo de destinatário especificado. Os valores válidos são:

  • DiscoveryMailbox
  • DynamicDistributionGroup
  • EquipmentMailbox
  • GroupMailbox
  • GuestMailUser
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • MailContact
  • MailForestContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • PublicFolderMailbox
  • Caixa de correio de equipamento remoto
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox
  • RemoteUserMailbox
  • RoomList
  • RoomMailbox
  • SchedulingMailbox
  • SharedMailbox
  • SharedWithMailUser
  • TeamMailbox
  • UserMailbox

Vários valores, separados por vírgulas, podem ser especificados.

O valor do parâmetro RecipientType afeta os valores que você pode usar para esse parâmetro. Por exemplo, se você usar o valor RecipientType MailContact, não poderá usar o valor UserMailbox para esse parâmetro. Você recebe o erro: nenhum dos RecipientTypeDetails especificados está incluído em nenhum tipo de destinatário especificado.

Propriedades do parâmetro

Tipo:

String[]

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

-ResultSize

Aplicável: Exchange Online

O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.

Propriedades do parâmetro

Tipo:Unlimited
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

-UserPrincipalName

Aplicável: Exchange Online

O parâmetro UserPrincipalName identifica o destinatário que você deseja exibir por UPN (por exemplo, navin@contoso.onmicrosoft.com).

Não é possível usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, Identity ou PrimarySmtpAddress.

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:True
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.