Get-Recipient (RTM)
S’applique à : Exchange Server 2007
Dernière rubrique modifiée : 2008-04-16
La cmdlet Get-Recipient permet de retourner la liste des objets destinataire du service d'annuaire Active Directory.
Syntaxe
get-Recipient [-Identity <RecipientIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
get-Recipient [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
Description détaillée
La cmdlet Get-Recipient extrait les attributs du destinataire spécifié. Aucun paramètre n'est obligatoire. Si la cmdlet est exécutée sans paramètre, une liste complète de destinataires pour l'organisation est retournée.
Pour exécuter la cmdlet Get-Recipient, vous devez utiliser un compte auquel a été délégué :
- le rôle Administrateur Affichage seul d'Exchange.
Pour plus d'informations sur les autorisations, la délégation de rôles et les droits requis pour administrer Exchange Server 2007, consultez la rubrique Considérations relatives aux autorisations.
Paramètres
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
Anr |
Facultatif |
System.String |
Le paramètre Anr spécifie une chaîne sur laquelle effectuer une recherche de résolution de nom ambigu (ANR). Vous pouvez spécifier une chaîne partielle et rechercher des objets ayant un attribut correspondant à cette chaîne. Les attributs par défaut recherchés sont :
|
Credential |
Facultatif |
System.Management.Automation.PSCredential |
Le paramètre Credential spécifie le nom et le mot de passe d'utilisateur à utiliser pour accéder à Active Directory. En cas d'utilisation du paramètre Credential, la commande vous invite à taper le mot de passe du compte avant de continuer. |
DomainController |
Facultatif |
Microsoft.Exchange.Data.Fqdn |
Pour spécifier le nom de domaine complet (FQDN) du contrôleur de domaine qui écrit ce changement de configuration dans Active Directory, incluez le paramètre DomainController dans la commande. |
Filter |
Facultatif |
System.String |
Le paramètre Filter permet de spécifier un ou plusieurs attributs utilisés pour limiter le nombre de destinataires renvoyés par la requête. Ce paramètre ne peut pas être utilisé conjointement avec le paramètre Identity ou le paramètre Anr. Pour plus d'informations sur les propriétés filtrables, consultez la rubrique Propriétés filtrables pour le paramètre -Filter. |
Identity |
Facultatif |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
Le paramètre Identity identifie le destinataire. Vous pouvez utiliser l'une des valeurs suivantes :
|
OrganizationalUnit |
Facultatif |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
Le paramètre OrganizationalUnit spécifie une unité d'organisation (UO) ou un nom de domaine canonique et est utilisé pour limiter les résultats. Si vous utilisez ce paramètre, vous n'obtenez que des destinataires dans le conteneur que vous spécifiez. Par exemple :
|
ReadFromDomainController |
Facultatif |
System.Management.Automation.SwitchParameter |
Le paramètre ReadFromDomainController spécifie que les informations utilisateur sont lues à partir d'un contrôleur de domaine dans le domaine de l'utilisateur. Si vous définissez la portée du destinataire pour inclure tous les destinataires de la forêt et si vous n'utilisez pas ce paramètre, il est possible que les informations utilisateur soient lues à partir d'un catalogue global avec des informations obsolètes. Si vous utilisez ce paramètre, plusieurs lectures peuvent être nécessaires pour obtenir les informations. > [!Note] > Par défaut, la portée du destinataire est définie sur le domaine qui héberge vos serveurs Exchange. |
RecipientType |
Facultatif |
Microsoft.Exchange.Data.Directory.Recipient.RecipientType[] |
Le paramètre RecipientType est un filtre permettant de spécifier le type de destinataire à inclure dans la liste d'adresses. Vous pouvez utiliser un ou plusieurs des types suivants :
|
RecipientTypeDetails |
Facultatif |
Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[] |
Le paramètre RecipientTypeDetails spécifie le type des destinataires renvoyés. Les types de destinataires dans Microsoft Exchange Server 2007 sont divisés en types et sous-types de destinataires. Chaque type de destinataire contient toutes les propriétés de tous les sous-types. Par exemple, le type UserMailbox représente un compte d'utilisateur dans Active Directory avec une boîte aux lettres associée. Comme il y a plusieurs types de boîtes aux lettres, chaque type est identifié par le paramètre RecipientTypeDetails. Par exemple, une boîte aux lettres de salle de conférence a le paramètre RecipientTypeDetails défini sur ConferenceRoomMailbox, tandis qu'une boîte aux lettres d'utilisateur a le paramètre RecipientTypeDetails défini sur UserMailbox. Pour cette commande, les détails de type de destinataire disponible sont les suivants :
|
ResultSize |
Facultatif |
Microsoft.Exchange.Data.Unlimited |
Le paramètre ResultSize spécifie le nombre maximal de résultats à retourner. Pour retourner tous les destinataires correspondant au filtre, utilisez « unlimited » comme valeur pour ce paramètre. La valeur par défaut est 1000. |
SortBy |
Facultatif |
System.String |
Le paramètre SortBy spécifie l'attribut utilisé pour trier les résultats. Vous ne pouvez trier que sur un attribut à la fois. Vous pouvez trier sur les attributs suivants :
Les résultats sont triés en ordre croissant. |
Types d'entrées
Types de retours
Erreurs
Erreur | Description |
---|---|
|
|
Exceptions
Exceptions | Description |
---|---|
|
|
Exemple
Le premier exemple montre comment obtenir des informations sur tous les destinataires au sein de votre organisation.
Le deuxième exemple montre comment obtenir des informations sur tous les contacts au sein de votre organisation et les trier par nom.
Get-Recipient -ResultSize unlimited
Get-Recipient -RecipientType DynamicDistributionGroup -SortBy Name