Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

Get-Recipient

 

S’applique à :Exchange Online, Exchange Online Protection, Exchange Server 2016, Office 365 Security & Compliance Center

Dernière rubrique modifiée :2017-07-12

Cette cmdlet est disponible dans Exchange Server 2016 sur site et dans le service en nuage. Certains paramètres peuvent être propres à un environnement ou à un autre.

La cmdlet Get-Recipient permet d’afficher les objets destinataire existants dans votre organisation. Cette cmdlet renvoie tous les objets à extension messagerie (par exemple, boîtes aux lettres, utilisateurs de messagerie, contacts de messagerie et groupes de distribution).

noteRemarque :
Dans les environnements de cloud pour retourner Groupes Office 365, vous devez utiliser leRecipientTypeDetailsparamètre avec la valeurGroupMailbox.

Pour plus d'informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir SyntaxeSyntaxe de cmdlet Exchange.

Get-Recipient [-BookmarkDisplayName <String>] [-Identity <RecipientIdParameter>] [-IncludeBookmarkObject <$true | $false>] <COMMON PARAMETERS>

Get-Recipient [-RecipientPreviewFilter <String>] <COMMON PARAMETERS>

Get-Recipient [-Database <DatabaseIdParameter>] <COMMON PARAMETERS>

Get-Recipient [-Anr <String>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-AccountPartition <AccountPartitionIdParameter>] [-AuthenticationType <Managed | Federated>] [-Capabilities <MultiValuedProperty>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-IncludeSoftDeletedRecipients <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-Properties <String[]>] [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Cet exemple récupère la liste récapitulative de tous les destinataires de votre organisation.

Get-Recipient -ResultSize unlimited

Cet exemple renvoie des informations détaillées sur le destinataire nommé Marketing Department.

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

Cet exemple récupère des informations sur tous les contacts de messagerie de votre organisation et les trie en fonction de leur lieu de travail.

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

La cmdlet Get-Recipient peut ne pas renvoyer toutes les propriétés spécifiques de l’objet pour un destinataire. Pour afficher les propriétés spécifiques de l’objet pour un destinataire, vous devez utiliser la cmdlet correspondante en fonction du type d’objet (par exemple, Get-Mailbox, Get-MailUser ou Get-DistributionGroup).

Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que tous les paramètres de cette cmdlet soient répertoriés dans cette rubrique, il est possible que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous ont été attribuées. Pour voir les autorisations qui vous sont nécessaires, voir la section « Autorisations de configuration des destinataires » dans la rubrique Autorisations des destinataires.

 

Paramètre Obligatoire Type Description

AccountPartition

Facultatif

Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter

Ce paramètre est réservé à l’usage interne chez Microsoft.

Anr

Facultatif

System.String

Le paramètre Anr spécifie une chaîne sur laquelle une recherche de résolution de noms ANR (Ambiguous Name Resolution) peut porter. 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 :

  • CommonName (CN)

  • DisplayName

  • FirstName

  • LastName

  • Alias

AuthenticationType

Facultatif

Microsoft.Exchange.Data.Directory.AuthenticationType

Ce paramètre est disponible uniquement dans le service informatique.

Le paramètre AuthenticationType spécifie le destinataire par type d'authentification. Utilisez l'une des valeurs suivantes :

  • Federated

  • Managed

BookmarkDisplayName

Facultatif

System.String

Ce paramètre est réservé à l’usage interne chez Microsoft.

Capabilities

Facultatif

Microsoft.Exchange.Data.MultiValuedProperty

Ce paramètre est réservé à l’usage interne chez Microsoft.

Credential

Facultatif

System.Management.Automation.PSCredential

Ce paramètre est disponible uniquement dans Exchange 2016 sur site.

Le paramètre Credential spécifie le nom d’utilisateur et le mot de passe utilisés pour exécuter cette commande. En règle générale, vous utilisez ce paramètre dans des scripts ou lorsque vous avez besoin de fournir différentes informations d’identification qui ont les autorisations requises.

Ce paramètre requiert la création et la transmission d’un objet d’informations d’identification. Cet objet d’informations d’identification est créé à l’aide de la cmdlet Get-Credential. Pour plus d’informations, voir Get-Credential.

Database

Facultatif

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

Ce paramètre est disponible uniquement dans Exchange 2016 sur site.

Le paramètre Database spécifie une base de données de boîtes aux lettres. Utilisez ce paramètre pour renvoyer tous les destinataires stockés dans une base de données de boîtes aux lettres spécifique. Utilisez la propriété Name de la base de données de boîtes aux lettres comme valeur pour ce paramètre.

DomainController

Facultatif

Microsoft.Exchange.Data.Fqdn

Ce paramètre est disponible uniquement dans Exchange 2016 sur site.

Le paramètre DomainController spécifie le contrôleur de domaine qui est utilisé par cette cmdlet pour lire ou écrire les données dans Active Directory. Vous identifiez le contrôleur de domaine par son nom de domaine complet (FQDN). Par exemple : dc01.contoso.com.

Filter

Facultatif

System.String

Le paramètre Filter indique le filtre OPath utilisé pour filtrer les destinataires.

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 spécifie l’objet destinataire à afficher. Vous pouvez utiliser une valeur quelconque qui identifie le destinataire.

Par exemple :

  • Nom

  • Nom complet

  • Alias

  • Nom unique

  • Nom unique canonique

  • Adresse de messagerie

  • GUID

IgnoreDefaultScope

Facultatif

System.Management.Automation.SwitchParameter

Ce paramètre est disponible uniquement dans Exchange 2016 sur site.

Le commutateur IgnoreDefaultScope donne pour instruction à la commande d’ignorer le paramétrage de l’étendue du destinataire par défaut pour la session Exchange Management Shell et d’utiliser l’ensemble de la forêt comme étendue. Cela permet à la commande d’accéder à des objets Active Directory ne figurant pas actuellement dans l’étendue par défaut.

L’utilisation du commutateur IgnoreDefaultScope introduit les restrictions suivantes :

  • Vous ne pouvez pas utiliser le paramètre DomainController. La commande utilise automatiquement un serveur de catalogue global approprié.

  • Vous ne pouvez utiliser que le nom unique pour le paramètre Identity. D'autres formes d'identification, telles qu'un alias ou un GUID, ne sont pas acceptées.

IncludeBookmarkObject

Facultatif

System.Boolean

Ce paramètre est réservé à l’usage interne chez Microsoft.

IncludeSoftDeletedRecipients

Facultatif

System.Management.Automation.SwitchParameter

The IncludeSoftDeletedRecipients commutateur spécifie s’il faut inclure des destinataires supprimés paramétrés dans les résultats. Vous n’avez pas besoin de spécifier de valeur avec ce commutateur.

Ce commutateur est requis pour renvoyer les destinataires supprimés.

Les destinataires supprimés sont destinataires supprimés qui sont encore restaurables.

Organization

Facultatif

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

Ce paramètre est réservé à l’usage interne chez Microsoft.

OrganizationalUnit

Facultatif

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

Le paramètre OrganizationalUnit filtre les résultats en fonction de l’emplacement de l’objet dans Active Directory. Seuls les objets qui existent dans l’emplacement spécifié sont renvoyés. Une entrée valide pour ce paramètre est une unité d’organisation (UO) ou un domaine qui est visible à l’aide de la cmdlet Get-OrganizationalUnit. Vous pouvez utiliser n’importe quelle valeur qui identifie de façon unique l’unité d’organisation ou le domaine. Par exemple :

  • Nom

  • Nom canonique

  • Nom unique

  • GUID

Properties

Facultatif

System.String[]

Ce paramètre est réservé à l’usage interne chez Microsoft.

PropertySet

Facultatif

Microsoft.Exchange.Data.Directory.Management.PropertySet

Ce paramètre est réservé à l’usage interne chez Microsoft.

ReadFromDomainController

Facultatif

System.Management.Automation.SwitchParameter

Ce paramètre est disponible uniquement dans Exchange 2016 sur site.

Le commutateur ReadFromDomainController spécifie quelles informations doivent être lues à partir d’un contrôleur de domaine dans le domaine de l’utilisateur. Si vous exécutez la commande Set-AdServerSettings -ViewEntireForest $true pour inclure tous les objets dans la forêt et que vous n'utilisez pas le commutateur ReadFromDomainController, vous n'obtiendrez peut-être pas des informations actualisées. Si vous utilisez le commutateur ReadFromDomainController, plusieurs lectures seront peut-être nécessaires avant d'obtenir l'information. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

noteRemarque :
Par défaut, la portée du destinataire est définie sur le domaine qui héberge vos serveurs Exchange.

RecipientPreviewFilter

Facultatif

System.String

Le paramètre RecipientPreviewFilter permet de spécifier un filtre des destinataires définissant les destinataires renvoyés par cette commande. Vous pouvez créer un filtre des destinataires personnalisé pour un groupe de distribution dynamique, une liste d'adresses ou une stratégie d'adresse de messagerie. Pour vérifier que le filtre des destinataires spécifié renverra les destinataires souhaités, vous pouvez transmettre le filtre OPATH spécifié dans la propriété RecipientFilter pour ce groupe de distribution dynamique, cette liste d'adresses ou cette stratégie d'adresse de messagerie au paramètre RecipientPreviewFilter et prévisualiser la liste des destinataires.

RecipientType

Facultatif

Microsoft.Exchange.Data.Directory.Recipient.RecipientType[]

Le paramètre RecipientType filtre les résultats par le type de destinataire spécifié. Les valeurs valides sont :

  • DynamicDistributionGroup

  • MailContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • UserMailbox

Vous pouvez spécifier plusieurs valeurs séparées par des virgules.

RecipientTypeDetails

Facultatif

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

La RecipientTypeDetails paramètre filtre les résultats par le sous-type de destinataire spécifié. Les valeurs valides sont :

  • DiscoveryMailbox

  • DynamicDistributionGroup

  • EquipmentMailbox

  • GroupMailbox

  • GuestMailUser

  • LegacyMailbox

  • LinkedMailbox

  • LinkedRoomMailbox

  • MailContact

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • PublicFolderMailbox

  • RemoteEquipmentMailbox

  • RemoteRoomMailbox

  • RemoteSharedMailbox

  • RemoteTeamMailbox

  • RemoteUserMailbox

  • RoomList

  • RoomMailbox

  • SchedulingMailbox

  • SharedMailbox

  • TeamMailbox

  • UserMailbox

Vous pouvez spécifier plusieurs valeurs séparées par des virgules.

La valeur du paramètre RecipientType affecte les valeurs que vous pouvez utiliser pour ce paramètre. Par exemple, si vous utilisez la valeur de RecipientTypeMailContact, vous ne pouvez pas utiliser la valeur UserMailbox pour ce paramètre. Vous recevrez l’erreur : None of the specified RecipientTypeDetails are included in any specified recipient type.

ResultSize

Facultatif

Microsoft.Exchange.Data.Unlimited

Le paramètre ResultSize spécifie le nombre maximal de résultats à renvoyer. Pour retourner toutes les demandes correspondant à la requête, 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 la propriété utilisée pour trier les résultats. Vous ne pouvez trier que sur une propriété à la fois. Les résultats sont triés selon un ordre croissant.

Si l’affichage par défaut n’inclut pas la propriété sur laquelle vous faites le tri, vous pouvez ajouter la commande avec | Format-Table -Auto <Property1>,<Property2>..., afin de créer un affichage contenant toutes les propriétés que vous souhaitez voir. Les caractères génériques (*) sont pris en charge dans les noms de propriété.

Vous pouvez filtrer selon les propriétés suivantes :

  • name

  • DisplayName

  • Alias

  • City

  • FirstName

  • LastName

  • Office

  • ServerLegacyDN

Pour visualiser les types d’entrées acceptés par cette cmdlet, consultez la rubrique Types d’entrée et de sortie de la cmdlet d’Exchange Management Shell. Si le champ Type d’entrée pour une cmdlet est vide, la cmdlet n’accepte pas les données d’entrée.

Pour visualiser les types de retours, également appelés types de sorties, acceptés par cette cmdlet, consultez la rubrique Types d’entrée et de sortie de la cmdlet d’Exchange Management Shell. Si le champ Type de sortie est vide, la cmdlet ne renvoie pas de données.

 
Afficher: