Список устройств
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение списка устройств, зарегистрированных в каталоге.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Device.Read.All | Directory.Read.All, Directory.ReadWrite.All |
Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
Приложение | Device.Read.All | Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Вызывающий пользователь также должен иметь одну из следующих Microsoft Entra ролей:
- Пользователи
- Читатели каталогов
- Запись каталогов
- Администратор соответствия требованиям
- Диспетчеры устройств
- Администратор приложений
- Читатель сведений о безопасности
- Администратор безопасности
- Администратор привилегированных ролей
- Администратор облачных приложений
- Утверждающий доступ к lockBox клиента
- Администратор Dynamics 365
- Администратор Power BI
- Администратор Аналитика компьютеров
- Администратор компьютеров, управляемых Корпорацией Майкрософт
- Администратор связи Teams
- Инженер службы поддержки связи Teams
- Специалист службы поддержки связи Teams
- Администратор Teams
- Администратор данных соответствия требованиям
- Оператор безопасности
- Администратор Kaizala
- Глобальный читатель
- Рецензент каталога
- Администратор Windows 365
HTTP-запрос
GET /devices
Необязательные параметры запросов
Этот метод поддерживает $count
параметры запроса OData , $expand
$filter
, $orderby
, $search
, $select
, и $top
для настройки ответа. Некоторые запросы поддерживаются только при использовании заголовка ConsistencyLevel с присвоенным значением eventual
и $count
. Дополнительные сведения см. в разделе Расширенные возможности запросов к объектам каталогов.
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
ConsistencyLevel | необязательный. Этот заголовок и $count требуются при использовании $search или определенном использовании $filter . Дополнительные сведения об использовании ConsistencyLevel и $count см. в разделе Дополнительные возможности запросов к объектам каталога. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успеха этот метод возвращает код отклика 200 OK
и коллекцию объектов device в тексте отклика.
Примеры
Пример 1. Получение списка устройств
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/devices
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"accountEnabled":true,
"deviceId":"00000000-0000-0000-0000-000000000000",
"deviceVersion":1,
"displayName":"contoso_Android",
"Manufacturer":"Google",
"Model":"Pixel 3a",
"operatingSystemVersion":"10.0"
}
]
}
Пример 2. Получение только количества устройств
Запрос
Ниже показан пример запроса. Для этого запроса требуется заголовок ConsistencyLevel с присвоенным значением eventual
, так как в запросе присутствует $count
. Дополнительные сведения об использовании ConsistencyLevel и $count
см. в разделе Дополнительные возможности запросов к объектам каталога.
Примечание. В настоящее время параметры
$count
и$search
недоступны в клиентах Azure AD B2C.
GET https://graph.microsoft.com/beta/devices/$count
ConsistencyLevel: eventual
Отклик
Ниже показан пример отклика.
HTTP/1.1 200 OK
Content-type: text/plain
294
Пример 3. Вывод списка всех устройств и возврат только их свойств id и extensionAttributes
Запрос
GET https://graph.microsoft.com/beta/devices?$select=id,extensionAttributes
Отклик
Ниже показан пример отклика.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#devices(id,extensionAttributes)",
"value": [
{
"id": "6a59ea83-02bd-468f-a40b-f2c3d1821983",
"extensionAttributes": {
"extensionAttribute1": null,
"extensionAttribute2": null,
"extensionAttribute3": null,
"extensionAttribute4": null,
"extensionAttribute5": null,
"extensionAttribute6": null,
"extensionAttribute7": null,
"extensionAttribute8": null,
"extensionAttribute9": null,
"extensionAttribute10": null,
"extensionAttribute11": null,
"extensionAttribute12": null,
"extensionAttribute13": null,
"extensionAttribute14": null,
"extensionAttribute15": null
}
}
]
}
Пример 4. Использование $filter и $top для получения одного устройства с отображаемым именем, начинающимся с "a", включая количество возвращаемых объектов
Запрос
Ниже показан пример запроса. Для этого запроса требуется заголовок ConsistencyLevel с присвоенным значением eventual
и строка запроса $count=true
, так как запрос содержит параметры запроса $orderby
и $filter
. Дополнительные сведения об использовании ConsistencyLevel и $count
см. в разделе Дополнительные возможности запросов к объектам каталога.
Примечание. В настоящее время параметры
$count
и$search
недоступны в клиентах Azure AD B2C.
GET https://graph.microsoft.com/beta/devices?$filter=startswith(displayName, 'a')&$count=true&$top=1&$orderby=displayName
ConsistencyLevel: eventual
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#devices",
"@odata.count":1,
"value":[
{
"accountEnabled":true,
"deviceId":"00000000-0000-0000-0000-000000000000",
"deviceVersion":1,
"displayName":"a_device_1",
"Manufacturer":"Google",
"Model":"Pixel 3a",
"operatingSystemVersion":"10.0",
"hostNames":[]
},
{
"accountEnabled":true,
"deviceId":"00000000-0000-0000-0000-000000000001",
"deviceVersion":1,
"displayName":"a_device_1",
"Manufacturer":"Microsoft",
"Model":"Surface",
"operatingSystemVersion":"windows10EnterpriseN",
"hostNames":["contoso.com", "device_1"]
}
]
}
Пример 5. Использование $search для получения устройств с отображаемыми именами, содержащими буквы "Android", включая количество возвращенных объектов
Запрос
Ниже показан пример запроса. Для этого запроса требуется заголовок ConsistencyLevel с присвоенным значением eventual
, так как в запросе присутствует $search
и строка запроса $count=true
. Дополнительные сведения об использовании ConsistencyLevel и $count
см. в разделе Дополнительные возможности запросов к объектам каталога.
Примечание. В настоящее время параметры
$count
и$search
недоступны в клиентах Azure AD B2C.
GET https://graph.microsoft.com/beta/devices?$search="displayName:Android"&$count=true
ConsistencyLevel: eventual
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#devices",
"@odata.count":1396,
"value":[
{
"accountEnabled":true,
"deviceId":"00000000-0000-0000-0000-000000000000",
"deviceVersion":1,
"displayName":"contoso_Android",
"Manufacturer":"Google",
"Model":"Pixel 3a",
"operatingSystemVersion":"10.0",
"hostNames":[]
}
]
}
Пример 6. Получение устройств с помощью фильтра в extensionAttributes
Запрос
Ниже показан пример запроса. Для этого запроса необходимо задать для заголовка ConsistencyLevel значение eventual
и $count=true
строку запроса, так как свойство extensionAttributes поддерживает $filter
только расширенные параметры запроса. Дополнительные сведения об использовании ConsistencyLevel и $count
см. в разделе Дополнительные возможности запросов к объектам каталога.
Примечание. В настоящее время параметры
$count
и$search
недоступны в клиентах Azure AD B2C.
GET https://graph.microsoft.com/beta/devices?$filter=extensionAttributes/extensionAttribute1 eq 'BYOD-Device'&$count=true
ConsistencyLevel: eventual
Отклик
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#devices",
"@odata.count": 1,
"value": [
{
"@odata.id": "https://graph.microsoft.com/v2/84841066-274d-4ec0-a5c1-276be684bdd3/directoryObjects/6a59ea83-02bd-468f-a40b-f2c3d1821983/Microsoft.DirectoryServices.Device",
"id": "6a59ea83-02bd-468f-a40b-f2c3d1821983",
"accountEnabled": true,
"approximateLastSignInDateTime": "2021-10-21T06:36:56Z",
"createdDateTime": "2021-09-21T15:16:30Z",
"deviceId": "eab73519-780d-4d43-be6d-a4a89af2a348",
"displayName": "DESKTOP-LK3PESR",
"operatingSystem": "Windows",
"operatingSystemVersion": "10.0.19043.1237",
"alternativeSecurityIds": [
{
"type": 2,
"identityProvider": null,
"key": "WAA1ADAAOQA6AD...ADQAMwB5AGEAcQBnAD0A"
}
],
"extensionAttributes": {
"extensionAttribute1": "BYOD-Device",
"extensionAttribute2": null,
"extensionAttribute3": null,
"extensionAttribute4": null,
"extensionAttribute5": null,
"extensionAttribute6": null,
"extensionAttribute7": null,
"extensionAttribute8": null,
"extensionAttribute9": null,
"extensionAttribute10": null,
"extensionAttribute11": null,
"extensionAttribute12": null,
"extensionAttribute13": null,
"extensionAttribute14": null,
"extensionAttribute15": null
}
}
]
}
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по