列出 teamworkDevices

命名空间:microsoft.graph

注意

与资源类型的设备管理 teamworkDevice 相关的 Microsoft Graph beta API 将于 2025 年 11 月弃用,并且在该日期之后将不再受支持。

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

获取为租户预配的所有支持 Microsoft Teams 的 设备的 列表。

注意:Microsoft 暂时免费提供使用 API 管理启用 Microsoft Teams 的设备。 Microsoft 将在未来收取使用部分或所有此类 API 的费用。 Microsoft 将提供定价更改的高级通知。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ✅ ✅ ✅

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) TeamworkDevice.Read.All TeamworkDevice.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 TeamworkDevice.Read.All TeamworkDevice.ReadWrite.All

HTTP 请求

GET /teamwork/devices

可选的查询参数

此方法支持 (deviceType、hardwareDetail/uniqueId 和 currentUser/id 属性) $filter 、$top、$select和 $skipTokenOData 查询参数,以帮助自定义响应。

支持的查询模式

模式 语法 注释
服务器端分页 @odata.nextLink 当结果集跨越多个页面时,你将在响应中获得延续令牌。
筛选 /devices?$filter=deviceType eq 'TeamsRoom' 根据设备类别筛选设备。
筛选 /devices?$filter=hardwareDetail/uniqueId eq 'value' 根据分配给设备的唯一 Id 筛选设备。
筛选 /devices?$filter=currentUser/id eq 'value' 根据设备上的登录用户筛选设备。
页面限制 /devices?$top=10 获取页面大小为 10 的设备。 默认页限制为 20。 最大页面限制为 50。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法将在响应正文中返回 200 OK 响应代码和 teamworkDevice 对象的集合。

示例

请求

GET https://graph.microsoft.com/beta/teamwork/devices

响应

注意:为了提高可读性,可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#teamwork/devices",
  "@odata.count": 2,
  "@odata.nextLink": "/teamwork/devices?$filter=deviceType+eq+Microsoft.Teams.GraphSvc.teamworkDeviceType%collaborationBar%27&$top=2&$skiptoken=%2bRID%3a~z9snAP1BE88Zlz0AAAAADg%3d%3d%23RT%3a1%23TRC%3a3%23RTD%3auCNd2ZP%2fZ5zLgoPeFGRGBTMxMzIuMTcuMzJVMTY7NTc7MjEvNTozNjEyM1sA%23ISV%3a2%23IEO%3a65551%23QCF%3a4%23FPC%3aAggBAAAAADgAAPcAAAAAOAAAAQAAAAA4AAACADiI9AAAAAA4AAACABCP9QAAAAA4AAAEAFEu4AD2AAAAADgAAAQANoXZkfcAAAAAOAAABAAlgIiK",
  "value": [
    {
      "@odata.type": "#microsoft.graph.teamworkDevice",
      "id": "0f3ce432-e432-0f3c-32e4-3c0f32e43c0f",
      "deviceType": "CollaborationBar",
      "hardwareDetail": {
        "serialNumber": "0189",
        "uniqueId": "5abcdefgh",
        "macAddresses": [],
        "manufacturer": "yealink",
        "model": "vc210"
      },
      "notes": "CollaborationBar device.",
      "companyAssetTag": "Tag1",
      "healthStatus": "Healthy",
      "activityState": "Idle",
      "createdDateTime": "2021-06-19T19:01:04.185Z",
      "createdBy": null,
      "lastModifiedDateTime": "2021-06-19T19:01:04.185Z",
      "lastModifiedBy": null,
      "currentUser": {
        "id": "2a610f6f-adf6-4205",
        "displayName": "Evan Lewis",
        "userIdentityType": "aadUser"
      }
    },
    {
      "@odata.type": "#microsoft.graph.teamworkDevice",
      "id": "55ab555-e432-0f3c-32e4-3c0f32e43c0f",
      "deviceType": "CollaborationBar",
      "hardwareDetail": {
        "serialNumber": "0189",
        "uniqueId": "5abcdefgh",
        "macAddresses": [],
        "manufacturer": "yealink",
        "model": "vc210"
      },
      "notes": "CollaborationBar device.",
      "companyAssetTag": "Tag2",
      "healthStatus": "Healthy",
      "activityState": "Idle",
      "createdDateTime": "2021-06-10T19:01:04.185Z",
      "createdBy": null,
      "lastModifiedDateTime": "2021-06-19T19:01:04.185Z",
      "lastModifiedBy": null,
      "currentUser": {
        "id": "2a610f6f-adf6-4205",
        "displayName": "Evan Lewis",
        "userIdentityType": "aadUser"
      }
    }
  ]
}