Utilisation de l’environnement de ligne de commande Exchange Management Shell pour gérer les files d’attente
S’applique à : Exchange Server 2013
Comme dans les versions précédentes d'Exchange, vous pouvez utiliser l'environnement de ligne de commande Exchange Management Shell dans Microsoft Exchange Server 2013 pour consulter des informations sur les files d'attente et les messages qu'elles contiennent, ainsi que pour effectuer des actions de gestion sur ces éléments. Dans Exchange 2013, il existe des files d'attente sur les serveurs de boîtes aux lettres et les serveurs de transport Edge. Cette rubrique fait référence à ces serveurs en tant que serveurs de transport.
Lorsque vous utilisez l'environnement de ligne de commande pour afficher et gérer les files d'attente et les messages qu'elles contiennent sur les serveurs de transport, il est important de savoir comment identifier les éléments à gérer. Généralement, les serveurs de transport contiennent un grand nombre de files d'attente et de messages à remettre. Pour identifier les files d'attentes ou les messages à afficher ou à gérer, vous utilisez les paramètres de filtrage disponibles dans les cmdlets de gestion des files d'attente et des messages.
Notez que, pour gérer les files d'attente et les messages qu'elles contiennent, vous pouvez également utiliser l'Afficheur des files d'attente disponible dans la boîte à outils Exchange. Toutefois, les cmdlets d'affichage des files d'attente et des messages prennent en charge un plus grand nombre de propriétés filtrables et d'options de filtrage que l'Afficheur des files d'attente. Pour plus d'informations sur l'Afficheur des files d'attente, consultez la rubrique Afficheur des files d'attente.
Paramètres de filtrage de file d'attente
Le tableau suivant décrit les paramètres de filtrage disponibles pour les cmdlets de gestion de file d'attente.
Cmdlet | Paramètres de filtrage | Comments |
---|---|---|
Get-Queue |
Identity Filter Include Exclude |
Vous ne pouvez pas utiliser le paramètre Identity dans la même commande que les paramètres De filtre . Vous pouvez utiliser les paramètres Include et Exclude avec le paramètre Filter dans la même commande. |
Resume-Queue Retry-Queue Suspend-Queue |
Identity Filtre |
Vous devez utiliser le paramètre Identity ou le paramètre Filter , mais vous ne pouvez pas utiliser les deux dans la même commande. |
Get-QueueDigest |
Server Dag Site Forest Filtre |
Vous devez utiliser le paramètre Serveur, Dag, Site ou Forêt , mais vous ne pouvez pas les utiliser ensemble dans la même commande. Vous pouvez utiliser le paramètre Filter avec n’importe lequel des autres paramètres de filtrage. |
Notez qu’un paramètre Server est disponible sur toutes les applets de commande de gestion des files d’attente. Sur l’applet de commande Get-QueueDigest , le paramètre Server est un paramètre d’étendue qui spécifie le ou les serveurs sur lesquels vous souhaitez afficher des informations récapitulatives sur les files d’attente. Sur toutes les autres applets de commande de gestion de file d’attente, vous utilisez le paramètre Server pour vous connecter à un serveur spécifique et exécuter les commandes de gestion de file d’attente sur ce serveur. Vous pouvez utiliser le paramètre Server avec ou sans le paramètre Filter , mais vous ne pouvez pas utiliser le paramètre Server avec le paramètre Identity . Vous utilisez le nom d’hôte ou le nom de domaine complet du serveur de transport avec le paramètre Server .
Identité de file d'attente
Le paramètre Identity sur les applets de commande de gestion de file d’attente identifie une file d’attente spécifique. Lorsque vous utilisez le paramètre Identity , vous ne pouvez pas spécifier d’autres paramètres de filtrage de file d’attente, car vous avez déjà identifié la file d’attente de manière unique. Le paramètre Identity utilise la syntaxede base File d’attente> du serveur<\><.
L’espace< réservé serveur> est le nom d’hôte ou le nom de domaine complet du serveur Exchange, par exemple mailbox01
ou mailbox01.contoso.com
. Si vous omettez le <qualificateur de serveur> , le serveur local est implicite.
L’espace < réservé File d’attente> accepte l’une des valeurs suivantes :
Nom de la file d’attente persistante : les files d’attente persistantes ont des noms uniques et cohérents sur tous les serveurs de transport De boîte aux lettres ou Edge. Les noms de files d'attente permanentes sont les suivants :
- Envoi : cette file d’attente contient des messages en attente d’être traités par le catégorisateur.
- Inaccessible : cette file d’attente contient des messages qui ne peuvent pas être routés. Cette file d'attente existe uniquement à partir du moment où des messages y sont placés.
- Poison : cette file d’attente contient des messages qui sont jugés dangereux pour le serveur Exchange. Cette file d'attente existe uniquement à partir du moment où des messages y sont placés.
Nom de la file d’attente de remise : le nom d’une file d’attente de remise est la valeur de la propriété NextHopDomain de la file d’attente. Par exemple, le nom de file d'attente peut être l'espace d'adressage d'un connecteur d'envoi, le nom d'un site Active Directory ou le nom d'un DAG. Pour plus d'informations, consultez la section « NextHopSolutionKey » de la rubrique Files d'attente.
Entier de file d’attente : les files d’attente de remise et les files d’attente d’ombre se voient attribuer une valeur entière unique dans la base de données de file d’attente. Toutefois, vous devez exécuter la cmdlet Get-Queue pour trouver la valeur entière de la file d'attente dans la propriété Identity ou QueueIdentity.
Nom de la file d’attente d’ombre : une file d’attente fantôme utilise la syntaxe
Shadow\
<QueueInteger>
Le tableau suivant récapitule la syntaxe que vous pouvez utiliser avec le paramètre Identity sur les applets de commande de gestion des files d’attente. Dans toutes les valeurs, <Server> est le nom d’hôte ou le nom de domaine complet du serveur.
Formats d'identité de file d'attente
Valeur de paramètre d'identité | Description |
---|---|
<Server>\<PersistentQueueName> ou <PersistentQueueName> |
File d'attente permanente sur le serveur spécifié ou sur le serveur local. <PersistentQueueName> est Submission , Unreachable ou Poison . |
<Server>\<NextHopDomain> ou <NextHopDomain> |
File d'attente de remise sur le serveur spécifié ou sur le serveur local. <NextHopDomain> est une destination de routage ou un groupe de remise pour les messages figurant dans la file d'attente. Pour plus d'informations, consultez la section « NextHopSolutionKey » de la rubrique Files d'attente. |
<Server>\<QueueInteger> ou <QueueInteger> |
File d'attente de remise sur le serveur spécifié ou sur le serveur local. <QueueInteger> est la valeur entière unique de la file d'attente indiquée dans la propriété Identity de la cmdlet Get-Queue. |
<Server>\Shadow\<QueueInteger> ou Shadow\<QueueInteger> |
File d'attente de clichés instantanés sur le serveur spécifié ou sur le serveur local. |
<Server>\* ou * |
Toutes les files d'attente sur le serveur spécifié ou sur le serveur local. Notez que ces valeurs peuvent être utilisées uniquement avec la cmdlet Get-Queue. |
Paramètre de filtrage de file d'attente
Vous pouvez utiliser le paramètre Filter sur toutes les applets de commande de gestion des files d’attente pour spécifier les files d’attente que vous souhaitez afficher ou gérer en fonction des propriétés des files d’attente. Le paramètre Filter crée une expression avec des opérateurs de comparaison qui limite l’opération de file d’attente aux files d’attente qui répondent aux critères de filtre. Vous pouvez utiliser l’opérateur -and
logique pour spécifier plusieurs conditions auxquelles les résultats doivent correspondre.
Pour obtenir la liste complète des propriétés de file d’attente que vous pouvez utiliser avec le paramètre Filter , consultez Files d’attente.
Pour obtenir la liste des opérateurs de comparaison que vous pouvez utiliser avec le paramètre Filter , consultez la section Opérateurs de comparaison à utiliser lors du filtrage des files d’attente ou des messages dans cette rubrique.
Pour obtenir des exemples de procédures qui utilisent le paramètre Filter pour afficher et gérer les files d’attente, consultez Gérer les files d’attente.
Paramètres Include et Exclude
Exchange 2013 a les paramètres Include et Exclude disponibles sur l’applet de Get-Queue
commande . Vous pouvez utiliser ces paramètres individuellement, ensemble et avec le paramètre Filter pour affiner les résultats de votre file d’attente sur le serveur de transport local ou spécifié. Par exemple, vous pouvez :
- Exclure des résultats les files d'attente vides.
- Exclure des résultats les files d'attente vers des destinations externes.
- Inclure dans les résultats les files d'attente dont le paramètre DeliveryType a une valeur spécifique.
Les paramètres Include et Exclude utilisent les propriétés de file d’attente suivantes pour filtrer les files d’attente :
Valeur | Description | Exemple de code dans l'environnement de ligne de commande |
---|---|---|
DeliveryType |
Cette valeur inclut ou exclut des files d'attente en fonction de la valeur de la propriété DeliveryType. Vous pouvez spécifier plusieurs valeurs séparées par des virgules. Les valeurs valides pour DeliveryType sont expliquées dans la section « NextHopSolutionKey » de la rubrique Files d’attente . | Cet exemple renvoie toutes les files d'attente de remise sur le serveur local où le saut suivant est un connecteur d'envoi sur le serveur local, configuré pour le routage d'hôte actif :Get-Queue -Include SmartHostConnectorDelivery |
Empty |
Cette valeur inclut ou exclut les files d'attente vides. Les files d’attente vides ont la valeur 0 dans la propriété MessageCount . |
Cet exemple renvoie toutes les files d'attente sur le serveur local, qui contiennent des messagesGet-Queue -Exclude Empty |
External |
Cette valeur inclut ou exclut les files d’attente qui ont la valeur External dans la propriété NextHopCategory . Dans les files d'attente externes, le paramètre DeliveryType a toujours l'une des valeurs suivantes :
Pour plus d'informations, consultez la section « NextHopSolutionKey » de la rubrique Files d'attente. |
Cet exemple renvoie toutes les files d'attente internes sur le serveur local.Get-Queue -Exclude External |
Internal |
Cette valeur inclut ou exclut les files d’attente qui ont la valeur Internal dans la propriété NextHopCategory . Pour plus d'informations, consultez la section « NextHopSolutionKey » de la rubrique Files d'attente. |
Cet exemple renvoie toutes les files d'attente internes sur le serveur local. Get-Queue -Include Internal |
Notez que vous pouvez dupliquer les fonctionnalités des paramètres Include et Exclude à l’aide du paramètre Filter . Par exemple, la commande Get-Queue -Exclude Empty
produit le même résultat que Get-Queue -Filter "MessageCount -gt 0"
. Toutefois, la syntaxe des paramètres Include et Exclude est plus simple et plus facile à mémoriser.
Get-QueueDigest
Exchange 2013 ajoute une cmdlet de file d'attente nommée Get-QueueDigest. Cette cmdlet vous permet d'afficher des informations concernant une partie ou la totalité des files d'attente au sein de votre organisation Exchange à l'aide d'une seule commande. Plus particulièrement, la cmdlet Get-QueueDigest vous permet d'afficher des informations sur les files d'attente, en fonction de leur emplacement sur des serveurs, dans des DAG, dans des sites Active Directory ou dans la forêt Active Directory toute entière. Les files d'attente sur un serveur de transport Edge abonné dans le réseau de périmètre ne sont pas incluses dans les résultats. De plus, la cmdlet Get-QueueDigest est disponible sur un serveur de transport Edge, mais les résultats sont limités aux files d'attente sur le serveur de transport Edge.
Remarque
Par défaut, la cmdlet Get-QueueDigest affiche les files d’attente de remise contenant au moins dix messages, et les résultats peuvent dater d’une à deux minutes. Pour obtenir des instructions sur la modification de ces valeurs par défaut, consultez la rubrique Configurer Get-QueueDigest Configurer Get-QueueDigest.
Les paramètres de filtrage et de tri disponibles pour la cmdlet Get-QueueDigest sont décrits dans le tableau suivant.
Paramètre | Description |
---|---|
Dag, serveur ou site | Ces paramètres s'excluent mutuellement et définissent l'étendue d'application de la cmdlet. Vous devez spécifier l’un de ces paramètres ou le commutateur De forêt . Généralement, vous utiliserez le nom du serveur, du DAG ou du site Active Directory, mais vous pouvez également utiliser toute valeur identifiant de façon unique le serveur, le DAG ou le site. Vous pouvez spécifier plusieurs serveurs, DAG ou sites séparés par des virgules. |
Forest | Ce commutateur est requis si vous n’utilisez pas les paramètres Dag, Server ou Site . Avec ce commutateur, vous ne spécifiez aucune valeur. En utilisant ce commutateur, vous obtenez les files d'attente de tous les serveurs de boîtes aux lettres Exchange 2013 figurant dans la forêt Active Directory. Vous ne pouvez pas utiliser le commutateur De forêt pour afficher les files d’attente dans les forêts Active Directory distantes. |
DetailsLevel | Ce paramètre accepte les valeurs None , Normal et Verbose . La valeur par défaut est Normal . Lorsque vous utilisez la valeur None , le nom de la file d’attente est omis dans la colonne Détails dans les résultats. |
Filtre | Ce paramètre vous permet de filtrer des files d'attente sur la base de leurs propriétés. Vous pouvez utiliser toutes les propriétés de file d'attente filtrables décrites dans la rubrique Filtres de file d'attente. |
GroupBy | Ce paramètre groupe les résultats de file d'attente. Vous pouvez grouper les résultats pour l'une des propriétés suivantes :
Par défaut, les résultats sont regroupés par |
ResultSize | Ce paramètre limite les résultats de file d'attente à la valeur que vous spécifiez. Les files d’attente sont triées dans l’ordre décroissant en fonction du nombre de messages dans la file d’attente et regroupées par la valeur spécifiée par le paramètre GroupBy . La valeur par défaut est 1000. Cela signifie que, par défaut, la commande affiche les 1 000 premières files d'attente groupées par NextHopDomain, et triées dans l'ordre décroissant du nombre de messages qu'elles contiennent. |
Timeout | Le paramètre spécifie le nombre de secondes avant l’expiration de l’opération. La valeur par défaut est 00:00:10 ou 10 secondes. |
Cet exemple renvoie toutes les files d'attente externes non vides présentes sur les serveurs de boîtes aux lettres Exchange 2013 nommés Mailbox01, Mailbox02 et Mailbox03.
Get-QueueDigest -Server Mailbox01,Mailbox02,Mailbox03 -Include External -Exclude Empty
Paramètres de filtrage de message
Le tableau suivant décrit les paramètres de filtrage disponibles pour les cmdlets de gestion de message.
Cmdlet | Paramètres de filtrage | Comments |
---|---|---|
Get-Message |
Identity Filter Queue |
Tous les paramètres de filtrage s'excluent mutuellement, et vous pouvez les utiliser ensemble dans la même commande. |
Remove-Message Resume-Message Suspend-Message |
Identity Filtre |
Vous devez utiliser le paramètre Identity ou le paramètre Filter , mais vous ne pouvez pas utiliser les deux dans la même commande. |
Export-Message | Identity | Le paramètre Identity est obligatoire. |
Notez qu’un paramètre Server est disponible sur toutes les applets de commande de gestion des messages, à l’exception de l’applet de commande Export-Message . Vous utilisez le paramètre Server pour vous connecter à un serveur spécifique et exécuter les commandes de gestion des messages sur ce serveur. Vous pouvez utiliser le paramètre Server avec ou sans le paramètre Filter , mais vous ne pouvez pas utiliser le paramètre Server avec le paramètre Identity . Vous utilisez le nom d’hôte ou le nom de domaine complet du serveur de transport avec le paramètre Server .
Identité de message
Le paramètre Identity sur les applets de commande de gestion des messages identifie un message spécifique dans une ou plusieurs files d’attente. Lorsque vous utilisez le paramètre Identity , vous ne pouvez pas spécifier d’autres paramètres de filtrage des messages, car vous avez déjà identifié le message de manière unique. Le paramètre Identity utilise la syntaxe <de base Server>\<Queue>\<MessageInteger>.
L’espace< réservé serveur> est le nom d’hôte ou le nom de domaine complet du serveur Exchange, par exemple mailbox01
ou mailbox01.contoso.com
. Si vous omettez le <qualificateur de serveur> , le serveur local est implicite.
L’espace < réservé file d’attente> accepte l’identité de la file d’attente, comme décrit dans la section « Identité de file d’attente » de cette rubrique. Par exemple, vous pouvez utiliser le nom de file d'attente permanente, la valeur NextHopDomain ou la valeur entière unique de la file d'attente dans la base de données de files d'attente.
L’espace <réservé MessageInteger> représente la valeur entière unique affectée au message lorsqu’il entre pour la première fois dans la base de données de file d’attente sur le serveur. Si le message est envoyé à plusieurs destinataires nécessitant plusieurs files d'attente, toutes ses copies dans toutes les files d'attente reprises dans la base de données de files d'attente ont la même valeur entière. Toutefois, vous devez exécuter la cmdlet Get-Message pour trouver la valeur entière du message dans la propriété Identity ou MessageIdentity.
Le tableau suivant récapitule la syntaxe que vous pouvez utiliser avec le paramètre Identity sur les applets de commande de gestion des messages. Dans toutes les valeurs, <Server> est le nom d’hôte ou le nom de domaine complet du serveur.
Formats d'identité de message
Valeur de paramètre d'identité | Description |
---|---|
<Server>\<Queue>\<MessageInteger> ou <Queue>\<MessageInteger> |
Message dans une file d'attente spécifique sur le serveur spécifié ou sur le serveur local. <MessageInteger> est la valeur entière unique du message indiquée dans la propriété Identity de la cmdlet Get-Message. <File d'attente> représente l'une des valeurs suivantes :
|
<Server>\*\<MessageInteger> ou ou *\<MessageInteger> <MessageInteger> |
Toutes les copies du message dans tous les files d'attente reprises dans la base de données de files d'attente sur le serveur spécifié ou sur le serveur local. |
Paramètre de filtrage de message
Vous pouvez utiliser le paramètre Filter sur les applets de commande Get-Message, Remove-Message, Resume-Message et Suspend-Message pour spécifier les messages que vous souhaitez afficher ou gérer en fonction des propriétés des messages. Le paramètre Filter crée une expression avec des opérateurs de comparaison qui limite l’opération de message aux messages qui répondent aux critères de filtre. Vous pouvez utiliser l’opérateur -and
logique pour spécifier plusieurs conditions auxquelles les résultats doivent correspondre.
Pour obtenir la liste complète des propriétés de message que vous pouvez utiliser avec le paramètre Filter , consultez Files d’attente.
Pour obtenir la liste des opérateurs de comparaison que vous pouvez utiliser avec le paramètre Filter , consultez la section Opérateurs de comparaison à utiliser lors du filtrage des files d’attente ou des messages dans cette rubrique.
Pour obtenir des exemples de procédures qui utilisent le paramètre Filter pour afficher et gérer les messages, consultez Gérer les files d’attente.
Paramètre de file d'attente
Le paramètre Queue est utilisé uniquement avec l’applet de commande Get-Message . Vous pouvez utiliser ce paramètre pour obtenir tous les messages d’une file d’attente spécifique ou tous les messages de plusieurs files d’attente à l’aide du caractère générique (*). Lorsque vous utilisez le paramètre File d’attente, utilisez le format<>\<d’identité de file d’attente File d’attente File d’attente,> comme décrit dans la section « Identité de file d’attente » de cette rubrique.
Opérations de comparaison à utiliser lors du filtrage de files d'attente ou de messages
Lorsque vous créez une expression de filtre de file d’attente ou de message à l’aide du paramètre Filter , vous devez inclure un opérateur de comparaison pour que la valeur de la propriété corresponde. Le tableau suivant présente les opérateurs de comparaison que vous pouvez utiliser dans une expression de filtre, ainsi que le mode de fonctionnement de chacun d'eux. Quel que soit l'opérateur, les valeur comparées ne sont pas sensibles à la casse.
Opérateurs de comparaison
Opérateur | Fonction | Exemple de code dans l'environnement de ligne de commande |
---|---|---|
-eq |
Cet opérateur permet de spécifier que les résultats doivent correspondre précisément à la valeur de propriété indiquée dans l'expression. | Pour afficher la liste de toutes les files d'attente dont l'état est Nouvelle tentative :Get-Queue -Filter "Status -eq 'Retry'" Pour afficher la liste de tous les messages dont l'état est Nouvelle tentative : Get-Message -Filter "Status -eq 'Retry'" |
-ne |
Cet opérateur permet de spécifier que les résultats ne doivent pas correspondre à la valeur de propriété indiquée dans l'expression. | Pour afficher la liste de toutes les files d'attente dont l'état n'est pas Actif :Get-Queue -Filter "Status -ne 'Active'" Pour afficher la liste de tous les messages dont l'état n'est pas Actif : Get-Message -Filter "Status -ne 'Active'" |
-gt |
Cet opérateur est utilisé avec des propriétés dont la valeur est exprimée sous forme de nombre entier ou de date/heure. Les résultats du filtre incluent uniquement les files d'attente ou messages pour lesquels la valeur de la propriété spécifiée est supérieure à celle indiquée dans l'expression. | Pour afficher la liste des files d'attente contenant actuellement plus de 1 000 messages :Get-Queue -Filter "MessageCount -gt 1000" Pour afficher la liste des messages pour lesquels le nombre de tentatives est supérieur à 3 : Get-Message -Filter "RetryCount -gt 3" |
-ge |
Cet opérateur est utilisé avec des propriétés dont la valeur est exprimée sous forme de nombre entier ou de date/heure. Les résultats du filtre incluent uniquement les files d'attente ou les messages pour lesquels la valeur de la propriété spécifiée est supérieure ou égale à celle indiquée dans l'expression. | Pour afficher la liste des files d'attente contenant actuellement 1 000 messages ou davantage :Get-Queue -Filter "MessageCount -ge 1000" Pour afficher la liste des messages pour lesquels le nombre de tentatives est supérieur ou égal à 3 : Get-Message -Filter "RetryCount -ge 3" |
-lt |
Cet opérateur est utilisé avec des propriétés dont la valeur est exprimée sous forme de nombre entier ou de date/heure. Les résultats du filtre incluent uniquement les files d'attente ou messages pour lesquels la valeur de la propriété spécifiée est inférieure à celle indiquée dans l'expression. | Pour afficher la liste des files d'attente contenant actuellement moins de 1 000 messages :Get-Queue -Filter "MessageCount -lt 1000" Pour afficher la liste des messages pour lesquels le seuil de probabilité de courrier indésirable est inférieur à 6 : Get-Message -Filter "SCL -lt 6" |
-le |
Cet opérateur est utilisé avec des propriétés dont la valeur est exprimée sous forme de nombre entier ou de date/heure. Les résultats du filtre incluent uniquement les files d'attente ou les messages pour lesquels la valeur de la propriété spécifiée est inférieure ou égale à celle indiquée dans l'expression. | Pour afficher la liste des files d'attente contenant actuellement 1 000 messages ou moins :Get-Queue -Filter "MessageCount -le 1000" Pour afficher la liste des messages pour lesquels le seuil de probabilité de courrier indésirable est inférieur ou égal à 6 : Get-Message -Filter "SCL -le 6" |
-like |
Cet opérateur est utilisé avec les propriétés dont la valeur est exprimée sous forme de chaîne de texte. Les résultats du filtre incluent uniquement les files d'attente ou les messages pour lesquels la valeur de la propriété spécifiée contient la chaîne de texte indiquée dans l'expression. Vous pouvez inclure le caractère générique (*) dans une expression de type - qui est appliquée à un champ de chaîne de texte, mais pas avec un champ qui a le type d’énumération. | Pour afficher la liste des files d'attente de remise dont la destination est un domaine SMTP dont le nom se termine par Contoso.com :Get-Queue -Filter "Identity -like '*contoso.com'" Pour afficher la liste des messages dont l'objet contient le texte « payday loan » : Get-Messages -Filter "Subject -like '*payday loan*'" |
Vous pouvez spécifier un filtre qui évalue plusieurs expressions à l'aide de l'opérateur de comparaison -and. Pour figurer dans les résultats, les files d'attente ou les messages doivent répondre à toutes les conditions du filtre.
Cet exemple affiche la liste des files d'attente dont la destination est un domaine SMTP dont le nom de termine par Contoso.com et contenant actuellement plus de 500 messages.
Get-Queue -Filter "Identity -like '*contoso.com*' -and MessageCount -gt 500"
Cet exemple affiche la liste des messages envoyés à partir d'une adresse de messagerie du domaine contoso.com, dont le seuil de probabilité de courrier indésirable est supérieur 5.
Get-Message -Filter "FromAddress -like '*Contoso.com*' -and SCL -gt 5"
Paramètres de pagination avancée
En fonction du flux des messages, les requêtes sur les files d'attente et les messages peuvent renvoyer un ensemble d'objets conséquent. Les paramètres de pagination avancée permettent de surveiller le mode de récupération et d'affichage des résultats des requêtes.
Lorsque vous utilisez l'environnement de ligne de commande pour afficher des files d'attente et les messages qu'elles contiennent, votre requête récupère une page d'informations à la fois. Les paramètres de pagination avancée surveillent la taille du jeu de résultats et peuvent également être utilisés pour trier les résultats. Tous les paramètres de pagination avancée sont facultatifs et peuvent être associés à l'un des jeux de paramètres pouvant être utilisés avec les cmdlets Get-Queue et Get-Message. Si vous ne spécifiez aucun paramètre de pagination avancée, la requête renvoie les résultats dans l'ordre d'identité croissant.
Par défaut, quand un ordre de tri est spécifié, la propriété d'identité de message est toujours incluse et triée dans l'ordre croissant. Il s'agit de la relation de tri par défaut. La propriété d'identité de message est incluse, car les autres propriétés pouvant être incluses dans un ordre de tri ne sont pas uniques. En incluant explicitement la propriété d'identité de message dans l'ordre de tri, vous pouvez spécifier que les résultats affichent l'identité du message triée en ordre décroissant.
Vous pouvez utiliser les paramètres BookmarkIndex et BookmarkObject pour marquer une position dans le jeu de résultats trié. Si l'objet signet n'existe plus lors de la récupération de la page suivante de résultats, la relation de tri par défaut vérifie que le jeu de résultats commence avec l'objet le plus proche du signet. L'objet le plus proche dépend de l'ordre de tri spécifié.
Le tableau suivant décrit les paramètres de pagination avancée.
Paramètre | Description |
---|---|
BookmarkIndex | Ce paramètre spécifie la position, dans le jeu de résultats, à partir de laquelle les résultats s'affichent. La valeur de ce paramètre est un index basé sur 1 dans le jeu total de résultats. Si la valeur est inférieure ou égale à zéro, la première page de résultats complète est retournée. Si la valeur est définie sur Int.MaxValue , la dernière page complète des résultats est retournée. |
BookmarkObject | Ce paramètre spécifie l'objet, dans le jeu de résultats, à partir duquel les résultats s'affichent. Si vous spécifiez un objet signet, il est utilisé comme point de départ de la recherche. Les lignes avant ou après cet objet, en fonction de la valeur du paramètre SearchForward , sont récupérées. Vous ne pouvez pas combiner le paramètre BookmarkObject et le paramètre BookmarkIndex dans une seule requête. |
IncludeBookmark | Ce paramètre spécifie si l'objet signet est inclus dans le jeu de résultats. Par défaut, la valeur est définie sur $true et l’objet bookmark est inclus. Vous pouvez exécuter une requête pour une taille de résultat limitée, puis spécifier le dernier élément de ce jeu de résultats comme le signet pour la prochaine requête. Dans ce cas, vous pouvez définir IncludeBookmark sur $false afin que l’objet ne soit pas inclus dans les deux jeux de résultats. |
ResultSize | Ce paramètre spécifie le nombre de résultats à afficher par page. Si aucune valeur n'est indiquée, la taille du résultat par défaut est de 1 000 objets. Exchange limite la taille du jeu de résultats à 250 000. |
ReturnPageInfo | Ce paramètre est un paramètre masqué. Il renvoie des informations sur le nombre total de résultats et l'index du premier objet de la page actuelle. La valeur par défaut est $false . |
SearchForward | Ce paramètre spécifie le sens de la recherche (avant ou arrière) dans le jeu de résultats. Ce paramètre n'affecte pas l'ordre dans lequel le jeu de résultats est renvoyé. Il détermine le sens de la recherche par rapport à l'index ou à l'objet signet. Si aucun index ou objet de signet n’est spécifié, le paramètre SearchForward détermine si la recherche commence à partir du premier ou du dernier objet dans le jeu de résultats. La valeur par défaut de ce paramètre est $true . Si ce paramètre est défini sur $true et qu’un signet est spécifié, la requête effectue une recherche vers l’avant à partir de ce signet. Si vous utilisez cette configuration et s'il n'y a aucun résultat au-delà du signet, la requête renvoie la dernière page complète de résultats. Si le paramètre SearchForward est défini sur $false et qu’un signet est spécifié, la requête effectue une recherche en arrière à partir de ce signet. Si vous utilisez cette configuration et s'il y a moins d'une page complète de résultats au-delà du signet, la requête renvoie la première page complète de résultats. |
SortOrder | Ce paramètre spécifie une série de propriétés de message utilisées pour contrôler l'ordre de tri du jeu de résultats. Les propriétés d'ordre de tri sont spécifiées dans l'ordre décroissant de priorité. Chaque propriété est séparée par une virgule et associée au signe + pour trier dans l'ordre croissant, ou au signe - pour trier dans l'ordre décroissant. Si aucun ordre de tri explicite n'est pas spécifié à l'aide de ce paramètre, les enregistrements correspondant à la requête sont affichés et triés par le champ d'identité pour le type d'objet concerné. Si aucun ordre de tri n'est spécifié explicitement, les résultats sont toujours triés dans l'ordre croissant des identités. |
L'exemple de code suivant montre l'utilisation des paramètres de pagination avancée dans une requête. Dans cet exemple, la commande se connecte au serveur spécifié et récupère un jeu de résultats contenant 500 objets. Les résultats affichés sont triés d'abord dans l'ordre croissant des adresses des expéditeurs, puis dans l'ordre décroissant des tailles de message.
Get-Message -Server mailbox01.contoso.com -ResultSize 500 -SortOrder +FromAddress,-Size
Si vous voulez afficher les pages successives, vous pouvez définir un signet pour le dernier objet récupéré dans un jeu de résultats et exécuter une requête supplémentaire. Pour exécuter cette procédure, vous devez utiliser les fonctionnalités de script de l'environnement de ligne de commande.
L'exemple suivant utilise des scripts pour récupérer la première page de résultats, définit l'objet signet, exclut l'objet signet du jeu de résultats, puis récupère les 500 objets suivants sur le serveur spécifié.
Ouvrez l'environnement de ligne de commande, puis entrez la commande suivante pour récupérer la première page de résultats.
$Results=Get-message -Server mailbox01.contoso.com -ResultSize 500 -SortOrder +FromAddress,-Size
Pour définir l'objet signet, entrez la commande suivante pour enregistrer le dernier élément de la première page dans une variable.
$temp=$results[$results.length-1]
Pour récupérer les 500 objets suivants sur le serveur spécifié en excluant l'objet signet, entrez la commande suivante.
Get-message -Server mailbox01.contoso.com -BookmarkObject:$temp -IncludeBookmark $False -ResultSize 500 -SortOrder +FromAddress,-Size