Get-EXOMailbox

Module:
Exchange PowerShell

Cette applet de commande est disponible uniquement dans le module PowerShell d’Exchange Online. Pour plus d’informations, consultez À propos du module Exchange Online PowerShell.

Utilisez l’applet de commande Get-EXOMailbox pour afficher les objets et attributs de boîte aux lettres, remplir les pages de propriétés ou fournir des informations sur la 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.

Syntaxe

Identity (Par défaut) 

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>]

Anr 

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 organization.

Exemples

Exemple 1

Get-EXOMailbox -ResultSize unlimited

Cet exemple renvoie 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 Propriétés et/ou Jeux de propriétés.

Exemple 2

Get-EXOMailbox -PropertySets Archive

Cet exemple renvoie 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, voir Jeux de propriétés Get-EXOMailbox.

Exemple 3

Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit

Cet exemple renvoie 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 jeux de propriétés d’Archive et d’Audit.
  • Les propriétés Name et DistinguishedName.

Exemple 4

Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias

Cet exemple renvoie les propriétés spécifiées pour la boîte aux lettres John@contoso.com.

Paramètres

-Anr

Applicable : Exchange Online

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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Anr
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Archive

Applicable : Exchange Online

Le commutateur Archive filtre les résultats en fonction des boîtes aux lettres pour lesquelles une archive est activée (seules les boîtes aux lettres dotées d’une boîte aux lettres d’archivage sont renvoyées). Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Async

Applicable : Exchange Online

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ExternalDirectoryObjectId

Applicable : Exchange Online

Le paramètre ExternalDirectoryObjectId identifie la boîte aux lettres que vous souhaitez afficher par l’ObjectId dans Microsoft Entra ID.

Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, Identity, PrimarySmtpAddress ou UserPrincipalName.

Propriétés du paramètre

Type:Guid
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Identity
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Filter

Applicable : Exchange Online

Le paramètre Filtre utilise la syntaxe OAPATH pour filtrer les résultats en fonction des propriétés et des valeurs spécifiées. Les critères de recherche utilisent la syntaxe "Property -ComparisonOperator 'Value'".

  • Encadrez 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 (pas un bloc système), vous pouvez également utiliser des accolades { }, mais uniquement si le filtre ne contient pas de variables.
  • La propriété est une propriété filtrable. Pour plus d’informations sur les propriétés filtrables, consultez Jeux de propriétés Get-EXOMailbox et Propriétés filtrables pour le paramètre Filtre.
  • ComparisonOperator est un opérateur de comparaison OPATH (par exemple -eq , pour les égaux et -like pour les chaînes). Pour plus d'informations sur les opérateurs de comparaison, reportez-vous à la rubrique about_Comparison_Operators.
  • La valeur est la valeur de la propriété à rechercher. Placer 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 les guillemets simples (échappement) pour développer correctement la variable. Par exemple, au lieu de '$User', utilisez '$($User -Replace "'","''")'. Ne placez pas d’entiers ou de valeurs système entre guillemets (par exemple, utilisez 500, $true, $falseou $null à la place).

Vous pouvez enchaîner plusieurs critères de recherche à l’aide des opérateurs -and logiques 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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-GroupMailbox

Applicable : Exchange Online

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Identity

Applicable : Exchange Online

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

Dans le cas contraire, vous pouvez utiliser n’importe quelle valeur identifiant de manière unique la boîte aux lettres. Par exemple :

  • Nom
  • Alias
  • Nom unique
  • Domaine\Nom d’utilisateur
  • Adresse e-mail
  • LegacyExchangeDN
  • SamAccountName

Vous ne pouvez pas utiliser ce paramètre avec les paramètres Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.

Attention : La valeur $null ou une valeur inexistante pour le paramètre Identity renvoie tous les objets comme si vous exécutiez la commande Get- sans le paramètre Identity. Vérifiez que les listes de valeurs du paramètre Identity sont exactes et ne contiennent pas de valeurs $null inexistantes.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Identity
Position:0
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-InactiveMailboxOnly

Applicable : Exchange Online

Le commutateur InactiveMailboxOnly spécifie s’il faut renvoyer 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 renvoyer à la fois les boîtes aux lettres actives et inactives dans les résultats, n’utilisez pas ce commutateur. Utilisez plutôt le commutateur IncludeInactiveMailbox.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IncludeInactiveMailbox

Applicable : Exchange Online

Le commutateur IncludeInactiveMailbox spécifie s’il faut inclure 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 renvoyer uniquement les boîtes aux lettres inactives dans les résultats, n’utilisez pas ce commutateur. Utilisez plutôt le commutateur InactiveMailboxOnly.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-MailboxPlan

Applicable : Exchange Online

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 est affecté sont renvoyé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 afficher les plans de boîte aux lettres disponibles à l’aide de l’applet de commande Get-MailboxPlan.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Migration

Applicable : Exchange Online

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-OrganizationalUnit

Applicable : Exchange Online

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

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PrimarySmtpAddress

Applicable : Exchange Online

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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Identity
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Properties

Applicable : Exchange Online

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, voir Jeux de propriétés Get-EXOMailbox.

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PropertySets

Applicable : Exchange Online

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
  • Déplacer
  • Stratégie
  • PublicFolder
  • Quota
  • Resource
  • 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, voir Jeux de propriétés Get-EXOMailbox.

Propriétés du paramètre

Type:

PropertySet[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PublicFolder

Applicable : Exchange Online

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RecipientTypeDetails

Applicable : Exchange Online

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
  • Boîte aux lettres d’équipement
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • Boîte aux lettres de salle
  • SchedulingMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

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

Propriétés du paramètre

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ResultSize

Applicable : Exchange Online

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.

Propriétés du paramètre

Type:Unlimited
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SoftDeletedMailbox

Applicable : Exchange Online

Le commutateur SoftDeletedMailbox est nécessaire pour renvoyer les 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 encore récupérables.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-UserPrincipalName

Applicable : Exchange Online

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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

Identity
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

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 :

  • ID d’exécution
  • Nom du serveur
  • AdminDisplayVersion
  • DelayReleaseHoldApplied
  • EnforcedTimestamps
  • Description
  • OriginatingServer
  • IsValid
  • État de l’objet