Get-RemoteMailbox
La cmdlet est disponible uniquement dans Exchange en local.
Utilisez l’applet de commande Get-RemoteMailbox pour récupérer les attributs liés au courrier des utilisateurs dans le organization local qui ont des boîtes aux lettres associées dans le service cloud.
Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet Exchange.
Syntaxe
AnrSet
Get-RemoteMailbox
[-Anr <String>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
Identity
Get-RemoteMailbox
[[-Identity] <RemoteMailboxIdParameter>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
Description
L’applet de commande Get-RemoteMailbox récupère les attributs liés à la messagerie d’un utilisateur de messagerie dans le Active Directory local. Il ne récupère pas les attributs de la boîte aux lettres cloud associée. La plupart des attributs liés à la messagerie de l’utilisateur de messagerie local et de la boîte aux lettres cloud associée doivent être identiques. Toutefois, la boîte aux lettres basée sur le cloud a des attributs supplémentaires que vous ne pouvez pas afficher à l’aide de cette applet de commande. Pour afficher les attributs de la boîte aux lettres basée sur le cloud, vous devez utiliser le centre d’administration Exchange dans le service cloud, ou vous connecter à votre organization cloud et exécuter l’applet de commande Get-Mailbox.
Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que cet article répertorie tous les paramètres de l’applet de commande, il se peut que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous sont 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-RemoteMailbox
Cet exemple montre comment renvoyer une liste récapitulative de toutes les boîtes aux lettres distantes de votre organization.
Exemple 2
Get-RemoteMailbox -Identity laura@contoso.com | Format-List
Cet exemple retourne des informations détaillées pour la boîte aux lettres distante de l’utilisateur laura@contoso.com.
Exemple 3
$Credentials = Get-Credential
Get-RemoteMailbox -Credential $Credentials
Cet exemple utilise d’autres informations d’identification pour récupérer une liste d’un ou de plusieurs utilisateurs à extension messagerie avec des boîtes aux lettres dans le service. Cela est utile si le compte que vous utilisez généralement n’a pas d’autorisations d’administration. Les informations d’identification sont utilisées pour accéder aux contrôleurs de domaine Active Directory local.
Tout d’abord, exécutez la commande suivante pour vous inviter à entrer vos informations d’identification, puis stockez-les dans une variable. Récupérez ensuite une liste de boîtes aux lettres distantes à l’aide des informations d’identification que vous avez fournies à l’aide de la deuxième commande.
Paramètres
-Anr
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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
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
AnrSet
| 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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Le commutateur Archive est nécessaire pour retourner la boîte aux lettres d’archivage de l’utilisateur dans les résultats. 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 |
-Credential
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Propriétés du paramètre
| Type: | PSCredential |
| 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 |
-DomainController
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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 ».
Propriétés du paramètre
| Type: | Fqdn |
| 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 |
-Filter
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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
-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.
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 |
-Identity
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Le paramètre Identity spécifie la boîte aux lettres distante que vous souhaitez afficher. Vous pouvez utiliser n’importe quelle valeur qui identifie de façon unique la boîte aux lettres distante. Par exemple :
- Nom
- Alias
- Nom unique
- Nom unique
- Domaine\Nom d’utilisateur
- Adresse e-mail
- GUID
- LegacyExchangeDN
- SamAccountName
- Identifiant utilisateur ou nom d’utilisateur principal (UPN)
Propriétés du paramètre
| Type: | RemoteMailboxIdParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
Identity
| Position: | 1 |
| Obligatoire: | False |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-IgnoreDefaultScope
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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é.
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 |
-OnPremisesOrganizationalUnit
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Le paramètre OnPremisesOrganizationalUnit filtre les résultats en fonction de l’emplacement de l’objet dans Active Directory.
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
Propriétés du paramètre
| Type: | OrganizationalUnitIdParameter |
| 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 |
-ReadFromDomainController
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
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 |
-ResultSize
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Remarque : Les limitations sur les contrôleurs de domaine peuvent affecter le nombre de résultats retournés pour la valeur illimitée. Pour plus d’informations, consultez cet article.
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 |
-SortBy
Applicable : Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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
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 |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
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.