Get-Recipient
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 ou outro ambiente.
Use o cmdlet Get-Recipient para ver objetos de destinatários 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).
Nota: no Exchange Online PowerShell, recomendamos que utilize o cmdlet Get-EXORecipient em vez deste cmdlet. Para saber mais, confira Conectar-se ao Exchange Online usando o PowerShell Remoto.
Em ambientes na cloud, para devolver Grupos do Microsoft 365, tem de utilizar o parâmetro RecipientTypeDetails com o valor GroupMailbox.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Get-Recipient
[-Anr <String>]
[-AuthenticationType <AuthenticationType>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Capabilities <MultiValuedProperty>]
[-Database <DatabaseIdParameter>]
[-Properties <String[]>]
[-IncludeManagerWithDisplayName]
[-IncludeSoftDeletedRecipients]
[<CommonParameters>]Get-Recipient
[[-Identity] <RecipientIdParameter>]
[-AuthenticationType <AuthenticationType>]
[-BookmarkDisplayName <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IncludeBookmarkObject <Boolean>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Capabilities <MultiValuedProperty>]
[-Properties <String[]>]
[-IncludeManagerWithDisplayName]
[-IncludeSoftDeletedRecipients]
[<CommonParameters>]Get-Recipient
[-Database <DatabaseIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-Properties <String[]>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-IncludeSoftDeletedRecipients] [<CommonParameters>]
[<CommonParameters>]Get-Recipient
[-RecipientPreviewFilter <String>]
[-AuthenticationType <AuthenticationType>]
[-Capabilities <MultiValuedProperty>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IncludeManagerWithDisplayName]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-Properties <String[]>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]Description
O cmdlet Get-Recipient pode não retornar todas as propriedades específicas de um objeto para um destinatário. Para ver as propriedades específicas de um objeto de um destinatário, é necessário usar o cmdlet correspondente baseado no tipo de objeto (por exemplo, Get-Mailbox, Get-MailUser ou Get-DistributionGroup).
Para executar esse cmdlet, você precisa ter permissões. Embora este tópico 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
Get-Recipient -ResultSize unlimitedEste exemplo recupera uma lista de resumo de todos os destinatários em sua organização.
Exemplo 2
Get-Recipient -Identity "Marketing Department" | Format-ListEste exemplo devolve informações detalhadas para o destinatário com o nome Departamento de Marketing.
Exemplo 3
Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,NameEste exemplo recupera as informações sobre os contatos de email em sua organização e os organiza por departamento.
Parâmetros
-Anr
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
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-AuthenticationType
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro AuthenticationType especifica o destinatário por tipo de autenticação. Use um dos valores a seguir:
- Federado
- Gerenciado
| Tipo: | AuthenticationType |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online, Security & Compliance, Exchange Online Protection |
-BookmarkDisplayName
Esse parâmetro está reservado para uso interno da Microsoft.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Capabilities
Esse parâmetro só está disponível no serviço baseado em nuvem.
Esse parâmetro está reservado para uso interno da Microsoft.
| Tipo: | MultiValuedProperty |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online, Security & Compliance, Exchange Online Protection |
-Credential
Este parâmetro está disponível somente no Exchange local.
O parâmetro Credential especifica o nome de utilizador e a palavra-passe utilizados para executar este comando. Normalmente, você usa esse parâmetro em scripts ou quando você precisa fornecer credenciais diferentes que têm as permissões necessárias.
Um valor para esse parâmetro requer o cmdlet Get-Credential. Para pausar o comando e receber uma solicitação de credenciais, use o valor (Get-Credential). Ou, antes de executar esse comando, armazene as credenciais em uma variável (por exemplo, $cred = Get-Credential) e, em seguida, use o nome da variável ($cred) para esse parâmetro. Para saber mais, confira Obter credencial.
| Tipo: | PSCredential |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Database
Este parâmetro está disponível somente no Exchange local.
O parâmetro Base de Dados devolve todos os destinatários armazenados na base de dados da caixa de correio especificada. É possível usar qualquer valor que identifique o banco de dados com exclusividade. Por exemplo:
- Nome
- DN (nome diferenciado)
- GUID
| Tipo: | DatabaseIdParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
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.
| Tipo: | Fqdn |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
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 no servidor Exchange e Exchange Online, veja Propriedades filtráveis para o parâmetro Filter.
- 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.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Identity
O parâmetro Identity especifica o objeto destinatário que você deseja visualizar. É possível usar qualquer valor que identifique o destinatário com exclusividade. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Nome diferenciado (DN)
- DN canônico
- GUID
| Tipo: | RecipientIdParameter |
| Cargo: | 1 |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IgnoreDefaultScope
Este parâmetro está disponível somente no Exchange local.
O comutador IgnoreDefaultScope indica ao comando para ignorar a definição de âmbito de destinatário predefinida para a sessão do Exchange PowerShell e utilizar toda a floresta como âmbito. Não é preciso especificar um valor com essa opção.
Este comutador permite que o comando aceda a objetos do Active Directory que não estão atualmente disponíveis no âmbito predefinido, mas também introduz as seguintes restrições:
- Não é possível usar o parâmetro DomainController. O comando usa um servidor de catálogo global adequado automaticamente.
- Não é possível usar o parâmetro DomainController. O comando usa um servidor de catálogo global adequado automaticamente.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IncludeBookmarkObject
Esse parâmetro está reservado para uso interno da Microsoft.
| Tipo: | Boolean |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IncludeManagerWithDisplayName
Esse parâmetro só está disponível no serviço baseado em nuvem.
{{ Fill IncludeManagerWithDisplayName Description }}
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Online, Exchange Online Protection |
-IncludeSoftDeletedRecipients
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.
Nota: utilize este parâmetro com os parâmetros Identity ou RecipientTypeDetails para obter os SoftDeletedRecipients.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-OrganizationalUnit
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 este parâmetro é uma unidade organizacional (UO) ou domínio que é devolvido pelo 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
| Tipo: | OrganizationalUnitIdParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Properties
Esse parâmetro está reservado para uso interno da Microsoft.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-PropertySet
Esse parâmetro está reservado para uso interno da Microsoft.
| Tipo: | PropertySet |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ReadFromDomainController
Este parâmetro está disponível somente no Exchange local.
A opção ReadFromDomainController especifica se as informações devem ser lidas de um controlador de domínio no domínio do usuário. Não é preciso especificar um valor com essa opção.
O comando: Set-AdServerSettings -ViewEntireForest $true para incluir todos os objetos na floresta, é necessário o comutador ReadFromDomainController. Caso contrário, o comando poderá utilizar um catálogo global que contenha informações desatualizadas. Além disso, poderá ter de executar várias iterações do comando com o comutador ReadFromDomainController para obter as informações.
Por predefinição, o âmbito do destinatário está definido como o domínio que aloja os seus servidores Exchange.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RecipientPreviewFilter
O parâmetro RecipientPreviewFilter testa um filtro de destinatário que utilizaria num grupo de distribuição dinâmico, numa lista de endereços ou numa política de endereços de e-mail. Este parâmetro utiliza a sintaxe do filtro LDAP.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RecipientType
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.
| Tipo: | RecipientType[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RecipientTypeDetails
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 (Exchange 2013 ou posterior e cloud)
- GuestMailUser (Exchange 2016 ou posterior e cloud)
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox (Exchange 2013 ou posterior e cloud)
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox (Exchange 2013 ou posterior e cloud)
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox (Exchange 2013 ou posterior e cloud)
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox (Exchange 2016 ou posterior e cloud)
- SharedMailbox
- SharedWithMailUser (apenas na cloud)
- TeamMailbox (Exchange 2013 ou posterior e cloud)
- 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. Receberá o erro: Nenhum dos RecipientTypeDetails especificados está incluído em qualquer tipo de destinatário especificado.
| Tipo: | RecipientTypeDetails[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ResultSize
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.
| Tipo: | Unlimited |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-SortBy
O parâmetro SortBy especifica a propriedade pela qual classificar os resultados. Você pode classificar apenas por uma propriedade de cada vez. Os resultados são classificados em ordem crescente.
Se a vista predefinida não incluir a propriedade pela qual está a ordenar, pode acrescentar o comando com | Format-Table -Auto Property1,Property2,...PropertyX. para criar uma nova vista que contenha todas as propriedades que pretende ver. Os caracteres curinga (*) nos nomes de propriedade são permitidos.
É possível classificar pelas seguintes propriedades:
- Nome
- DisplayName
- Alias
- Cidade
- FirstName
- Sobrenome
- Office
- ServerLegacyDN
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
| Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
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.