Get-MSTeamsDevice
- 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-MSTeamsDevice
- Updated on 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Return a list of MS Teams Devices
Syntax
Get-MSTeamsDevice
-ID <String>
-DeviceType <String>
-CurrentUser <String>
-HardwareUniqueID <String>
-TenantName <String>
-MSClientID <String>
-MSClientSecret <String>
-MSTenantID <String>
-AuthToken <String>
-ResultSize <Int32>
Parameters
-ID <String>
The GUID of a specific device to query
| Parameter | Value |
|---|---|
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-DeviceType <String>
Return all devices that match the given device type. Choose from
'unknown', 'ipPhone', 'TeamsRoom', 'SurfaceHub', 'CollaborationBar', 'TeamsDisplay', 'TouchConsole', 'LowCostPhone', 'TeamsPanel', 'SIP', 'UnknownFutureValue'
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-CurrentUser <String>
Show devices that are currently logged in by the given user. Use either the user's GUID or UPN
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-HardwareUniqueID <String>
Show device that matches the given unique hardware ID. Different from the GUID formatted ID.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-MSClientID <String>
The MS client ID for the application granted access to Azure AD.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-MSClientSecret <String>
The MS client secret for the application granted access to Azure AD.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-MSTenantID <String>
The MS tenant ID for the O365 customer granted access to Azure AD.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 8 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-AuthToken <String>
The authorization token used for this request. Normally obtained via Get-MSGraphAccessToken
| Parameter | Value |
|---|---|
| Required | false |
| Position | 9 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-ResultSize <Int32>
The number of results to return. Defaults to 1000.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 10 |
| Required | false |
| Default Value | 10000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?