Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получите недоступные облачные компьютеры со сведениями, включая последнее состояние работоспособности, число неудачных подключений, число проверка работоспособности и состояние системы. Недоступный облачный компьютер представляет собой облачный компьютер, который находится в недоступном состоянии (по крайней мере, одна из проверок работоспособности завершилась сбоем) или имеет последовательные сбои подключений пользователей.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | CloudPC.Read.All | CloudPC.ReadWrite.All |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Приложение | CloudPC.Read.All | CloudPC.ReadWrite.All |
HTTP-запрос
POST /deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
| Content-Type | application/json. Обязательно. |
| Предпочитать: include-unknown-enum-members | Включает изменяемые значения перечисления за пределами значения sentinel. Дополнительные сведения см. в статье Рекомендации по работе с Microsoft Graph. Необязательный параметр. |
Текст запроса
В тексте запроса укажите представление параметров в формате JSON.
В следующей таблице показаны параметры, которые можно использовать с этим методом.
| Параметр | Тип | Описание |
|---|---|---|
| filter | String | Синтаксис OData $filter . В настоящее время поддерживаются только and, or, gtge и eq . |
| groupBy | Коллекция строк | Указывает, как группировать отчеты. Если используется, содержимое должно совпадать с параметром select. |
| orderBy | Коллекция строк | Указывает способ сортировки отчетов. |
| reportName | cloudPCInaccessibleReportName | Имя отчета. Допустимые значения: inaccessibleCloudPcReports, inaccessibleCloudPcTrendReport, unknownFutureValue, regionalInaccessibleCloudPcTrendReport. Значение по умолчанию — , inaccessibleCloudPcReports если reportName пуст. Необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующие члены в этом развиваемом перечислении: regionalInaccessibleCloudPcTrendReport. |
| search | String | Указывает строку для поиска. |
| select | Коллекция строк | Синтаксис OData $select . Представляет выбранные столбцы отчетов. |
| skip | Int32 | Количество записей, которые нужно пропустить. |
| top | Int32 | Количество возвращаемых верхних записей. |
значения cloudPCInaccessibleReportName
| Member | Описание |
|---|---|
| inaccessibleCloudPcReports | Указывает отчет, содержащий сведения о недоступных облачных компьютерах, в том числе с последовательными сбоями подключения или недоступными. |
| inaccessibleCloudPcTrendReport | Указывает ежедневный агрегированный отчет за указанный период, содержащий сведения о недоступных облачных компьютерах, в том числе с последовательными сбоями подключения или недоступными. |
| unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
| regionalInaccessibleCloudPcTrendReport | Указывает еженедельный региональный агрегированный отчет о недоступных тенденциях облачных компьютеров. |
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект Stream в теле отклика.
В следующей таблице описаны столбцы в возвращаемом отчете при указании inaccessibleCloudPcReports свойства reportName в вызове API. Для inaccessibleCloudPcReportsзначения элементов должны быть в формате верблюдьего регистра.
| Member | Описание |
|---|---|
| cloudPcId | Уникальный идентификатор облачного компьютера. |
| cloudPcName | Отображаемое имя облачного компьютера. |
| deviceHealthStatus | Текущее состояние работоспособности устройства облачного компьютера. |
| deviceHealthStatusDateTime | Дата и время последнего обновления состояния работоспособности устройства. |
| provisioningStatus | Состояние подготовки облачного компьютера. |
| recentConnectionFailureCount | Число последних сбоев подключения для облачного компьютера. |
| recentDeviceHealthFailureCount | Количество последних сбоев работоспособности устройства проверка. |
| область | Регион Azure, в котором размещен облачный компьютер. |
| systemStatus | Текущее состояние системы облачного компьютера. |
| systemStatusDateTime | Дата и время последнего обновления состояния системы. |
| userPrincipalName. | Имя участника-пользователя (UPN) пользователя, назначенного облачному компьютеру. |
В следующей таблице описаны столбцы в возвращаемом отчете при указании regionalInaccessibleCloudPcTrendReport свойства reportName в вызове API.
| Member | Описание |
|---|---|
| CloudPcCount | Общее количество облачных компьютеров в регионе. |
| HostRegionName | Имя Azure региона, в котором размещены облачные компьютеры. |
| Last24hPeakInaccessibleCloudPcCount | Максимальное число недоступных облачных компьютеров за последние 24 часа. |
| WeeklyInaccessibleTrend | Тенденция в еженедельном соотношении недоступных облачных компьютеров к общему количеству облачных компьютеров в регионе. Тенденция вычисляется с помощью линейной регрессии за четыре недели данных. Значения могут быть Increasing (наклон > 0,05), Decreasing (наклон < -0,05) или Static (в противном случае). |
| WeeklyPeakInaccessibleCloudPcCount | Максимальное число недоступных облачных компьютеров в течение текущей недели. Еженедельный период начинается с воскресенья по текущий день. |
Примеры
Пример 1. Получение отчетов о недоступных облачных компьютерах в определенном регионе
В следующем примере показано, как получить отчеты о недоступных облачных компьютерах в определенном регионе.
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
Content-Type: application/json
Content-length: 199
{
"filter": "region eq 'westus2'",
"orderBy": [
"cloudPcId"
],
"select": [
"cloudPcId",
"aadDeviceId",
"cloudPcName",
"userPrincipalName",
"provisioningStatus",
"region",
"deviceHealthStatus",
"deviceHealthStatusDateTime",
"recentDeviceHealthFailureCount",
"recentConnectionFailureCount",
"systemStatus",
"systemStatusDateTime"
],
"top": 10,
"skip": 0
}
Отклик
Ниже показан пример отклика.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
{
"TotalRowCount": 2,
"Schema": [
{
"Column": "cloudPcId",
"PropertyType": "String"
},
{
"Column": "aadDeviceId",
"PropertyType": "String"
},
{
"Column": "cloudPcName",
"PropertyType": "String"
},
{
"Column": "userPrincipalName",
"PropertyType": "String"
},
{
"Column": "provisioningStatus",
"PropertyType": "String"
},
{
"Column": "region",
"PropertyType": "String"
},
{
"Column": "deviceHealthStatus",
"PropertyType": "String"
},
{
"Column": "deviceHealthStatusDateTime",
"PropertyType": "DateTime"
},
{
"Column": "recentDeviceHealthFailureCount",
"PropertyType": "Int32"
},
{
"Column": "recentConnectionFailureCount",
"PropertyType": "Int64"
},
{
"Column": "systemStatus",
"PropertyType": "String"
},
{
"Column": "systemStatusDateTime",
"PropertyType": "DateTime"
}
],
"Values": [
[
"04e279c5-b228-4700-93c3-6f1339c7c86d",
"a8f78191-8e43-4165-9191-16867d372161",
"CPC-test1-VGTEK",
"bob@fabrikam.com",
"Provisioned",
"westus2",
"ErrorVMNotRunning",
"2023-06-26T03:55:04",
3,
0,
"",
null
],
[
"818ff73d-9764-4412-ad99-fc65a396daf3",
"daefef60-a912-4180-a5c0-f607e346878f",
"CPC-test2-C84W3",
"megan@fabrikam.com",
"Provisioned",
"westus2",
"ErrorVMNotRunning",
"2023-06-26T04:03:49",
3,
0,
"",
null
]
]
}
Пример 2. Получение еженедельного регионального агрегированного отчета о тенденциях недоступности облачных компьютеров
В следующем примере показано, как получить еженедельный региональный агрегированный отчет о тенденциях недоступности облачных компьютеров.
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
Content-Type: application/json
Prefer: include-unknown-enum-members
{
"reportName": "regionalInaccessibleCloudPcTrendReport",
"filter": "",
"select": [
"HostRegionName",
"CloudPcCount",
"WeeklyPeakInaccessibleCloudPcCount",
"Last24hPeakInaccessibleCloudPcCount",
"WeeklyInaccessibleTrend"
],
"search": "",
"skip": 0,
"top": 50
}
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/octet-stream
{
"TotalRowCount": 2,
"Schema": [
{
"Column": "HostRegionName",
"PropertyType": "String"
},
{
"Column": "CloudPcCount",
"PropertyType": "Int64"
},
{
"Column": "WeeklyPeakInaccessibleCloudPcCount",
"PropertyType": "Int64"
},
{
"Column": "Last24hPeakInaccessibleCloudPcCount",
"PropertyType": "Int64"
},
{
"Column": "WeeklyInaccessibleTrend",
"PropertyType": "String"
}
],
"Values": [
[ "Japan East", 46, 10, 5, "Increasing" ],
[ "East US", 1, 0, 0, "Decreasing" ]
]
}