Тип ресурса cloudPC
Пространство имен: 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 | Получение состояния проверки облачного компьютера. |
Список пользователей | Коллекция cloudPC | Выведите список устройств Cloud PC, которые относятся к вошедшего пользователя. |
Получение сведений о запуске для пользователя | cloudPcLaunchInfo | Получите cloudPcLaunchInfo для вошедшего пользователя. |
Получение журнала подключений | Коллекция cloudPcConnectivityEvent | Получите журнал подключений к облачному компьютеру. |
Получение поддерживаемых удаленных действий | Коллекция cloudPcRemoteActionCapability | Получите список поддерживаемых удаленных действий облачного компьютера для определенного устройства Cloud PC, включая имена действий и возможности. |
Получение результатов удаленного действия | Коллекция cloudPcRemoteActionResult | Получите результаты удаленного действия и проверка состояние определенного удаленного действия, выполненного на связанном облачном компьютере. |
Повторная установка агента партнера | Нет | Повторите установку для агентов партнеров, которые не удалось установить на облачном компьютере. |
Проверка массового изменения размера | коллекция cloudPcResizeValidateResult | Убедитесь, что набор устройств облачных компьютеров соответствует требованиям к массовому размеру. |
Создание snapshot | Нет | Создайте snapshot для определенного облачного компьютера. |
Получение моментальных снимков | коллекция cloudPcSnapshot | Получите список ресурсов cloudPcSnapshot для облачного компьютера. |
Получение состояния доступа к передней линии | frontlineCloudPcAccessState | Получите состояние доступа для переднего облачного компьютера. Возможные значения: unassigned , noLicensesAvailable , activationFailed , active , activating , standbyMode , unknownFutureValue . Участник noLicensesAvailable не рекомендуется использовать и перестанет возвращаться 30 сентября 2024 г. |
Массовая повторная подготовка удаленного действия (не рекомендуется) | Нет | Массовая повторная подготовка набора устройств облачных компьютеров с Intune управляемыми идентификаторами устройств. Этот API устарел и перестал возвращать данные 24 сентября 2023 г. В дальнейшем используйте ресурс cloudPcBulkReprovision . |
Массовое изменение размера (не рекомендуется) | Коллекция cloudPcRemoteActionResult | Выполните действие массового изменения размера, чтобы изменить размер группы облачных компьютеров, успешно прошедших проверку (cloudPC: validateBulkResize). Если какие-либо устройства не могут быть изменены, они помечаются как "изменение размера не удалось", в то время как остальные устройства предназначены provisioned для изменения размера. Этот API устарел и перестал возвращать данные 24 сентября 2023 г. В дальнейшем используйте ресурс cloudPcBulkResize . |
Удаленное действие массового восстановления (не рекомендуется) | cloudPcBulkRemoteActionResult | Восстановите несколько облачных компьютеров с помощью одного запроса, включающего идентификаторы Intune управляемых устройств, а также дату и время точки восстановления. Этот API устарел и перестал возвращать данные 24 сентября 2023 г. В дальнейшем используйте ресурс cloudPcBulkRestore . |
Получение результатов удаленных действий (не рекомендуется) | cloudPcRemoteActionResult | Проверьте результаты удаленных действий, указанных облачным компьютером , для устройства облачного компьютера. Этот API является устаревшим и перестанет возвращать данные 30 сентября 2024 г. В дальнейшем используйте API retrieveCloudPcRemoteActionResults . |
Получение состояния проверки (не рекомендуется) | cloudPcReviewStatus | Получение состояния проверки определенного облачного компьютера с помощью managedDeviceId. Этот API устарел и не возвращает данные 30 апреля 2024 г. В дальнейшем используйте API cloudPC: retrieveReviewStatus . |
Установка состояния проверки (не рекомендуется) | Нет | Задайте состояние проверки определенного облачного компьютера с помощью идентификатора управляемого устройства. Этот API устарел и не возвращает данные 30 апреля 2024 г. В дальнейшем используйте API cloudPC: setReviewStatus . |
Состояние проверки массового набора (не рекомендуется) | Нет | Задайте состояние проверки нескольких облачных компьютеров с помощью одного запроса, включающего идентификаторы Intune управляемых устройств. Этот API устарел и не возвращает данные 30 сентября 2024 г. В дальнейшем используйте ресурс cloudPcBulkSetReviewStatus . |
Свойства
Свойство | Тип | Описание |
---|---|---|
aadDeviceId | String | Идентификатор Microsoft Entra устройства облачного компьютера. |
allotmentDisplayName | String | Имя выделения разделяет лицензии клиента на небольшие пакеты или группы, которые помогают ограничить количество лицензий, доступных для использования в определенном назначении. Если provisioningType имеет значение dedicated , то имя выделения — null . Только для чтения. |
connectivityResult | cloudPcConnectivityResult | Работоспособность подключения проверка результатом работы облачного компьютера, включая обновленную метку времени и возможность подключения облачного компьютера. |
deviceRegionName | String | Имя географического региона, в котором в настоящее время подготовлен облачный компьютер. Например, westus3 , eastus2 и southeastasia . Только для чтения. |
disasterRecoveryCapability | cloudPcDisasterRecoveryCapability | Состояние аварийного восстановления облачного компьютера, включая основной регион, дополнительный регион и тип возможности. Значение по умолчанию указывает null , что параметр аварийного восстановления отключен. Получение ответа со свойством $select disasterRecoveryCapability и $filter его по disasterRecoveryCapability/{subProperty} URL-адресу запроса. Дополнительные сведения см. в разделе Пример 4. Перечисление облачных компьютеров, отфильтрованных по типу возможностей аварийного восстановления. Только для чтения. |
diskEncryptionState | cloudPcDiskEncryptionState | Шифрование диска, примененное к облачному компьютеру. Возможные значения: notAvailable , notEncrypted , encryptedUsingPlatformManagedKey , encryptedUsingCustomerManagedKey и unknownFutureValue . |
displayName | String | Отображаемое имя облачного компьютера. |
gracePeriodEndDateTime | DateTimeOffset | Дата и время окончания льготного периода, а также повторная подготовка или отзыв. Требуется только в том случае, если состояние равно inGracePeriod . Метка времени отображается в формате ISO 8601 и в формате UTC. Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z . |
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 . Это свойство поддерживает только облачные компьютеры с сменой работы. |
provisioningPolicyId | String | Идентификатор политики подготовки облачного компьютера. |
provisioningPolicyName | String | Политика подготовки, применяемая во время подготовки облачных компьютеров. |
provisioningType | cloudPcProvisioningType | Тип лицензий, используемых при подготовке облачных компьютеров с помощью этой политики. Возможные значения: dedicated , shared , unknownFutureValue ,sharedByUser , sharedByEntraGroup . Необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующие значения из этого развиваемого перечисления: sharedByUser , sharedByEntraGroup . Значение по умолчанию — dedicated . ВНИМАНИЕ! Участник shared не рекомендуется использовать и перестанет возвращаться 30 апреля 2027 г.; в будущем используйте sharedByUser его. |
servicePlanId | String | Идентификатор плана обслуживания облачного компьютера. |
servicePlanName | String | Имя плана обслуживания облачного компьютера. |
servicePlanType | cloudPcServicePlanType | Тип плана обслуживания облачного компьютера. |
status | microsoft.graph.cloudPcStatus | Состояние облачного компьютера. Возможные значения: notProvisioned , , provisioned provisioning , inGracePeriod , deprovisioning , failed , provisionedWithWarnings , , resizing , restoring , pendingProvision , unknownFutureValue , movingRegion , resizePendingLicense , , modifyingSingleSignOn , . preparing Необходимо использовать Prefer: include-unknown-enum-members заголовок запроса, чтобы получить следующие значения из этого развиваемого перечисления: movingRegion , resizePendingLicense , modifyingSingleSignOn , . preparing |
statusDetails (не рекомендуется) | cloudPcStatusDetails | Сведения о состоянии облачного компьютера. Например, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null } . Это свойство устарело и больше не будет поддерживаться с 31 августа 2024 г. Вместо этого используйте statusDetail. |
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 . |
userPrincipalName | String | Имя участника-пользователя (UPN) пользователя, назначенного облачному компьютеру. |
Значения 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 | Указывает, что облачный компьютер обновляет параметр единого входа. |
Подготовка | Указывает, что облачный компьютер готовится с определенной конфигурацией ИТ-администратора (приложения, конфигурация и безопасность), отображается после состояния подготовки. Применяется только к общим устройствам frontline. |
значения frontlineCloudPcAccessState
Member | Описание |
---|---|
unassigned | Установите значение unassigned, если облачный компьютер не использует лицензии общего использования. Значение по умолчанию — unassigned . |
noLicensesAvailable (не рекомендуется) | Указывает, что используются все лицензии общего использования. Участник noLicensesAvailable не рекомендуется использовать и перестанет возвращаться 30 сентября 2024 г. |
activationFailed | Указывает, что активация внешнего облачного компьютера завершилась сбоем после того, как пользователь запросил внешний облачный компьютер. |
активный | Указывает, что передний облачный компьютер находится в активном состоянии с назначенной лицензией общего использования, и пользователь может подключиться к облачному компьютеру. |
Активация | Указывает, что пользователь попросил подключить облачный компьютер и служба запускается. |
standbyMode | Указывает, что перед завершением работы и освобождением облачный компьютер находится в режиме ожидания. Внешний облачный компьютер в режиме ожидания по-прежнему доступен пользователю. |
unknownFutureValue | Изменяемое значение перечисления sentinel. Не используйте. |
Связи
Отсутствуют.
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"allotmentDisplayName": "String",
"connectivityResult": "String",
"deviceRegionName": "String",
"disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
"diskEncryptionState": "String",
"displayName": "String",
"gracePeriodEndDateTime": "String (timestamp)",
"id": "String (identifier)",
"imageDisplayName": "String",
"lastLoginResult": "String",
"lastModifiedDateTime": "String (timestamp)",
"lastRemoteActionResult": "String",
"managedDeviceId": "String",
"managedDeviceName": "String",
"onPremisesConnectionName": "String",
"powerState": "String",
"osVersion": "String",
"partnerAgentInstallResults": "String",
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"status": "String",
"userAccountType": "String",
"userPrincipalName": "String"
}