Get-EXOMailbox
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-EXOMailbox pour afficher les attributs et les objets de boîte aux lettres, remplir les pages de propriétés ou fournir des informations de boîte aux lettres à d’autres tâches.
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-EXOMailbox
[[-Identity] <String>]
[-Archive]
[-Async]
[-ExternalDirectoryObjectId <Guid>]
[-Filter <String>]
[-GroupMailbox]
[-InactiveMailboxOnly]
[-IncludeInactiveMailbox]
[-MailboxPlan <String>]
[-Migration]
[-OrganizationalUnit <String>]
[-PrimarySmtpAddress <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-PublicFolder]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-SoftDeletedMailbox]
[-UserPrincipalName <String>]
[<CommonParameters>]Get-EXOMailbox
[-Anr <String>]
[-Archive]
[-Async]
[-Filter <String>]
[-GroupMailbox]
[-InactiveMailboxOnly]
[-IncludeInactiveMailbox]
[-MailboxPlan <String>]
[-Migration]
[-OrganizationalUnit <String>]
[-Properties <String[]>]
[-PropertySets <PropertySet[]>]
[-PublicFolder]
[-RecipientTypeDetails <String[]>]
[-ResultSize <Unlimited>]
[-SoftDeletedMailbox]
[<CommonParameters>]Description
Par défaut, cette applet de commande renvoie une liste récapitulative (un ensemble minimal de propriétés) de toutes les boîtes aux lettres de votre organisation.
Exemples
Exemple 1
Get-EXOMailbox -ResultSize unlimitedCet exemple retourne une liste récapitulative de toutes les boîtes aux lettres de l’organisation et inclut l’ensemble par défaut des propriétés de sortie minimales. Pour renvoyer des propriétés supplémentaires, utilisez les paramètres Properties et/ou PropertySets.
Exemple 2
Get-EXOMailbox -PropertySets ArchiveCet exemple montre comment renvoyer les propriétés définies dans le jeu de propriétés Archive. Pour obtenir la liste complète de ces propriétés, consultez Jeux de propriétés Get-EXOMailbox.
Exemple 3
Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,AuditCet exemple retourne une liste récapitulative de toutes les boîtes aux lettres de l’organisation et inclut les propriétés suivantes :
- Les propriétés des ensembles de propriétés Archive et Audit.
- Propriétés Name et DistinguishedName.
Exemple 4
Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,AliasCet exemple retourne les propriétés spécifiées pour la boîte aux lettres 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Archive
Le commutateur Archive filtre les résultats en fonction des boîtes aux lettres dont une archive est activée (seules les boîtes aux lettres contenant une boîte aux lettres d’archivage sont retournées). Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Async
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ExternalDirectoryObjectId
Le paramètre ExternalDirectoryObjectId identifie la boîte aux lettres que vous souhaitez afficher par ObjectId dans Azure Active Directory.
Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, Identity, PrimarySmtpAddress ou UserPrincipalName.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | 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 Ensembles de propriétés Get-EXOMailbox et 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 Online |
-GroupMailbox
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Identity
Le paramètre Identity spécifie la boîte aux lettres que vous souhaitez afficher. Pour des performances optimales, nous vous recommandons d’utiliser les valeurs suivantes :
- Identifiant utilisateur ou nom d’utilisateur principal (UPN)
- GUID
Sinon, vous pouvez utiliser n’importe quelle valeur qui identifie de manière unique la boîte aux lettres. 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-InactiveMailboxOnly
Le commutateur InactiveMailboxOnly spécifie s’il faut retourner uniquement les boîtes aux lettres inactives dans les résultats. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Une boîte aux lettres inactive est une boîte aux lettres qui est placée en conservation pour litige ou en conservation inaltérable avant d’être supprimée (récupérable). Le contenu d’une boîte aux lettres inactive est conservé jusqu’à la suppression de la conservation.
Pour retourner les boîtes aux lettres actives et les boîtes aux lettres inactives dans les résultats, n’utilisez pas ce commutateur. Utilisez plutôt le commutateur IncludeInactiveMailbox.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-IncludeInactiveMailbox
Le commutateur IncludeInactiveMailbox spécifie s’il faut inclure des boîtes aux lettres inactives dans les résultats. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Une boîte aux lettres inactive est une boîte aux lettres qui est placée en conservation pour litige ou en conservation inaltérable avant d’être supprimée (récupérable). Le contenu d’une boîte aux lettres inactive est conservé jusqu’à la suppression de la conservation.
Pour renvoyer uniquement les boîtes aux lettres inactives dans les résultats, n’utilisez pas ce commutateur. Utilisez plutôt le commutateur InactiveMailboxOnly.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-MailboxPlan
Le paramètre MailboxPlan filtre les résultats par plan de boîte aux lettres. Lorsque vous utilisez ce paramètre, seules les boîtes aux lettres auxquelles le plan de boîte aux lettres spécifié est affectée sont retournées dans les résultats. Vous pouvez utiliser n’importe quelle valeur qui permet d'identifier le plan de boîte aux lettres de manière unique. Par exemple :
- Nom
- Alias
- Nom complet
- Nom unique
- GUID
Un plan de boîte aux lettres spécifie les autorisations et les fonctionnalités disponibles pour un utilisateur de boîte aux lettres dans les organisations basées sur le cloud. Vous pouvez voir les plans de boîte aux lettres disponibles à l’aide de l’applet de commande Get-MailboxPlan.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Migration
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PrimarySmtpAddress
PrimarySmtpAddress identifie la boîte aux lettres 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | 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-EXOMailbox.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | 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 :
- tous
- Minimum (il s’agit de la valeur par défaut)
- AddressList
- Archiver
- Audit
- Personnalisé
- Remise
- Suspension
- Modération
- Move
- Stratégie
- PublicFolder
- Quota
- Ressource
- Rétention
- SCL
- SoftDelete
- StatisticsSeed
Vous pouvez spécifier plusieurs valeurs séparées par des virgules.
Pour plus d’informations sur les propriétés incluses dans chaque jeu de propriétés, consultez Jeux de propriétés Get-EXOMailbox.
| Type: | PropertySet[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PublicFolder
Ce paramètre est réservé à l’usage interne chez Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-RecipientTypeDetails
Le paramètre RecipientTypeDetails filtre les résultats en fonction du sous-type de boîte aux lettres spécifié. Les valeurs valides sont les suivantes :
- DiscoveryMailbox
- ÉquipementMailbox
- GroupMailbox
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- RoomMailbox
- PlanningMailbox
- SharedMailbox
- TeamMailbox
- UserMailbox
Vous pouvez spécifier plusieurs valeurs séparées par des virgules.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-SoftDeletedMailbox
Le commutateur SoftDeletedMailbox est requis pour retourner des boîtes aux lettres supprimées de manière réversible dans les résultats. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.
Les boîtes aux lettres supprimées de manière réversible sont des boîtes aux lettres supprimées qui sont toujours récupérables.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UserPrincipalName
Le paramètre UserPrincipalName identifie la boîte aux lettres 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 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
Entrées
Input types
Les paramètres Get-Mailbox suivants ne sont pas disponibles ou fonctionnels dans Get-EXOMailbox :
- Async
- GroupMailbox
- Migration
- PublicFolder
- SortBy
Sorties
Output types
Les propriétés suivantes ne sont pas incluses dans la sortie de Get-EXOMailbox :
- RunspaceId
- Servername
- AdminDisplayVersion
- DelayReleaseHoldApplied
- EnforcedTimestamps
- Description
- OriginatingServer
- IsValid
- ObjectState