Usar o Shell de Gerenciamento do Exchange para gerenciar filas
Aplica-se a: Exchange Server 2013
Como nas versões anteriores do Exchange, você pode usar o Shell de Gerenciamento do Exchange no Microsoft Exchange Server 2013 para exibir informações sobre as filas e as mensagens nessas filas e para executar ações de gerenciamento em filas e mensagens. No Exchange 2013, filas existem em servidores de transporte de borda e servidores de caixa de correio. Este tópico refere-se a esses servidores como servidores de transporte.
Quando você usar o Shell para exibir e gerenciar filas e mensagens em filas de servidores de transporte, é importante entender como identificar as filas ou mensagens que você deseja gerenciar. Normalmente, os servidores de transporte contêm um grande número de filas e mensagens a serem entregues. Você usa os parâmetros de filtragem disponíveis nos cmdlets de gerenciamento de filas e mensagens para identificar as filas ou mensagens que deseja exibir ou gerenciar.
Observe que você também pode usar o Visualizador de Filas na Caixa de Ferramentas do Exchange para gerenciar filas e mensagens em filas. No entanto, a fila e a mensagem que exibem cmdlets oferecem suporte a mais propriedades filtráveis e opções de filtro do que o Visualizador de Filas. Para obter mais informações sobre como usar o Visualizador de Filas, consulte Visualizador de Filas.
Parâmetros de filtragem de fila
A tabela a seguir descreve os parâmetros de filtragem disponíveis nos cmdlets de gerenciamento de fila.
Cmdlet | Parâmetros de filtragem | Comments |
---|---|---|
Get-Queue |
Identity Filtro Include Excluir |
Você não pode usar o parâmetro Identity no mesmo comando com os parâmetros Filter . Você pode usar os parâmetros Incluir e Excluir com o parâmetro Filtrar no mesmo comando. |
Resume-Queue Retry-Queue Suspend-Queue |
Identity Filtro |
Você precisa usar o parâmetro Identity ou o parâmetro Filter , mas não pode usar ambos no mesmo comando. |
Get-QueueDigest |
Servidor Dag Site Floresta Filtro |
Você precisa usar o parâmetro Server, Dag, Site ou Forest , mas não pode usar nenhum deles juntos no mesmo comando. Você pode usar o parâmetro Filter com qualquer um dos outros parâmetros de filtragem. |
Observe que um parâmetro server está disponível em todos os cmdlets de gerenciamento de filas. No cmdlet Get-QueueDigest , o parâmetro Server é um parâmetro de escopo que especifica o servidor ou servidores em que você deseja exibir informações de resumo sobre filas. Em todos os outros cmdlets de gerenciamento de filas, você usa o parâmetro Server para se conectar a um servidor específico e executar os comandos de gerenciamento de filas nesse servidor. Você pode usar o parâmetro Server com ou sem o parâmetro Filter , mas não pode usar o parâmetro Server com o parâmetro Identity . Você usa o nome de host do servidor de transporte ou FQDN com o parâmetro Server .
Identidade da fila
O parâmetro Identidade nos cmdlets de gerenciamento de fila identifica uma fila específica. Quando você usa o parâmetro Identidade , não é possível especificar nenhum outro parâmetro de filtragem de fila, pois você já identificou exclusivamente a fila. O parâmetro Identity usa asintaxe básica Fila> do Servidor<\><.
O <espaço reservado do Servidor> é o nome do host ou FQDN do servidor Exchange, por exemplo mailbox01
, ou mailbox01.contoso.com
. Se você omitir o qualificador do< Servidor>, o servidor local estará implícito.
O < espaço reservado fila> aceita um dos seguintes valores:
Nome da fila persistente: filas persistentes têm nomes exclusivos e consistentes em todos os servidores de Caixa de Correio ou Transporte de Borda. Os nomes de fila persistentes são:
- Envio: essa fila contém mensagens aguardando para serem processadas pelo categorizador.
- Inacessível: essa fila contém mensagens que não podem ser roteadas. Esta fila não existe até que as mensagens sejam colocadas nela.
- Veneno: essa fila contém mensagens que são determinadas como prejudiciais ao servidor exchange. Esta fila não existe até que as mensagens sejam colocadas nela.
Nome da fila de entrega: o nome de uma fila de entrega é o valor da propriedade NextHopDomain da fila. Por exemplo, o nome da fila poderia ser o espaço de endereçamento de um conector de envio, o nome de um site do Active Directory ou o nome de um DAG. Para obter mais informações, consulte a seção "NextHopSolutionKey", no tópico Filas.
Inteiro da fila: filas de entrega e filas de sombra recebem um valor inteiro exclusivo no banco de dados de fila. No entanto, você precisa executar o cmdlet Get-Queue para localizar o valor inteiro nas propriedades Identity ou QueueIdentity.
Nome da fila de sombras: uma fila de sombras usa a sintaxe
Shadow\
<QueueInteger>
A tabela a seguir resume a sintaxe que você pode usar com o parâmetro Identity nos cmdlets de gerenciamento de fila. Em todos os valores, <Server> é o nome do host ou FQDN do servidor.
Formatos de identidade de fila
Valor do parâmetro de identidade | Descrição |
---|---|
<Server>\<PersistentQueueName> ou <PersistentQueueName> |
Uma fila persistente no servidor especificado ou no servidor local. <PersistentQueueName> é Submission , Unreachable ou Poison . |
<Server>\<NextHopDomain> ou <NextHopDomain> |
Uma fila de entrega no servidor especificado ou no servidor local. <NextHopDomain> é um destino de roteamento ou grupo de entrega para as mensagens na fila. Para obter mais informações, consulte a seção "NextHopSolutionKey", no tópico Filas. |
<Server>\<QueueInteger> ou <QueueInteger> |
Uma fila de entrega no servidor especificado ou no servidor local. <QueueInteger> é o valor inteiro exclusivo da fila exibida na propriedade Identity do cmdlet Get-Queue . |
<Server>\Shadow\<QueueInteger> ou Shadow\<QueueInteger> |
Uma fila de sombras no servidor especificado ou no servidor local. |
<Server>\* ou * |
Todas as filas no servidor especificado ou no servidor local. Observe que esses valores só podem ser usados com o cmdlet Get-Queue . |
Parâmetro de filtro de fila
Você pode usar o parâmetro Filtrar em todos os cmdlets de gerenciamento de filas para especificar as filas que deseja exibir ou gerenciar com base nas propriedades das filas. O parâmetro Filter cria uma expressão com operadores de comparação que restringe a operação de fila a filas que atendem aos critérios de filtro. Você pode usar o -and
operador lógico para especificar várias condições que os resultados devem corresponder.
Para obter uma lista completa de propriedades de fila que você pode usar com o parâmetro Filtro , consulte Filas.
Para obter uma lista de operadores de comparação que você pode usar com o parâmetro Filtro , consulte a seção Operadores de comparação a serem usados ao filtrar filas ou mensagens neste tópico.
Para obter exemplos de procedimentos que usam o parâmetro Filtrar para exibir e gerenciar filas, consulte Gerenciar filas.
Incluir e excluir parâmetros
O Exchange 2013 tem os parâmetros Incluir e Excluir disponíveis no Get-Queue
cmdlet. Você pode usar esses parâmetros individualmente, juntos e com o parâmetro Filter para ajustar os resultados da fila no servidor de transporte local ou especificado. Por exemplo, você pode:
- Exclua filas vazias de resultados.
- Exclua filas para destinos externos dos resultados.
- Inclua filas que têm um valor específico de DeliveryType nos resultados.
Os parâmetros Incluir e Excluir usam as seguintes propriedades de fila para filtrar filas:
Valor | Descrição | Exemplo de código shell |
---|---|---|
DeliveryType |
Esse valor inclui ou exclui filas com base na propriedade DeliveryType . Vários valores, separados por vírgulas, podem ser especificados. Os valores válidos para DeliveryType são explicados na seção "NextHopSolutionKey" no tópico Filas . | Este exemplo retorna todas as filas de entrega no servidor local em que o próximo salto é um conector Enviar no servidor local configurado para roteamento de host inteligente:Get-Queue -Include SmartHostConnectorDelivery |
Empty |
Esse valor inclui ou exclui filas vazias. Filas vazias têm o valor 0 na propriedade MessageCount . |
Este exemplo retorna todas as filas no servidor local que contêm mensagensGet-Queue -Exclude Empty |
External |
Esse valor inclui ou exclui filas que têm o valor External na propriedade NextHopCategory . Filas externas sempre têm um dos seguintes valores para DeliveryType:
Para obter mais informações, consulte a seção "NextHopSolutionKey", no tópico Filas. |
Este exemplo retorna todas as filas internas no servidor localGet-Queue -Exclude External |
Internal |
Esse valor inclui ou exclui filas que têm o valor Internal na propriedade NextHopCategory . Para obter mais informações, consulte a seção "NextHopSolutionKey", no tópico Filas. |
Este exemplo retorna todas as filas internas no servidor local. Get-Queue -Include Internal |
Observe que você pode duplicar a funcionalidade dos parâmetros Incluir e Excluir usando o parâmetro Filter . Por exemplo, o comando Get-Queue -Exclude Empty
produz o mesmo resultado que Get-Queue -Filter "MessageCount -gt 0"
. No entanto, a sintaxe dos parâmetros Incluir e Excluir é mais simples e fácil de lembrar.
Get-QueueDigest
O Exchange 2013 adiciona um novo cmdlet de fila chamado Get-QueueDigest. Esse cmdlet permite exibir informações sobre algumas ou todas as filas em sua organização do Exchange com um único comando. Especificamente, o cmdlet Get-QueueDigest permite que você exiba informações sobre filas com base em sua localização nos servidores, em DAGs, nos sites do Active Directory ou em toda a floresta do Active Directory. Observe que filas em um servidor de Transporte de Borda inscrito na rede de perímetro não são incluídas nos resultados. Além disso, Get-QueueDigest está disponível em um servidor de Transporte de Borda, mas os resultados estão restritos a filas no servidor de Transporte de Borda.
Observação
Por padrão, o cmdlet Get-QueueDigest exibe as filas de entrega que contenham dez ou mais mensagens e os resultados são de um a dois minutos atrás. Para instruções sobre como alterar estes valores padrões, consulte Configurar Get-QueueDigest.
Os parâmetros de filtragem e classificação disponíveis no cmdlet Get-QueueDigest são descritos na tabela a seguir.
Parâmetro | Descrição |
---|---|
Dag, Server ou Site | Esses parâmetros são mutuamente exclusivos e definem o escopo para o cmdlet. Você precisa especificar um desses parâmetros ou a opção Floresta . Normalmente, você usaria o nome do servidor, DAG ou site do Active Directory, mas pode usar qualquer valor que identifique exclusivamente o servidor, o DAG ou o site. Você pode especificar vários servidores, DAGs ou sites separados por vírgulas. |
Floresta | Essa opção será necessária se você não estiver usando os parâmetros Dag, Server ou Site . Você não especifica um valor com essa opção. Ao usar essa opção, você obtém filas de todos os servidores da caixa de correio do Exchange 2013 na floresta do Active Directory. Você não pode usar a opção Floresta para exibir filas em florestas remotas do Active Directory. |
DetailsLevel | Esse parâmetro aceita os valores None , Normal e Verbose . O valor padrão é Normal . Quando você usa o valor None , o nome da fila é omitido da coluna Detalhes nos resultados. |
Filtro | Esse parâmetro permite filtrar filas com base nas propriedades da fila. Você pode usar qualquer uma das propriedades da fila filtrada, conforme descrito no tópico Filtros de fila . |
GroupBy | Esse parâmetro agrupa os resultados da fila. Você pode agrupar os resultados por uma das seguintes propriedades:
Por padrão, os resultados são agrupados por |
Resultsize | Esse parâmetro limita os resultados da fila ao valor especificado. As filas são classificadas em ordem decrescente com base no número de mensagens na fila e agrupadas pelo valor especificado pelo parâmetro GroupBy . O valor padrão é 1000. Isso significa que, por padrão, o comando exibe as 1000 principais filas agrupadas pelo NextHopDomain e classificadas pelas filas que contêm mais mensagens para as filas que contêm as mensagens mínimas. |
Timeout | O parâmetro especifica o número de segundos antes do tempo limite da operação. O valor padrão é 00:00:10 ou 10 segundos. |
Este exemplo retorna todas as filas externas não vazias nos servidores de Caixa de Correio do Exchange 2013 chamadas Mailbox01,Mailbox02 e Mailbox03.
Get-QueueDigest -Server Mailbox01,Mailbox02,Mailbox03 -Include External -Exclude Empty
Parâmetros de filtragem de mensagem
A tabela a seguir descreve os parâmetros de filtragem disponíveis nos cmdlets de gerenciamento de mensagens.
Cmdlet | Parâmetros de filtragem | Comments |
---|---|---|
Get-Message |
Identity Filtro Fila |
Todos os parâmetros de filtragem são mutuamente exclusivos e você pode usá-los juntos no mesmo comando. |
Remove-Message Resume-Message Suspend-Message |
Identity Filtro |
Você precisa usar o parâmetro Identity ou o parâmetro Filter , mas não pode usar ambos no mesmo comando. |
Export-Message | Identity | O parâmetro Identity é necessário. |
Observe que um parâmetro server está disponível em todos os cmdlets de gerenciamento de mensagens, exceto para o cmdlet Export-Message . Você usa o parâmetro Server para se conectar a um servidor específico e executar os comandos de gerenciamento de mensagens nesse servidor. Você pode usar o parâmetro Server com ou sem o parâmetro Filter , mas não pode usar o parâmetro Server com o parâmetro Identity . Você usa o nome de host do servidor de transporte ou FQDN com o parâmetro Server .
Identidade da mensagem
O parâmetro Identidade nos cmdlets de gerenciamento de mensagens identifica uma mensagem específica em uma ou mais filas. Quando você usa o parâmetro Identidade , não é possível especificar nenhum outro parâmetro de filtragem de mensagens, pois você já identificou exclusivamente a mensagem. O parâmetro Identity usa a sintaxe<>\<básica Server Queue>\<MessageInteger>.
O <espaço reservado do Servidor> é o nome do host ou FQDN do servidor Exchange, por exemplo mailbox01
, ou mailbox01.contoso.com
. Se você omitir o qualificador do< Servidor>, o servidor local estará implícito.
O < espaço reservado Fila> aceita a identidade da fila, conforme descrito na seção "Identidade da fila" neste tópico. Por exemplo, você pode usar o nome da fila persistente, o valor NextHopDomain ou o valor de número inteiro exclusivo da fila no banco de dados de fila.
O <espaço reservado MessageInteger> representa o valor inteiro exclusivo atribuído à mensagem quando ele entra pela primeira vez no banco de dados de fila no servidor. Se a mensagem é enviada para vários destinatários que exigem várias filas, todas as cópias da mensagem em todas as filas do banco de dados de fila têm o mesmo valor de número inteiro. No entanto, você precisa executar o cmdlet Get-Message para localizar o valor inteiro da mensagem nas propriedades Identity ou MessageIdentity.
A tabela a seguir resume a sintaxe que você pode usar com o parâmetro Identity nos cmdlets de gerenciamento de mensagens. Em todos os valores, <Server> é o nome do host ou FQDN do servidor.
Formatos de identidade de mensagem
Valor do parâmetro de identidade | Descrição |
---|---|
<Server>\<Queue>\<MessageInteger> ou <Queue>\<MessageInteger> |
Uma mensagem em uma fila específica no servidor especificado ou no servidor local. <MessageInteger> é o valor inteiro exclusivo da mensagem exibida na propriedade Identity do cmdlet Get-Message . <A fila> representa um dos seguintes valores:
|
<Server>\*\<MessageInteger> ou ou *\<MessageInteger> <MessageInteger> |
Todas as cópias da mensagem em todas as filas no banco de dados de fila no servidor especificado ou no servidor local. |
Parâmetro de filtro de mensagem
Você pode usar o parâmetro Filtrar nos cmdlets Get-Message, Remove-Message, Resume-Message e Suspend-Message para especificar as mensagens que deseja exibir ou gerenciar com base nas propriedades das mensagens. O parâmetro Filter cria uma expressão com operadores de comparação que restringe a operação de mensagem a mensagens que atendem aos critérios de filtro. Você pode usar o -and
operador lógico para especificar várias condições que os resultados devem corresponder.
Para obter uma lista completa de propriedades de mensagem que você pode usar com o parâmetro Filtro , consulte Filas.
Para obter uma lista de operadores de comparação que você pode usar com o parâmetro Filtro , consulte a seção Operadores de comparação a serem usados ao filtrar filas ou mensagens neste tópico.
Para obter exemplos de procedimentos que usam o parâmetro Filter para exibir e gerenciar mensagens, consulte Gerenciar filas.
Parâmetro de fila
O parâmetro Queue é usado apenas com o cmdlet Get-Message . Você pode usar esse parâmetro para obter todas as mensagens em uma fila específica ou todas as mensagens de várias filas usando o caractere curinga (*). Ao usar o parâmetro Fila, use o formatode identidade de fila Fila> do Servidor<\>, conforme descrito na seção "Identidade da fila" neste< tópico.
Operadores de comparação para usar ao filtrar filas ou mensagens
Ao criar uma expressão de filtro de fila ou mensagem usando o parâmetro Filter , você precisa incluir um operador de comparação para que o valor da propriedade corresponda. A tabela seguinte mostra os operadores de comparação que podem ser usados em uma expressão de filtro e como cada operador funciona. Para todos os operadores, os valores em comparação não diferenciam maiúsculas de minúsculas.
Operadores de comparação
Operador | Função | Exemplo de código shell |
---|---|---|
-eq |
Esse operador é usado para especificar que os resultados devem corresponder exatamente ao valor da propriedade fornecido na expressão. | Para exibir uma lista de todas as filas que têm um status de Repetição:Get-Queue -Filter "Status -eq 'Retry'" Para exibir uma lista de todas as mensagens que têm um status de Repetição: Get-Message -Filter "Status -eq 'Retry'" |
-ne |
Esse operador é usado para especificar que os resultados não devem corresponder ao valor da propriedade fornecido na expressão. | Para exibir uma lista de todas as filas que não têm um status do Active:Get-Queue -Filter "Status -ne 'Active'" Para exibir uma lista de todas as mensagens que não têm um status do Active: Get-Message -Filter "Status -ne 'Active'" |
-gt |
Esse operador é usado com propriedades em que o valor é expresso como um inteiro ou data/hora. Os resultados do filtro incluem apenas filas ou mensagens em que o valor da propriedade especificada é maior do que o valor fornecido na expressão. | Para exibir uma lista de filas que atualmente contêm mais de 1.000 mensagens:Get-Queue -Filter "MessageCount -gt 1000" Para exibir uma lista de mensagens que atualmente têm uma contagem de repetição que é mais de 3: Get-Message -Filter "RetryCount -gt 3" |
-ge |
Esse operador é usado com propriedades em que o valor é expresso como um inteiro ou data/hora. Os resultados do filtro incluem apenas filas ou mensagens em que o valor da propriedade especificada é maior ou igual ao valor fornecido na expressão. | Para exibir uma lista de filas que atualmente contêm 1.000 ou mais mensagens:Get-Queue -Filter "MessageCount -ge 1000" Para exibir uma lista de mensagens que atualmente têm uma contagem de repetição que é 3 ou mais: Get-Message -Filter "RetryCount -ge 3" |
-lt |
Esse operador é usado com propriedades em que o valor é expresso como um inteiro ou data/hora. Os resultados do filtro incluem apenas filas ou mensagens em que o valor da propriedade especificada é menor do que o valor fornecido na expressão. | Para exibir uma lista de filas que atualmente contêm menos de 1.000 mensagens:Get-Queue -Filter "MessageCount -lt 1000" Para exibir uma lista de mensagens que têm uma SCL menor que 6: Get-Message -Filter "SCL -lt 6" |
-le |
Esse operador é usado com propriedades em que o valor é expresso como um inteiro ou data/hora. Os resultados do filtro incluem apenas filas ou mensagens em que o valor da propriedade especificada é menor ou igual ao valor fornecido na expressão. | Para exibir uma lista de filas que atualmente contêm 1.000 ou menos mensagens:Get-Queue -Filter "MessageCount -le 1000" Para exibir uma lista de mensagens que têm uma SCL com 6 ou menos: Get-Message -Filter "SCL -le 6" |
-like |
Esse operador é usado com propriedades em que o valor é expresso como uma cadeia de caracteres de texto. Os resultados do filtro incluem apenas filas ou mensagens em que o valor da propriedade especificada contém a cadeia de caracteres de texto fornecida na expressão. Você pode incluir o caractere curinga (*) em uma expressão semelhante a uma aplicada a um campo de cadeia de caracteres de texto, mas não com um campo que tenha o tipo de enumeração. | Para exibir uma lista de filas de entrega que têm um destino para qualquer domínio SMTP que termina em Contoso.com:Get-Queue -Filter "Identity -like '*contoso.com'" Para exibir uma lista de mensagens que têm um assunto que contém o texto "empréstimo do dia de pagamento": Get-Messages -Filter "Subject -like '*payday loan*'" |
Você pode especificar um filtro que avalia várias expressões usando o operador de comparação -and. As filas ou mensagens devem satisfazer todas as condições do filtro a ser incluído nos resultados.
Este exemplo exibe uma lista de filas que tenham um destino para qualquer nome de domínio SMTP que termina em Contoso.com e que atualmente contém mais de 500 mensagens.
Get-Queue -Filter "Identity -like '*contoso.com*' -and MessageCount -gt 500"
Este exemplo exibe uma lista de mensagens enviadas de qualquer endereço de email no domínio contoso.com que tenham um SCL maior que 5.
Get-Message -Filter "FromAddress -like '*Contoso.com*' -and SCL -gt 5"
Parâmetros de paginação avançados
Dependendo do fluxo de mensagens atual, as consultas em filas e mensagens podem retornar um conjunto de objetos grande. Você pode usar os parâmetros de paginação avançada para controlar como os resultados da consulta são recuperados e exibidos.
Quando você usar o Shell para exibir filas e as mensagens nas filas, sua consulta recuperará uma página de informações de cada vez. Os parâmetros de paginação avançada controlam o tamanho do conjunto de resultados e também podem ser usados para classificar os resultados. Todos os parâmetros de paginação avançada são opcionais e podem ser combinados a qualquer um dos conjuntos de parâmetros que podem ser usados com os cmdlets Get-Queue e Get-Message. Se nenhum parâmetro de paginação avançada for especificado, a consulta retornará os resultados na ordem crescente de identidade.
Por padrão, quando uma ordem de classificação é especificada, a propriedade de identidade da mensagem é sempre incluída e classificada na ordem crescente. Este é o relacionamento de ordenação padrão. A propriedade de identidade da mensagem é incluída, pois as outras propriedades que podem ser incluídas em uma ordem de classificação não são exclusivas. Ao incluir explicitamente a propriedade de identidade da mensagem na ordem de classificação, você pode especificar que os resultados exibam a identidade da mensagem armazenada em ordem decrescente.
Você pode usar os parâmetros BookmarkIndex e BookmarkObject para marcar uma posição no conjunto de resultados classificado. Se o objeto indicador não existir mais quando a próxima página de resultados for recuperada, o relacionamento de ordenação padrão verificará se o conjunto de resultados começa com o objeto mais próximo ao indicador. O objeto mais próximo depende da ordem de classificação especificada.
A tabela a seguir descreve os parâmetros de paginação avançada.
Parâmetro | Descrição |
---|---|
Bookmarkindex | Esse parâmetro especifica a posição no conjunto de resultados em que os resultados exibidos começam. O valor deste parâmetro é um índice baseado em 1 no conjunto de resultados total. Se o valor for menor ou igual a zero, a primeira página completa de resultados será retornada. Se o valor for definido como Int.MaxValue , a última página completa dos resultados será retornada. |
Bookmarkobject | Esse parâmetro especifica o objeto no conjunto de resultados em que os resultados exibidos começam. Se você especificar um objeto de indicador, esse objeto será usado como o ponto para iniciar a pesquisa. As linhas antes ou depois desse objeto, dependendo do valor do parâmetro SearchForward , são recuperadas. Você não pode combinar o parâmetro BookmarkObject e o parâmetro BookmarkIndex em uma única consulta. |
Includebookmark | Este parâmetro especifica se deve incluir o objeto indicador no conjunto de resultados. Por padrão, o valor é definido como $true e o objeto indicador está incluído. Você pode executar uma consulta para um tamanho de resultado limitado e especificar o último item nesse resultado definido como o indicador para a próxima consulta. Nesse caso, talvez você queira definir IncludeBookmark para $false que o objeto não esteja incluído em ambos os conjuntos de resultados. |
Resultsize | Esse parâmetro especifica o número de resultados a serem exibidos por página. Se você não especificar um valor, o tamanho padrão do resultado de 1.000 objetos será usado. O Exchange limita o resultado definido como 250.000. |
ReturnPageInfo | Esse parâmetro é um parâmetro oculto. Ele retorna informações sobre o número total de resultados e o índice do primeiro objeto da página atual. O valor padrão é $false . |
Searchforward | Esse parâmetro especifica se é necessário pesquisar para frente ou para trás no conjunto de resultados. Esse parâmetro não afeta a ordem na qual o conjunto de resultados é retornado. Ele determina a direção da pesquisa em relação ao índice de indicador ou objeto. Se nenhum índice de indicador ou objeto for especificado, o parâmetro SearchForward determinará se a pesquisa começa do primeiro ou último objeto no conjunto de resultados. O valor padrão para esse parâmetro é $true . Se esse parâmetro for definido como $true e um indicador for especificado, a consulta será encaminhada a partir desse indicador. Se você usar essa configuração e não houver resultados além do indicador, a consulta retornará a última página completa dos resultados. Se o parâmetro SearchForward estiver definido como $false e um indicador for especificado, a consulta será pesquisada para trás desse indicador. Se você usar essa configuração e houver menos de uma página inteira de resultados além do indicador, a consulta retornará a primeira página completa de resultados. |
SortOrder | Esse parâmetro especifica uma matriz de propriedades de mensagem usadas para controlar a ordem de classificação do conjunto de resultados. As propriedades de ordem de classificação são especificadas na ordem de precedência decrescente. Cada propriedade é separada por uma vírgula e acrescentada com um sinal de adição (+) para classificar em ordem crescente ou um sinal de menos (-) para classificar em ordem decrescente. Se uma ordem de classificação explícita não for especificada usando esse parâmetro, os registros que correspondem à consulta serão exibidos e classificados pelo campo Identidade para o respectivo tipo de objeto. Os resultados são sempre classificados pela identidade em ordem crescente quando uma ordem de classificação não é especificada explicitamente. |
O exemplo de código a seguir mostra como usar os parâmetros de paginação avançada em uma consulta. Neste exemplo, o comando conecta ao servidor especificado e recupera um conjunto de resultados que contém 500 objetos. Os resultados são exibidos em uma ordem classificada, primeiro na ordem crescente por endereço do remetente e, em seguida, na ordem decrescente de tamanho da mensagem.
Get-Message -Server mailbox01.contoso.com -ResultSize 500 -SortOrder +FromAddress,-Size
Se você desejar exibir páginas sucessivas, poderá definir um indicador para o último objeto recuperado em um conjunto de resultados e executar uma consulta adicional. Você precisa usar os recursos de script do Shell para executar este procedimento.
O exemplo a seguir usa script para recuperar a primeira página de resultados, define o objeto indicador, exclui o objeto indicador do conjunto de resultados e, em seguida, recupera os próximos 500 objetos no servidor especificado.
Abra o Shell e digite o seguinte comando para recuperar a primeira página de resultados.
$Results=Get-message -Server mailbox01.contoso.com -ResultSize 500 -SortOrder +FromAddress,-Size
Para definir o objeto indicador, digite o seguinte comando para salvar o último elemento da primeira página em uma variável.
$temp=$results[$results.length-1]
Para recuperar os próximos 500 objetos no servidor especificado e excluir o objeto indicador, digite o seguinte comando.
Get-message -Server mailbox01.contoso.com -BookmarkObject:$temp -IncludeBookmark $False -ResultSize 500 -SortOrder +FromAddress,-Size