Get-EXORecipient
Este cmdlet só está disponível no módulo Exchange Online PowerShell. Para obter mais informações, veja Acerca do módulo Exchange Online PowerShell.
Utilize o cmdlet Get-EXORecipient para ver objetos de destinatário existentes na 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 utilizado para ver objetos de destinatário existentes na 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 devolve os primeiros 100 objetos de destinatário por ordem ordenada pelo nome.
Exemplo 2
Get-EXORecipient -Identity john@contoso.com
Este exemplo devolve os detalhes do atributo do destinatário para o utilizador 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:
- CommonName (CN)
- DisplayName
- FirstName
- Sobrenome
- Alias
Não pode utilizar este 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 pretende ver pelo ObjectId no Microsoft Entra ID.
Não pode utilizar este 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 utiliza a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. Os critérios de pesquisa utilizam a sintaxe "Property -ComparisonOperator 'Value'".
- Coloque todo o filtro OPATH entre aspas " ". Se o filtro contiver valores de sistema (por exemplo,
$true,$falseou$null), utilize aspas únicas ' ' em vez disso. Embora este parâmetro seja uma cadeia (não um bloco de sistema), também pode utilizar chavetas { }, mas apenas se o filtro não contiver variáveis. - A propriedade é uma propriedade filtráveis. Para obter mais informações sobre as propriedades filtráveis, veja Get-EXORecipient property sets (Conjuntos de propriedades Get-EXORecipient) e Filterable properties (Propriedades filtráveis) para o parâmetro Filter (Filtro).
- ComparisonOperator é um operador de comparação OPATH (por exemplo
-eq, para igual e-likepara comparação de cadeias). Para obter mais informações sobre operadores de comparação, veja about_Comparison_Operators. - Valor é o valor da propriedade a procurar. Coloque os valores de texto e as variáveis entre plicas (
'Value'ou'$Variable'). Se um valor de variável contiver aspas únicas, terá de identificar (escape) as aspas únicas para expandir a variável corretamente. Por exemplo, em vez de'$User', utilize'$($User -Replace "'","''")'. Não coloque números inteiros ou valores do sistema entre aspas (por exemplo, utilize500,$true,$falseou$nullem alternativa).
Pode encadear múltiplos critérios de pesquisa em conjunto com os operadores lógicos -and e -or. Por exemplo: "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".
Para obter informações detalhadas sobre filtros OPATH no Exchange, veja Informações adicionais sobre 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 que utilize os seguintes valores para identificar o destinatário:
- ID de usuário ou nome UPN
- GUID
Caso contrário, pode utilizar qualquer valor que identifique exclusivamente o destinatário. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Domínio\Nome de Utilizador
- Endereço de email
- LegacyExchangeDN
- SamAccountName
Não pode utilizar este parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.
Atenção: o valor $null ou um valor inexistente para o parâmetro Identidade devolve todos os objetos como se tivesse executado o comando Get- sem o parâmetro Identity. Verifique se as listas de valores do parâmetro Identity estão corretas 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
O comutador IncludeSoftDeletedRecipients especifica se pretende incluir destinatários eliminados de forma recuperável nos resultados. Não é preciso especificar um valor com essa opção.
Os destinatários eliminados de forma recuperável são destinatários eliminados que ainda são recuperáveis.
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 pretende ver pelo endereço de e-mail SMTP principal (por exemplo, navin@contoso.com).
Não pode utilizar este 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 Propriedades especifica as propriedades que são devolvidas na saída deste cmdlet. Vários valores, separados por vírgulas, podem ser especificados.
Para obter mais informações sobre as propriedades disponíveis, veja Get-EXORecipient property sets (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 devolvidas na saída deste cmdlet. Os valores válidos são:
- Mínimo (este é o valor predefinido)
- Arquivar
- Personalizado
- MailboxMove
- Política
Para obter mais informações sobre as propriedades incluídas em cada conjunto de propriedades, veja Get-EXORecipient property sets (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
- Caixa de Correio de Equipamento
- GroupMailbox
- GuestMailUser
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox
- RemoteEquipmentMailbox
- 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 pode utilizar para este parâmetro. Por exemplo, se utilizar o valor RecipientType MailContact, não poderá utilizar o valor UserMailbox para este parâmetro. Recebe o erro: Nenhum dos RecipientTypeDetails especificados está incluído em qualquer 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 pretende ver pelo UPN (por exemplo, navin@contoso.onmicrosoft.com).
Não pode utilizar este 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 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.