Get-Recipient

Sintaxe

AnrSet

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>]

Identity

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>]

DatabaseSet

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>]

RecipientPreviewFilterSet

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

Exemplos

Exemplo 1

Get-Recipient -ResultSize unlimited

Exemplo 2

Get-Recipient -Identity "Marketing Department" | Format-List

Exemplo 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

Parâmetros

-Anr

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

Propriedades do parâmetro

Conjuntos de parâmetros

-AuthenticationType

Aplicável: Exchange Online, Segurança & Conformidade, Complemento de segurança integrado para caixas de correio locais

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

Propriedades do parâmetro

Conjuntos de parâmetros

-BookmarkDisplayName

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

Propriedades do parâmetro

Conjuntos de parâmetros

-Capabilities

Aplicável: Exchange Online, Segurança & Conformidade, Complemento de segurança integrado para caixas de correio locais

Esse parâmetro só está disponível no serviço baseado em nuvem.

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

Propriedades do parâmetro

Conjuntos de parâmetros

-Credential

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 Credential especifica o nome de usuário e a senha usados para executar esse 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.

Propriedades do parâmetro

Conjuntos de parâmetros

-Database

Aplicável: 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 Database retorna todos os destinatários armazenados no banco de dados de caixa de correio especificado. É possível usar qualquer valor que identifique o banco de dados com exclusividade. Por exemplo:

• Nome
• DN (nome diferenciado)
• GUID

Propriedades do parâmetro

Conjuntos de parâmetros

-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

Conjuntos de parâmetros

-Filter

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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 no Exchange Server e no Exchange Online, consulte Propriedades filtráveis para o parâmetro Filtro.
• 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

Conjuntos de parâmetros

-Identity

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

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

Conjuntos de parâmetros

-IgnoreDefaultScope

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.

A opção IgnoreDefaultScope informa ao comando para ignorar a configuração de escopo de destinatário padrão para a sessão do PowerShell do Exchange e usar toda a floresta como escopo. Não é preciso especificar um valor com essa opção.

Essa opção permite que o comando acesse objetos do Active Directory que não estão disponíveis no momento no escopo padrão, 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.

Propriedades do parâmetro

Conjuntos de parâmetros

-IncludeBookmarkObject

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

Propriedades do parâmetro

Conjuntos de parâmetros

-IncludeManagerWithDisplayName

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.

{{ Fill IncludeManagerWithDisplayName Description }}

Propriedades do parâmetro

Conjuntos de parâmetros

-IncludeSoftDeletedRecipients

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Complemento de segurança interna para caixas de correio locais

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.

Observação: use essa opção com os parâmetros Identity ou RecipientTypeDetails para obter os SoftDeletedRecipients.

Propriedades do parâmetro

Conjuntos de parâmetros

-OrganizationalUnit

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 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 domínio retornado 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

Propriedades do parâmetro

Conjuntos de parâmetros

-Properties

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Complemento de segurança integrado para caixas de correio locais

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

Propriedades do parâmetro

Conjuntos de parâmetros

-PropertySet

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

Propriedades do parâmetro

Conjuntos de parâmetros

-ReadFromDomainController

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.

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 requer a opção ReadFromDomainController. Caso contrário, o comando poderá usar um catálogo global que contém informações desatualizadas. Além disso, talvez seja necessário executar várias iterações do comando com a opção ReadFromDomainController para obter as informações.

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

Propriedades do parâmetro

Conjuntos de parâmetros

-RecipientPreviewFilter

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

O parâmetro RecipientPreviewFilter testa um filtro de destinatário que você usaria em um grupo dinâmico de distribuição, lista de endereços ou política de endereço de email. Esse parâmetro usa a sintaxe de filtro LDAP.

Propriedades do parâmetro

Conjuntos de parâmetros

-RecipientType

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

Conjuntos de parâmetros

-RecipientTypeDetails

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

• DiscoveryMailbox
• DynamicDistributionGroup
• EquipmentMailbox
• GroupMailbox (Exchange 2013 ou posterior e nuvem)
• GuestMailUser (Exchange 2016 ou posterior e nuvem)
• LegacyMailbox
• LinkedMailbox
• LinkedRoomMailbox (Exchange 2013 ou posterior e nuvem)
• MailContact
• MailForestContact
• MailNonUniversalGroup
• MailUniversalDistributionGroup
• MailUniversalSecurityGroup
• MailUser
• PublicFolder
• PublicFolderMailbox (Exchange 2013 ou posterior e nuvem)
• Caixa de correio de equipamento remoto
• RemoteRoomMailbox
• RemoteSharedMailbox
• RemoteTeamMailbox (Exchange 2013 ou posterior e nuvem)
• RemoteUserMailbox
• RoomList
• RoomMailbox
• SchedulingMailbox (Exchange 2016 ou posterior e nuvem)
• SharedMailbox
• SharedWithMailUser (somente nuvem)
• TeamMailbox (Exchange 2013 ou posterior e nuvem)
• 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

Conjuntos de parâmetros

-ResultSize

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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

Conjuntos de parâmetros

-SortBy

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Segurança & Conformidade, Segurança Interna Complemento para caixas de correio locais

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 exibição padrão não incluir a propriedade pela qual você está classificando, você poderá acrescentar o comando com | Format-Table -Auto Property1,Property2,...PropertyX. para criar uma nova exibição que contém todas as propriedades que você deseja 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

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Entradas

Input types

Saídas

Output types