Get-UMMailbox

Módulo:: Exchange PowerShell

Este cmdlet está disponível somente no Exchange local.

Use o cmdlet Get-UMMailbox para ver caixas de correio existentes habilitadas para Unificação de Mensagens (UM).

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

Sintaxe

AnrSet

Get-UMMailbox
    [-Anr <String>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [<CommonParameters>]

Identity

Get-UMMailbox
    [[-Identity] <MailboxIdParameter>]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [<CommonParameters>]

Description

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo 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-UMMailbox

Este exemplo exibe uma lista resumida de todas as caixas de correio habilitadas para UM em sua organização.

Exemplo 2

Get-UMMailbox -Identity tonysmith@contoso.com | Format-List

Este exemplo exibe informações detalhadas da caixa de correio habilitada para UM para tonysmith@contoso.com.

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:

Nome comum (CN)
DisplayName
FirstName
Sobrenome
Alias

Propriedades do parâmetro

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

Conjuntos de parâmetros

AnrSet

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

-Credential

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

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

-DomainController

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

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

-Filter

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

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

O parâmetro Identity especifica a caixa de correio habilitada para UM que você deseja exibir. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

Nome
Alias
Nome diferenciado (DN)
Nome diferenciado (DN)
Domínio\Nome de usuário
Endereço de email
GUID
LegacyExchangeDN
SamAccountName
ID de usuário ou nome UPN

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:	MailboxIdParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

Identity

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

-IgnoreDefaultScope

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

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

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

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

-ReadFromDomainController

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

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

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

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

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

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

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.

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.

Comentários

Esta página foi útil?