Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет управляемый облаком виртуальный рабочий стол. Этот облачный компьютер также зарегистрирован в Intune и управляется через портал Microsoft Endpoint Manager, поэтому облачный компьютер также имеет соответствующий идентификатор устройства, управляемый Intune.
Методы
| Метод | Тип возвращаемых данных | Описание |
|---|---|---|
| Перечисление облачных ПК | Коллекция cloudPC | Перечисление свойств и связей объектов Cloud PC. |
| Получение cloudPC | cloudPC | Чтение свойств и связей объекта Cloud PC. |
| Получение подготовленных облачных компьютеров | Коллекция cloudPC | Получите все подготовленные облачные компьютеры определенного плана обслуживания для пользователей в группе пользователей Microsoft Entra. |
| Изменение типа учетной записи пользователя | Нет | Измените тип учетной записи пользователя на определенном облачном компьютере. |
| Окончание льготного периода | Нет | Окончание льготного периода для объекта Cloud PC. |
| Включение питания | Нет | Включите определенный объект Windows Frontline Cloud PC. Это действие поддерживает сценарии администрирования MEM. |
| Выключение питания | Нет | Отключите определенный объект Windows Frontline Cloud PC. Это действие поддерживает сценарии администрирования MEM. |
| Перезагрузки | Нет | Перезагрузите определенный объект Cloud PC. |
| Rename | Нет | Переименуйте определенный объект Cloud PC. Используйте этот API для обновления displayName для сущности Cloud PC. |
| Повторная подготовка | Нет | Повторная подготовка объекта Cloud PC. |
| Resize | Нет | Обновите или понизите существующий облачный компьютер до конфигурации с новым виртуальным ЦП (vCPU) и размером хранилища. |
| Start | Нет | Запустите определенный облачный компьютер. В настоящее время поддерживаются только Windows 365 облачные компьютеры frontline. |
| Stop | Нет | Остановите определенное облако. В настоящее время поддерживаются только Windows 365 облачные компьютеры frontline. |
| Устранение неполадок | Нет | Устранение неполадок с определенным объектом Cloud PC. Используйте этот API для проверка состояния работоспособности облачного компьютера и узла сеансов. |
| Восстановление | Нет | Восстановление объекта Cloud PC до предыдущего состояния из snapshot. |
| Установка состояния проверки | Нет | Задайте состояние проверки определенного облачного компьютера с помощью идентификатора облачного компьютера. |
| Получение состояния проверки | cloudPcReviewStatus | Получение состояния проверки облачного компьютера. |
| Получение количества облачных компьютеров по состоянию | коллекция cloudPcStatusSummary | Получите число облачных компьютеров , сгруппированных по состоянию. |
| Список пользователей | Коллекция cloudPC | Выведите список устройств Cloud PC, которые относятся к вошедшего пользователя. |
| Получение сведений о запуске | cloudPcLaunchDetail | Получите cloudPcLaunchDetail для определенного облачного компьютера, который принадлежит текущему вошедшего пользователя. |
| Получение журнала подключений | Коллекция cloudPcConnectivityEvent | Получите журнал подключений к облачному компьютеру. |
| Получение поддерживаемых удаленных действий | Коллекция cloudPcRemoteActionCapability | Получите список поддерживаемых удаленных действий облачного компьютера для определенного устройства Cloud PC, включая имена действий и возможности. |
| Получение результатов удаленного действия | Коллекция cloudPcRemoteActionResult | Получите результаты удаленного действия и проверка состояние определенного удаленного действия, выполненного на связанном облачном компьютере. |
| Повторная установка агента партнера | Нет | Повторите установку для агентов партнеров, которые не удалось установить на облачном компьютере. |
| Проверка массового изменения размера | коллекция cloudPcResizeValidateResult | Убедитесь, что набор устройств облачных компьютеров соответствует требованиям к массовому размеру. |
| Создание snapshot | Нет | Создайте snapshot для определенного облачного компьютера. |
| Получение моментальных снимков | коллекция cloudPcSnapshot | Получите список ресурсов cloudPcSnapshot для облачного компьютера. |
| Получение состояния доступа к передней линии | frontlineCloudPcAccessState | Получите состояние доступа для переднего облачного компьютера. Возможные значения: unassigned, noLicensesAvailable, activationFailed, active, activating, standbyMode, unknownFutureValue. Член noLicensesAvailable является устаревшим и не возвращается 30 сентября 2024 г. |
| Получение сведений о запуске (не рекомендуется) | cloudPcLaunchInfo | Получите cloudPCLaunchInfo для определенного облачного компьютера, который принадлежит текущему вошедшего пользователя. Этот API является устаревшим и перестанет возвращать данные 30 октября 2026 г. В дальнейшем используйте API получения сведений о запуске . |
| Получение сведений об облачном компьютере с интерфейсом | frontlineCloudPcDetail | Получите frontlineCloudPcDetailвнешнего облачного компьютера. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| aadDeviceId | String | Идентификатор Microsoft Entra устройства облачного компьютера. |
| allotmentDisplayName | String | Имя выделения разделяет лицензии клиента на небольшие пакеты или группы, которые помогают ограничить количество лицензий, доступных для использования в определенном назначении. Если provisioningType имеет значение dedicated, то имя выделения — null. Только для чтения. |
| connectivityResult | cloudPcConnectivityResult | Работоспособность подключения проверка результатом работы облачного компьютера, включая обновленную метку времени и возможность подключения облачного компьютера. |
| deviceRegionName | String | Имя географического региона, в котором в настоящее время подготовлен облачный компьютер. Например, westus3, eastus2и southeastasia. Только для чтения. |
| disasterRecoveryCapability | cloudPcDisasterRecoveryCapability | Состояние аварийного восстановления облачного компьютера, включая основной регион, дополнительный регион и тип возможности. Значение по умолчанию указывает null , что параметр аварийного восстановления отключен. Получение ответа со свойством $selectdisasterRecoveryCapability и $filter его по disasterRecoveryCapability/{subProperty} URL-адресу запроса. Дополнительные сведения см. в разделе Пример 3. Перечисление облачных компьютеров, отфильтрованных по типу возможностей аварийного восстановления. Только для чтения. |
| diskEncryptionState | cloudPcDiskEncryptionState | Шифрование диска, примененное к облачному компьютеру. Возможные значения: notAvailable, notEncrypted, encryptedUsingPlatformManagedKey, encryptedUsingCustomerManagedKey и unknownFutureValue. |
| displayName | String | Отображаемое имя облачного компьютера. |
| gracePeriodEndDateTime | DateTimeOffset | Дата и время окончания льготного периода, а также повторная подготовка или отзыв. Требуется только в том случае, если состояние равно inGracePeriod. Метка времени отображается в формате ISO 8601 и в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z. |
| groupDetail | cloudPcEntraGroupDetail | Сведения о группе Microsoft Entra (например, идентификатор и отображаемое имя) для группы идентификаторов Entra, связанной с назначением резервного облачного компьютера пользователя. Только для чтения. |
| id | String | Уникальный идентификатор облачного компьютера. Только для чтения. |
| imageDisplayName | String | Имя образа ОС, который находится на облачном компьютере. |
| lastLoginResult | cloudPcLoginResult | Последний результат входа облачного компьютера. Например, { "time": "2014-01-01T00:00:00Z"}. |
| lastModifiedDateTime | DateTimeOffset | Дата и время последнего изменения облачного компьютера. Тип Timestamp представляет сведения о времени и дате с использованием формата ISO 8601 (всегда применяется формат UTC). Например, полночь в формате UTC 1 января 2014 г. имеет значение 2014-01-01T00:00:00Z. |
| lastRemoteActionResult | cloudPcRemoteActionResult | Последний результат удаленного действия корпоративных облачных компьютеров. Поддерживаемые удаленные действия: Reboot, Rename, Reprovision, Restore, , Troubleshoot. |
| managedDeviceId | String | Идентификатор Intune устройства облачного компьютера. |
| managedDeviceName | String | Intune имя устройства облачного компьютера. |
| onPremisesConnectionName | String | Azure сетевое подключение, которое применяется во время подготовки облачных компьютеров. |
| osVersion | cloudPcOperatingSystem | Версия операционной системы (ОС), подготавливаемая на облачных компьютерах. Допустимые значения: windows10, windows11, unknownFutureValue. |
| partnerAgentInstallResults | коллекция cloudPcPartnerAgentInstallResult | Результаты установки каждого агента-партнера на облачном компьютере. |
| powerState | cloudPcPowerState | Состояние питания облачного компьютера. Допустимые значения: running, poweredOff, unknown. Это свойство поддерживает только облачные компьютеры с сменой работы. |
| productType | cloudPcProductType | Тип продукта облачного компьютера. Допустимые значения: enterprise, frontline, devBox, powerAutomate, business, unknownFutureValue. Доступные планы обслуживания и цены на enterprise, frontlineи businessсм. в разделе Windows 365 для бизнеса. Сведения о ценах для см. в разделе Цены на devBoxMicrosoft Dev Box. Доступные планы и цены для см. в разделе Цены на powerAutomatePower Automate. Значение по умолчанию — enterprise. Поддерживает $filter и $select. Дополнительные сведения см. в разделе Пример 4. Перечисление облачных компьютеров, отфильтрованных по типу продукта. Только для чтения. |
| provisionedDateTime | DateTimeOffset | Последняя подготовленная дата и время, автоматически созданные и назначенные во время первоначальной подготовки или последующей повторной подготовки облачного компьютера. Тип метки времени представляет сведения о дате и времени в формате ISO 8601 и всегда находится в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z. |
| provisioningPolicyId | String | Идентификатор политики подготовки облачного компьютера. |
| provisioningPolicyName | String | Политика подготовки, применяемая во время подготовки облачных компьютеров. |
| provisioningType | cloudPcProvisioningType | Тип лицензий, используемых при подготовке облачных компьютеров с помощью этой политики. Допустимые значения: dedicated, shared, unknownFutureValue, sharedByUser, sharedByEntraGroup, reserve.
Prefer: include-unknown-enum-members Используйте заголовок запроса, чтобы получить следующие значения из этого развиваемого перечисления: sharedByUser, sharedByEntraGroup, reserve. Значение по умолчанию — dedicated. Участник shared является устаревшим и перестанет возвращаться 30 апреля 2027 г. в дальнейшем используйте sharedByUser его. |
| servicePlanId | String | Идентификатор плана обслуживания облачного компьютера. |
| servicePlanName | String | Имя плана обслуживания облачного компьютера. |
| servicePlanType | cloudPcServicePlanType | Тип плана обслуживания облачного компьютера. |
| sharedDeviceDetail | cloudPcFrontlineSharedDeviceDetail | Указывает сведения об устройстве облачного компьютера, связанном с планом общей службы передней линии, включая имя участника-пользователя и дату и время начала сеанса. |
| status | cloudPcStatus | Состояние облачного компьютера. Возможные значения: notProvisioned, , provisioning, provisionedinGracePeriod, , deprovisioning, failed, provisionedWithWarnings, resizing, restoring, pendingProvision, unknownFutureValue, movingRegion, , resizePendingLicense, modifyingSingleSignOn, refreshPolicyConfiguration, и preparing.
Prefer: include-unknown-enum-members Используйте заголовок запроса, чтобы получить следующие значения из этого развиваемого перечисления: movingRegion, resizePendingLicense, modifyingSingleSignOn, refreshPolicyConfigurationи preparing. |
| statusDetail | cloudPcStatusDetail | Указывает подробное состояние, связанное с облачным компьютером, включая код ошибки или предупреждения, сообщение об ошибке и предупреждение, дополнительные сведения. Например, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. |
| connectionSetting | cloudPcConnectionSetting | Параметр подключения облачного компьютера. Возможные значения: enableSingleSignOn. Только для чтения. |
| userAccountType | cloudPcUserAccountType | Тип учетной записи пользователя на подготовленных облачных компьютерах. Допустимые значения: standardUser, administrator, unknownFutureValue. |
| userExperienceType | cloudPcUserExperienceType | Указывает тип облачного объекта, к который может получить доступ конечный пользователь. Допустимые значения: cloudPc, cloudApp, unknownFutureValue. Если задано значение cloudPc, это означает, что пользователь может получить доступ ко всему рабочему столу. Если задано значение cloudApp, это означает, что пользователь может получить доступ только к облачным приложениям, опубликованным в соответствии с соответствующей политикой подготовки. Так как интерфейс облачных приложений также создает устройства облачных компьютеров, которые отображаются в списке устройств облачных компьютеров, это свойство помогает различать их. Значение по умолчанию — cloudPc. Это свойство определяется в политике подготовки. |
| userDetail | cloudPcEntraUserDetail | Сведения о пользователе (например, идентификатор и отображаемое имя) для пользователя, связанного с назначением резервного облачного компьютера. Только для чтения. |
| userPrincipalName | String | Имя участника-пользователя (UPN) пользователя, назначенного облачному компьютеру. |
| connectionSettings (не рекомендуется) | cloudPcConnectionSettings | Параметры подключения облачного компьютера. Возможные значения: enableSingleSignOn. Только для чтения. Это свойство устарело, и повторное перенастройка данных прекращена 31 августа 2024 г. В дальнейшем используйте свойство connectionSetting . |
| frontlineCloudPcAvailability (не рекомендуется) | frontlineCloudPcAvailability | Текущая доступность облачного компьютера, назначаемого передней линией. Возможные значения: notApplicable, available, notAvailableи unknownFutureValue. Значение по умолчанию — notApplicable. Только для чтения. Это свойство устарело и перестанет возвращать данные 30 октября 2025 г. В дальнейшем используйте API retrieveFrontlineCloudPcDetail . |
| statusDetails (не рекомендуется) | cloudPcStatusDetails | Сведения о состоянии облачного компьютера. Например, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. Это свойство устарело и больше не будет поддерживаться с 31 августа 2024 г. Вместо этого используйте statusDetail. |
Значения cloudPcDiskEncryptionState
| Member | Описание |
|---|---|
| notAvailable | Облачный компьютер не подготовлен или находится в состоянии, когда шифрование недоступно. |
| notEncrypted | Облачный компьютер должен быть зашифрован, но шифрование еще не выполнено (зарезервировано, не должно происходить). |
| encryptedUsingPlatformManagedKey | Облачный компьютер шифруется с помощью ключа, управляемого платформой. Этот элемент является значением по умолчанию, если ключ, управляемый клиентом, не включен. |
| encryptedUsingCustomerManagedKey | Облачный компьютер шифруется с помощью ключа, управляемого клиентом. |
| unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
Значения cloudPcPowerState
| Member | Описание |
|---|---|
| Запущена | Состояние облачного компьютера запущено. |
| poweredOff | Состояние облачного компьютера отключено. |
| unknown | Состояние облачного компьютера неизвестно. |
Значения cloudPcStatus
В следующей таблице перечислены члены расширяемого перечисления. Чтобы получить следующие значения в этой изменяемой перечислении, необходимо использовать Prefer: include-unknown-enum-members заголовок запроса: movingRegion, resizePendingLicense, modifyingSingleSignOn, . preparing
| Member | Описание |
|---|---|
| NotProvisioned | Облачный компьютер еще не подготовлен. |
| Подготовки | Выполняется подготовка облачных компьютеров. |
| Подготовлено | Облачный компьютер подготовлен, и пользователи могут получить к нему доступ. |
| inGracePeriod | Облачный компьютер находится в течение одной недели льготного периода до отзыва. |
| отзыв | Облачный компьютер отзывается. |
| Сбой при | Операция на облачном компьютере завершилась сбоем. |
| provisionedWithWarnings | Облачный компьютер подготовлен, и пользователи могут получить к нему доступ с некоторыми предупреждениями. Пользователь может продолжать использовать этот облачный компьютер. |
| Изменение размера | Размер облачного компьютера выполняется. |
| pendingProvision | Подготовка ожидается на облачном компьютере. В этом случае число облачных компьютеров в льготный период больше, чем общее количество доступных лицензий. |
| Восстановление | Облачный компьютер восстанавливается. |
| unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
| movingRegion | Указывает, что облачный компьютер перемещается из одного региона в другой. |
| resizePendingLicense | Указывает, что процесс изменения размера облачного компьютера был инициирован, но не может быть завершен, так как целевая лицензия не определена. В настоящее время клиент ожидает действий по устранению проблемы с лицензированием. |
| modifyingSingleSignOn | Указывает, что облачный компьютер обновляет параметр единого входа. |
| refreshPolicyConfiguration | Указывает, что облачный компьютер находится в процессе обновления новых конфигураций политики. |
| Подготовка | Указывает, что облачный компьютер готовится с определенной конфигурацией ИТ-администратора (приложения, конфигурация и безопасность), отображается после состояния подготовки. Применяется только к общим устройствам frontline. |
значения frontlineCloudPcAccessState
| Member | Описание |
|---|---|
| unassigned | Установите значение unassigned, если облачный компьютер не использует лицензии общего использования. Значение по умолчанию — unassigned. |
| noLicensesAvailable (не рекомендуется) | Указывает, что используются все лицензии общего использования. Участник noLicensesAvailable не рекомендуется использовать и перестанет возвращаться 30 сентября 2024 г. |
| activationFailed | Указывает, что активация внешнего облачного компьютера завершилась сбоем после того, как пользователь запросил внешний облачный компьютер. |
| Активных | Указывает, что передний облачный компьютер находится в активном состоянии с назначенной лицензией общего использования, и пользователь может подключиться к облачному компьютеру. |
| Активация | Указывает, что пользователь попросил подключить облачный компьютер и служба запускается. |
| standbyMode | Указывает, что перед завершением работы и освобождением облачный компьютер находится в режиме ожидания. Внешний облачный компьютер в режиме ожидания по-прежнему доступен пользователю. |
| unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
Значения cloudPcProductType
| Member | Описание |
|---|---|
| Предприятия | Значение, используемое по умолчанию. Указывает тип продукта облачных компьютеров для крупных предприятий, которые хотят развернуть облачные компьютеры в своей организации для неограниченного числа пользователей. |
| Фронта | Указывает тип продукта облачного компьютера для сотрудников переднего и частичного рабочего времени для совместного использования устройств, что позволяет им использовать облачные компьютеры во время смен. |
| devBox | Указывает тип продукта облачного компьютера, предварительно настроенный с помощью инструментов, служб и ресурсов для разработчиков, команд разработчиков и ИТ-специалистов. |
| powerAutomate | Указывает тип продукта облачного компьютера для клиентов Power Automate, которые будут запускать на своих облачных компьютерах обслуживаемые и автоматические RRP (роботизированная автоматизация процессов). |
| Бизнес | Указывает тип продукта облачных компьютеров для клиентов малого бизнеса с 300 пользователями. |
| unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
Связи
Отсутствуют.
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"allotmentDisplayName": "String",
"connectivityResult": "String",
"connectionSettings": {"@odata.type": "microsoft.graph.cloudPcConnectionSettings"},
"deviceRegionName": "String",
"disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
"diskEncryptionState": "String",
"displayName": "String",
"gracePeriodEndDateTime": "String (timestamp)",
"groupDetail": {"@odata.type": "microsoft.graph.cloudPcEntraGroupDetail"},
"id": "String (identifier)",
"imageDisplayName": "String",
"lastLoginResult": "String",
"lastModifiedDateTime": "String (timestamp)",
"lastRemoteActionResult": "String",
"managedDeviceId": "String",
"managedDeviceName": "String",
"onPremisesConnectionName": "String",
"osVersion": "String",
"partnerAgentInstallResults": "String",
"powerState": "String",
"provisionedDateTime": "String (timestamp)",
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"sharedDeviceDetail": {"@odata.type": "microsoft.graph.cloudPcFrontlineSharedDeviceDetail"},
"status": "String",
"userAccountType": "String",
"userExperienceType": "String",
"userDetail": {"@odata.type": "microsoft.graph.cloudPcEntraUserDetail"},
"userPrincipalName": "String"
}