Retrieves a list of remote mailboxes or properties of a remote mailbox specified by the Identifier parameter.
Get-DRARemoteMailbox -Domain <String> [-Identifier <String>] [-UserAndFilter <Hashtable>] [-UserOrFilter <Hashtable>] [-SharedMailboxOrFilter <Hashtable>] [-Attributes <String[]>] [-PowersForOperations <String[]>] [-VisiblePropertiesOnly <SwitchParameter>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
Use the Get-DRARemoteMailbox cmdlet to:
Retrieve a list of on-premises accounts with an associated mailbox in the cloud-based service.
Retrieve properties of an on-premises user account with an associated mailbox in the cloud-based service. The requesting user must have the View All User Properties power.
Retrieve properties of an on-premises object with an associated shared mailbox in the cloud-based service. The requesting user must have the View All Shared Mailbox Properties power.
|
Attribute / Description |
Parameters / Values |
||||
|---|---|---|---|---|---|
|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
|
Identifier <String> The name or distinguished name of an existing Active Directory object. |
false |
named |
true (ByPropertyName) |
false |
|
|
UserAndFilter [<Hashtable>] The user properties to use when searching for user objects. The properties will be combined for the search. Users matching all listed properties will be returned. |
false |
named |
|
true (ByPropertyName) |
false |
|
UserOrFilter [<Hashtable>] The user properties to use when searching for user objects. Users matching any of the listed properties will be returned. |
false |
named |
|
true (ByPropertyName) |
false |
|
SharedMailboxOrFilter [<Hashtable>] The mailbox properties to use when searching for remote mailbox objects. Remote mailboxes matching any of the listed properties will be returned. |
false |
named |
|
true (ByPropertyName) |
false |
|
Attributes [<String[]>] An array of attributes to retrieve values for. If this parameter is missing, a default list of properties is returned. |
false |
named |
|
true (ByPropertyName) |
false |
|
PowersForOperations [<String[]>] An array of DRA operation names for which you want the server to return read/write permission information. This parameter is typically used by a UI-based client to hide or disable elements the calling user doesn't have powers for. The PowersForOperations parameter is applicable only if you have specified the Identifier parameter. |
false |
named |
|
true (ByPropertyName) |
false |
|
VisiblePropertiesOnly [<SwitchParameter>] A flag to indicate whether DRA must return only properties the caller has powers to view. By default, DRA will return an error if the caller requests a property that they do not have powers to view. If you specify this flag, DRA does not return a value for such properties. |
false |
named |
|
false |
false |
|
Domain <String> The domain of the object in FQDN format. For example: mydomain.corp |
true |
named |
|
true (ByPropertyName) |
false |
|
DRARestServer [<String>] The name of the computer running the DRA Rest Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'. |
false |
named |
|
true (ByPropertyName) |
false |
|
DRARestPort [<Int32>] The port where the DRA REST Service listens for requests. If the parameter is not specified, the value defaults to 8755. |
false |
named |
8755 |
true (ByPropertyName) |
false |
|
IgnoreCertificateErrors [<SwitchParameter>] Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate. |
false |
named |
|
false |
false |
|
Force [<SwitchParameter>] Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user. |
false |
named |
|
false |
false |
|
Timeout [<Int32>] The number of seconds to wait before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1. |
false |
named |
100 seconds |
true (ByPropertyName) |
false |
|
<CommonParameters> Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters. |
|
|
|
|
|
NOTE:For more information, type "Get-DRARemoteMailbox -detailed". For technical information, type "Get-DRARemoteMailbox -full".
Example 20-6 1
PS C:\\>Get-DRARemoteMailbox -Domain "MyDomain.corp"
This example retrieves a list of on-premises user accounts with a cloud-based mailbox from the domain MyDomain. The retrieval of the cloud-based mailbox properties is not immediate and depends on the directory synchronization schedule.
Example 20-7 2
PS C:\\>Get-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=MyUser,OU=MyOU,DC=MyDomain,DC=corp"
This example retrieves properties of the on-premises user account MyUser associated with a cloud-based mailbox. The identifier contains the distinguished name for the user. The retrieval of the cloud-based mailbox properties is not immediate and depends on the directory synchronization schedule.
Example 20-8 3
PS C:\\>Get-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=MyUser,OU=MyOU,DC=MyDomain,DC=corp"" -Attributes "Description","DisplayName","MailTip","RemoteRoutingAddress"
This example retrieves properties of the on-premises user account MyUser associated with a cloud-based mailbox. The identifier contains the distinguished name for the user. The Attributes parameter specifies the mailbox properties to return. If the Attributes parameter is not specified, a default list of properties is returned. The retrieval of the cloud-based mailbox properties is not immediate and depends on the directory synchronization schedule.
Example 20-9 4
PS C:\>Get-DRARemoteMailbox -Domain MyDomain.corp -Identifier "CN=Alfred O365,OU=Tax,DC=MYDOM,DC=CORP" -Attributes "office365DeliverAndForward","office365ForwardingAddress","office365FullAccess","office365SendAs"
This example retrieves the mailbox properties of the on-premises user account Alfred O365 associated with a cloud-based mailbox. The identifier contains the distinguished name for the user. The Attributes parameter specifies the mailbox properties to return. If the Attributes parameter is not specified, a default list of properties is returned. The retrieval of the cloud-based mailbox properties is not immediate and depends on the directory synchronization schedule.
For a list of cloud-based mailbox properties that can be managed for a remote mailbox, see Exchange Online Properties.