Get-EXORecipient
Cette applet de commande est disponible uniquement dans le module PowerShell Exchange Online. Pour plus d’informations, consultez À propos du module PowerShell Exchange Online.
Utilisez l’applet de commande Get-EXORecipient pour afficher les objets destinataires existants dans votre organization. Cette cmdlet renvoie tous les objets à extension messagerie (par exemple, boîtes aux lettres, utilisateurs de messagerie, contacts de messagerie et groupes de distribution).
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
Syntaxe
Get-EXORecipient
[[-Identity] <String>]
[-ExternalDirectoryObjectId <Guid>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-PrimarySmtpAddress <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-UserPrincipalName <String>]
[<CommonParameters>]Get-EXORecipient
[-Anr <String>]
[-Filter <String>]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-RecipientPreviewFilter <String>]
[-RecipientType <String[]>]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[<CommonParameters>]Description
Get-EXORecipient applet de commande peut être utilisée pour afficher les objets destinataires existants dans votre organization. Cette cmdlet renvoie tous les objets à extension messagerie (par exemple, boîtes aux lettres, utilisateurs de messagerie, contacts de messagerie et groupes de distribution).
Exemples
Exemple 1
Get-EXORecipient -ResultSize 100Cet exemple retourne les 100 premiers objets destinataires dans l’ordre trié par nom.
Exemple 2
Get-EXORecipient -Identity john@contosot.comCet exemple retourne les détails de l’attribut de destinataire pour l’utilisateur john@contoso.com
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
Vous ne pouvez pas utiliser ce paramètre avec les paramètres ExternalDirectoryObjectId, Identity, PrimarySmtpAddress ou UserPrincipalName.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-ExternalDirectoryObjectId
Le paramètre ExternalDirectoryObjectId identifie le destinataire que vous souhaitez afficher par objectId dans Microsoft Entra ID.
Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, Identity, PrimarySmtpAddress ou UserPrincipalName.
| Type: | Guid |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-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, consultez Jeux de propriétés Get-EXORecipient et Propriétés filtrables pour le paramètre Filter.
- ComparisonOperator est un opérateur de comparaison OPATH (par exemple
-eq, pour 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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-Identity
Le paramètre Identity spécifie l’objet destinataire à afficher. Pour des performances optimales, nous vous recommandons d’utiliser les valeurs suivantes pour identifier le destinataire :
- Identifiant utilisateur ou nom d’utilisateur principal (UPN)
- GUID
Sinon, vous pouvez utiliser n’importe quelle valeur qui identifie de manière unique le destinataire. Par exemple :
- Nom
- Alias
- Nom unique
- Domaine\Nom d’utilisateur
- Adresse électronique
- LegacyExchangeDN
- SamAccountName
Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.
| Type: | String |
| Position: | 0 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-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.
| Type: | SwitchParameter |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-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. 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
- Nom unique
- GUID
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-PrimarySmtpAddress
PrimarySmtpAddress identifie le destinataire que vous souhaitez afficher par adresse e-mail SMTP principale (par exemple, navin@contoso.com).
Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, ExternalDirectoryObjectId, Identity ou UserPrincipalName.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-Properties
Le paramètre Properties spécifie les propriétés retournées dans la sortie de cette applet de commande. Vous pouvez spécifier plusieurs valeurs séparées par des virgules.
Pour plus d’informations sur les propriétés disponibles, consultez Jeux de propriétés Get-EXORecipient.
| Type: | String[] |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-PropertySets
Le paramètre PropertySets spécifie un regroupement logique des propriétés retournées dans la sortie de cette applet de commande. Les valeurs valides sont les suivantes :
- Minimum (il s’agit de la valeur par défaut)
- Archiver
- Personnalisé
- MailboxMove
- Stratégie
Pour plus d’informations sur les propriétés incluses dans chaque jeu de propriétés, consultez Jeux de propriétés Get-EXORecipient.
| Type: | PropertySet[] |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-RecipientPreviewFilter
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-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: | String[] |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-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
- GuestMailUser
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox
- RemoteUserMailbox
- RoomList
- RoomMailbox
- PlanningMailbox
- SharedMailbox
- SharedWithMailUser
- TeamMailbox
- 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: | String[] |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-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 |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | False |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |
-UserPrincipalName
Le paramètre UserPrincipalName identifie le destinataire que vous souhaitez afficher par UPN (par exemple, navin@contoso.onmicrosoft.com).
Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, ExternalDirectoryObjectId, Identity ou PrimarySmtpAddress.
| Type: | String |
| Position: | Named |
| Valeur par défaut: | None |
| Obligatoire: | False |
| Accepter l'entrée de pipeline: | True |
| Accepter les caractères génériques: | False |
| S’applique à: | Exchange Online |