Get-Recipient
Cette cmdlet est disponible dans Exchange sur site et dans le service cloud. 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).
Remarque : Dans Exchange Online PowerShell, nous vous recommandons d’utiliser l’applet de commande Get-EXORecipient au lieu de cette applet de commande. Pour plus d'informations, reportez-vous à Connexion à Exchange Online.
Dans les environnements cloud, pour retourner Groupes Microsoft 365, vous devez utiliser le paramètre RecipientTypeDetails avec la valeur GroupMailbox.
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
Syntax
Get-Recipient
[-Anr <String>]
[-AuthenticationType <AuthenticationType>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Capabilities <MultiValuedProperty>]
[-Database <DatabaseIdParameter>]
[-Properties <String[]>]
[-IncludeSoftDeletedRecipients]
[<CommonParameters>]Get-Recipient
[[-Identity] <RecipientIdParameter>]
[-AuthenticationType <AuthenticationType>]
[-BookmarkDisplayName <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IncludeBookmarkObject <Boolean>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Capabilities <MultiValuedProperty>]
[-Properties <String[]>]
[-IncludeSoftDeletedRecipients]
[<CommonParameters>]Get-Recipient
[-Database <DatabaseIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-Properties <String[]>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-IncludeSoftDeletedRecipients] [<CommonParameters>]
[<CommonParameters>]Get-Recipient
[-RecipientPreviewFilter <String>]
[-AuthenticationType <AuthenticationType>]
[-Capabilities <MultiValuedProperty>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-Properties <String[]>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]Description
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 cette rubrique répertorie tous les paramètres de cette cmdlet, 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 rechercher les autorisations requises pour exécuter une cmdlet ou un paramètre dans votre organisation, voir Find the permissions required to run any Exchange cmdlet.
Exemples
Exemple 1
Get-Recipient -ResultSize unlimitedCet exemple récupère la liste récapitulative de tous les destinataires de votre organisation.
Exemple 2
Get-Recipient -Identity "Marketing Department" | Format-ListCet exemple retourne des informations détaillées pour le destinataire nommé Service marketing.
Exemple 3
Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,NameCet 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.
Paramètres
-Anr
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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-AuthenticationType
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Le paramètre AuthenticationType spécifie le destinataire par type d’authentification. Utilisez l'une des valeurs suivantes :
- Fédérés
- Géré
| Type: | AuthenticationType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Security & Compliance, Exchange Online Protection |
-BookmarkDisplayName
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Capabilities
Ce paramètre est disponible uniquement dans le service basé sur le cloud.
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Security & Compliance, Exchange Online Protection |
-Credential
Ce paramètre est disponible uniquement dans Exchange 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.
Une valeur pour ce paramètre nécessite l’applet de commande Get-Credential. Pour interrompre la commande et recevoir une invite à entrer les informations d’identification, utilisez la valeur (Get-Credential). Sinon, avant d’exécuter cette commande, stockez les informations d’identification dans une variable (par exemple, $cred = Get-Credential), puis utilisez le nom de cette variable name ($cred) pour ce paramètre. Pour plus d’informations, voir Get-Credential.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Database
Ce paramètre est disponible uniquement dans Exchange sur site.
Le paramètre Database retourne tous les destinataires stockés dans la base de données de boîtes aux lettres spécifiée. Vous pouvez utiliser n’importe quelle valeur qui identifie la base de données de manière unique. Par exemple :
- Nom
- Nom unique (DN)
- GUID
| Type: | DatabaseIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
Ce paramètre est disponible uniquement dans Exchange 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 ».
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
Le paramètre Filter utilise la syntaxe OPATH pour filtrer les résultats en fonction des propriétés et valeurs spécifiées. Les critères de recherche utilisent la syntaxe "Property -ComparisonOperator 'Value'".
- Placez l’ensemble du filtre OPATH entre guillemets doubles « ». Si le filtre contient des valeurs système (par exemple,
$true,$falseou$null), utilisez plutôt des guillemets simples « ». Bien que ce paramètre soit une chaîne (et non un bloc système), vous pouvez également utiliser des accolades { }, mais uniquement si le filtre ne contient pas de variables. - Property est une propriété filtrable. Pour plus d’informations sur les propriétés filtrables dans Exchange Server et Exchange Online, consultez Propriétés filtrables pour le paramètre Filter.
- ComparisonOperator est un opérateur de comparaison OPATH (par exemple
-eqpour des valeurs égales et-likepour la comparaison de chaînes). Pour plus d'informations sur les opérateurs de comparaison, reportez-vous à la rubrique about_Comparison_Operators. - Value est la valeur de propriété à rechercher. Placez les valeurs de texte et les variables entre guillemets simples (
'Value'ou'$Variable'). Si une valeur de variable contient des guillemets simples, vous devez identifier (échappement) les guillemets simples pour développer la variable correctement. Par exemple, au lieu de'$User', utilisez'$($User -Replace "'","''")'. Ne placez pas entre guillemets les entiers ou les valeurs système (par exemple, utilisez500,$true,$falseou$nullà la place).
Vous pouvez chaîner plusieurs critères de recherche à l’aide des opérateurs logiques -and et -or. Par exemple : "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".
Pour plus d’informations sur les filtres OPATH dans Exchange, consultez Informations supplémentaires sur la syntaxe OPATH.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Identity
Le paramètre Identity spécifie l’objet destinataire à afficher. Vous pouvez utiliser une valeur quelconque qui identifie le destinataire. Par exemple :
- Nom
- Alias
- Nom unique
- Nom unique
- Nom unique canonique
- GUID
| Type: | RecipientIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IgnoreDefaultScope
Ce paramètre est disponible uniquement dans Exchange sur site.
Le commutateur IgnoreDefaultScope indique à la commande d’ignorer le paramètre d’étendue du destinataire par défaut pour la session Exchange PowerShell et d’utiliser la forêt entière comme étendue. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Ce commutateur permet à la commande d’accéder aux objets Active Directory qui ne sont pas actuellement disponibles dans l’étendue par défaut, mais introduit également 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 pas utiliser le paramètre DomainController. La commande utilise automatiquement un serveur de catalogue global approprié.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IncludeBookmarkObject
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IncludeSoftDeletedRecipients
Le commutateur IncludeSoftDeletedRecipients spécifie s’il faut inclure des destinataires supprimés de manière réversible dans les résultats. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Comme leur nom l’indique, les destinataires supprimés de manière réversible sont encore récupérables.
Remarque : utilisez ce commutateur avec les paramètres Identity ou RecipientTypeDetails pour obtenir softDeletedRecipients.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-OrganizationalUnit
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. L’entrée valide pour ce paramètre est une unité d’organisation (UO) ou un domaine retourné par l’applet de commande 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
- Nom unique
- GUID
| Type: | OrganizationalUnitIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Properties
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-PropertySet
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | PropertySet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ReadFromDomainController
Ce paramètre est disponible uniquement dans Exchange 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. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
La commande : Set-AdServerSettings -ViewEntireForest $true pour inclure tous les objets dans la forêt, nécessite le commutateur ReadFromDomainController. Sinon, la commande peut utiliser un catalogue global qui contient des informations obsolètes. En outre, vous devrez peut-être exécuter plusieurs itérations de la commande avec le commutateur ReadFromDomainController pour obtenir les informations.
Par défaut, l’étendue du destinataire est définie sur le domaine qui héberge vos serveurs Exchange.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RecipientPreviewFilter
Le paramètre RecipientPreviewFilter teste un filtre de destinataires que vous utiliseriez dans un groupe de distribution dynamique, une liste d’adresses ou une stratégie d’adresse e-mail. Ce paramètre utilise la syntaxe de filtre LDAP.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RecipientType
Le paramètre RecipientType filtre les résultats en fonction du type de destinataire spécifié. Les valeurs valides sont les suivantes :
- DynamicDistributionGroup
- MailContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- UserMailbox
Vous pouvez spécifier plusieurs valeurs séparées par des virgules.
| Type: | RecipientType[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RecipientTypeDetails
Le paramètre RecipientTypeDetails filtre les résultats en fonction du sous-type de destinataire spécifié. Les valeurs valides sont les suivantes :
- DiscoveryMailbox
- DynamicDistributionGroup
- ÉquipementMailbox
- GroupMailbox (Exchange 2013 ou version ultérieure et cloud)
- GuestMailUser (Exchange 2016 ou version ultérieure et cloud)
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox (Exchange 2013 ou version ultérieure et cloud)
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox (Exchange 2013 ou version ultérieure et cloud)
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox (Exchange 2013 ou version ultérieure et cloud)
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox (Exchange 2016 ou version ultérieure et cloud)
- SharedMailbox
- SharedWithMailUser (cloud uniquement)
- TeamMailbox (Exchange 2013 ou version ultérieure et cloud)
- UserMailbox
Vous pouvez spécifier plusieurs valeurs séparées par des virgules.
La valeur du paramètre RecipientType affecte les valeurs utilisables pour ce paramètre. Par exemple, si vous utilisez la valeur MailContact du paramètre RecipientType, vous ne pouvez pas utiliser la valeur UserMailbox pour ce paramètre. Vous recevrez le message d’erreur suivant : None of the specified RecipientTypeDetails are included in any specified recipient type.
| Type: | RecipientTypeDetails[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ResultSize
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.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-SortBy
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é que vous triez, vous pouvez ajouter la commande avec | Format-Table -Auto Property1,Property2,...PropertyX. pour créer une vue qui contient 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 :
- Nom
- DisplayName
- Alias
- Ville
- FirstName
- LastName
- Office
- ServerLegacyDN
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
Entrées
Input types
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.
Sorties
Output types
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.