Get-ActiveSyncDevice
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
Use the Get-ActiveSyncDevice cmdlet to retrieve the list of devices in your organization that have active Exchange ActiveSync partnerships.
Note: In Exchange 2013 or later, use the Get-MobileDevice cmdlet instead. If you have scripts that use Get-ActiveSyncDevice, update them to use Get-MobileDevice.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Get-ActiveSyncDevice
-Mailbox <MailboxIdParameter>
[-DomainController <Fqdn>]
[-Filter <String>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Monitoring]
[<CommonParameters>] Get-ActiveSyncDevice
[[-Identity] <ActiveSyncDeviceIdParameter>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Monitoring]
[<CommonParameters>] Description
The Get-ActiveSyncDevice cmdlet returns identification, configuration and status information for each device.
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
Get-ActiveSyncDevice -Mailbox "TonySmith"This example returns all Exchange ActiveSync mobile devices that Tony Smith has used and that are associated with his mailbox.
Example 2
Get-ActiveSyncDevice -ResultSize Unlimited | Where {$_.DeviceOS -eq "OutlookBasicAuth"} | Format-Table -Auto UserDisplayName,DeviceAccessStateThis example returns the owner names of all Exchange ActiveSync mobile devices that connect via the Outlook Mobile app using Basic Authentication.
Example 3
Get-ActiveSyncDevice -ResultSize Unlimited | Where {$_.DeviceType -eq "OutlookService"} | Format-Table -Auto UserDisplayName,FirstSyncTimeThis example returns the owner names of all Outlook Mobile apps that synch via Hybrid Modern Authentication.
Parameters
-DomainController
This parameter is available only in on-premises Exchange.
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
The Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax "Property -ComparisonOperator 'Value'".
- Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example,
$true,$false, or$null), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. - Property is a filterable property.
- ComparisonOperator is an OPATH comparison operator (for example
-eqfor equals and-likefor string comparison). For more information about comparison operators, see about_Comparison_Operators. - Value is the property value to search for. Enclose text values and variables in single quotation marks (
'Value'or'$Variable'). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of'$User', use'$($User -Replace "'","''")'. Don't enclose integers or system values in quotation marks (for example, use500,$true,$false, or$nullinstead).
You can chain multiple search criteria together using the logical operators -and and -or. For example, "Criteria1 -and Criteria2" or "(Criteria1 -and Criteria2) -or Criteria3".
For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information.
You can filter by the following properties:
- ClientType
- DeviceAccessControlRule
- DeviceAccessState
- DeviceAccessStateReason
- DeviceActiveSyncVersion
- DeviceId
- DeviceImei
- DeviceMobileOperator
- DeviceModel
- DeviceOS
- DeviceOSLanguage
- DeviceTelephoneNumber
- DeviceType
- DeviceUserAgent
- FirstSyncTime
- FriendlyName
- ProvisioningFlags
- UserDisplayName
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Identity
The Identity parameter specifies the ActiveSync device that you want to view. You can use any value that uniquely identifies the device. For example:
- GUID
- DeviceIdentity
- Multi-TenantID
| Type: | ActiveSyncDeviceIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
The Mailbox parameter specifies the mailbox that has the associated ActiveSync device that you want to view. You can use any value that uniquely identifies the mailbox. For example:
- Name
- Alias
- Distinguished name (DN)
- Canonical DN
- Domain\Username
- Email address
- GUID
- LegacyExchangeDN
- SamAccountName
- User ID or user principal name (UPN)
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Monitoring
This parameter is available only in on-premises Exchange.
The Monitoring switch is required to return monitoring mailboxes in the results. You don't need to specify a value with this switch.
Monitoring mailboxes are associated with managed availability and the Exchange Health Manager service, and have a RecipientTypeDetails property value of MonitoringMailbox.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-OrganizationalUnit
The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's returned by the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:
- Name
- Canonical name
- Distinguished name (DN)
- GUID
| Type: | OrganizationalUnitIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-ResultSize
The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-SortBy
The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.
If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto Property1,Property2,...PropertyX. to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.
You can sort by the following properties:
- DeviceAccessControlRule
- DeviceAccessState
- DeviceAccessStateReason
- DeviceId
- DeviceImei
- DeviceMobileOperator
- DeviceModel
- DeviceOS
- DeviceOSLanguage
- DeviceTelephoneNumber
- DeviceType
- DeviceUserAgent
- FirstSyncTime
- FriendlyName
- UserDisplayName
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
Inputs
Input types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
Outputs
Output types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn't return data.