cloudPcProvisioningPolicy 资源类型

命名空间：microsoft.graph

重要

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

表示云电脑预配策略。

方法

方法	返回类型	Description
List	cloudPcProvisioningPolicy 集合	列出 cloudPcProvisioningPolicy 对象的属性和关系。
获取	cloudPcProvisioningPolicy	读取 cloudPcProvisioningPolicy 对象的属性和关系。
创建	cloudPcProvisioningPolicy	创建新的 cloudPcProvisioningPolicy 对象。
更新	cloudPcProvisioningPolicy	更新 cloudPcProvisioningPolicy 对象的属性。
删除	None	删除 cloudPcProvisioningPolicy 对象。
Assign	无	将 cloudPcProvisioningPolicy 分配给用户组。
应用	None	将当前 预配策略 配置应用于指定策略下的所有云电脑设备。 目前，只能更改区域。
应用配置	None	按 ID 更新一组云电脑设备的 预配策略 配置。

属性

属性	类型	说明
alternateResourceUrl	String	链接到此预配策略的备用资源的 URL。 此为只读属性。
autopatch	cloudPcProvisioningPolicyAutopatch	Windows 自动修补的特定设置，使客户能够在云电脑上体验它。 当租户在 Windows 自动修补中注册并且 microsoftManagedDesktop 属性的 managedType 设置为 starterManaged时，这些设置将生效。 支持 $select。
autopilotConfiguration	cloudPcAutopilotConfiguration	Windows Autopilot 的特定设置，使Windows 365客户能够在云电脑上体验它。 支持 $select。
cloudPcGroupDisplayName	String	云电脑所在的云电脑组的显示名称。 此为只读属性。
cloudPcNamingTemplate	String	用于命名使用此策略预配的云电脑的模板。 模板可以包含自定义文本和替换令牌，包括 %USERNAME:x% 和 %RAND:x%，分别表示用户名和随机生成的数字。 例如， CPC-%USERNAME:4%-%RAND:5% 表示云电脑的名称以 CPC-开头，后跟一个四个字符的用户名、一个字符 - ，然后是五个随机字符。 模板生成的文本的总长度不能超过 15 个字符。 支持 $filter、$select 和 $orderby。
说明	String	预配策略说明。 支持 $filter、$select 和 $orderBy。
displayName	String	预配策略的显示名称。
domainJoinConfigurations	cloudPcDomainJoinConfiguration 集合	指定按优先级排序的列表，说明云电脑加入Microsoft Entra ID (Azure AD) 的方式。 支持 $select。
enableSingleSignOn	布尔值	True 如果单一登录可以访问预配的云电脑，则为 。 False 指示预配的云电脑不支持此功能。 默认值为 false。 Windows 365用户可以使用单一登录通过无密码选项 (Microsoft Entra ID进行身份验证，例如 FIDO 密钥) 访问其云电脑。 可选。
gracePeriodInHours	Int32	在重新预配/取消预配之前等待的小时数。 只读。
id	String	与预配策略关联的唯一标识符。 创建新预配策略期间会自动填充此 ID。 此为只读属性。 支持 $filter、$select 和 $orderBy。
imageDisplayName	String	用于预配的操作系统映像的显示名称。 例如，Windows 11 Preview + Microsoft 365 Apps 23H2 23H2。 支持 $filter、$select 和 $orderBy。
imageId	String	表示用于预配新云电脑的操作系统映像的唯一标识符。 库类型图像的格式为：{publisherName_offerName_skuName}。 每个参数支持的值为： 发行人： Microsoftwindowsdesktop 提供： windows-ent-cpc sku：21h1-ent-cpc-m365、21h1-ent-cpc-os、、20h2-ent-cpc-os20h2-ent-cpc-m365、20h1-ent-cpc-m36520h1-ent-cpc-os、19h2-ent-cpc-m365、 和19h2-ent-cpc-os 支持 $filter、$select 和 $orderBy。
imageType	cloudPcProvisioningPolicyImageType	操作系统映像的类型 (用于在云电脑上进行预配的自定义或库) 。 可取值为：gallery、custom。 默认值为 gallery。 支持$filter、$select和$orderBy。
localAdminEnabled	布尔值	如果 true为 ，则为云电脑启用本地管理员; false 指示未为云电脑启用本地管理员。 默认值为 false。 支持 $filter、$select 和 $orderBy。
managedBy	cloudPcManagementService	指示管理预配策略的服务。 可能的值是：windows365、devBox、unknownFutureValue、rpaBox。 默认值为 windows365。 必须使用 Prefer: include-unknown-enum-members 请求标头来获取此 可演变枚举中的以下值： rpaBox。 支持 $filter、$select 和 $orderBy。
microsoftManagedDesktop	microsoftManagedDesktop	microsoftManagedDesktop 的特定设置，使Microsoft托管桌面客户能够获取云电脑的设备托管体验。 若要使 microsoftManagedDesktop 提供更多价值，管理员需要在其中指定某些设置。 支持 $filter、$select 和 $orderBy。
provisioningType	cloudPcProvisioningType	指定使用此策略预配云电脑时要使用的许可证类型。 可能的值为 dedicated、、sharedByEntraGroupsharedunknownFutureValuesharedByUser。 必须使用 Prefer: include-unknown-enum-members 请求标头从此 可演变枚举中获取以下值： sharedByUser、 sharedByEntraGroup。 成员 shared 已弃用，将于 2027 年 4 月 30 日停止返回;今后，请使用 成员 sharedByUser 。 例如，一个 dedicated 服务计划只能分配给一个用户，并且只能预配一台云电脑。 shared和 sharedByUser 计划要求客户购买共享服务计划。 购买的每个共享许可证最多可以启用三台云电脑，一次只能有一个用户登录。 该计划 sharedByEntraGroup 还需要购买共享服务计划。 此计划下的每个共享许可证都可以启用一台云电脑，该电脑根据此策略的分配为组共享。 默认情况下，如果在创建 cloudPcProvisioningPolicy 时未指定 provisioningType，则许可证类型dedicated为 。 创建 cloudPcProvisioningPolicy 后，无法更改此属性。
windowsSetting	cloudPcWindowsSettings	指示在为此预配策略创建云电脑期间要配置的特定 Windows 设置。 支持 $select。
domainJoinConfiguration (已弃用)	cloudPcDomainJoinConfiguration	指定云电脑加入Microsoft Entra ID的方式。 domainJoinConfiguration 属性已弃用，将于 2024 年 5 月 31 日停止返回数据。 今后，请使用 domainJoinConfigurations 属性。
onPremisesConnectionId (已弃用)	String	cloudPcOnPremisesConnection 的 ID。 若要确保云电脑具有网络连接并加入域，请选择与云电脑服务验证的虚拟网络的连接。 onPremisesConnectionId 属性已弃用，将于 2024 年 5 月 31 日停止返回数据。 今后，请使用 domainJoinConfigurations 属性。
windowsSettings (已弃用)	cloudPcWindowsSettings	为此预配策略创建云电脑期间要配置的特定 Windows 设置。 支持 $select。 windowsSettings 属性已弃用，将于 2024 年 1 月 31 日停止返回数据。 今后，请使用 windowsSetting 属性。

cloudPcProvisioningType 值

下表列出了 可演变枚举的成员。 必须使用 Prefer: include-unknown-enum-members 请求标头来获取此可演变枚举中的以下值： sharedByUser、 sharedByEntraGroup。

成员	说明
耿耿	指示专用许可证用于预配云电脑。 默认值。
共享 (已弃用)	指示共享许可证用于预配云电脑。 成员 shared 已弃用，将于 2027 年 4 月 30 日停止返回。 今后，请使用 成员 sharedByUser 。
unknownFutureValue	可演变枚举 sentinel 值。 请勿使用。
sharedByUser	指示为分配组中的每个用户预配专用云电脑时的预配策略。 用户始终连接到同一台云电脑。 但是，云电脑可用性受活动会话总数的限制。
sharedByEntraGroup	指示与Microsoft Entra (Azure AD) 组共享的云电脑关联的预配策略。 预配共享云电脑后，Microsoft Entra ID分配组中的任何用户都可以连接到该电脑。 用户可能在每个连接上连接到不同的云电脑，并且可用性受预配的云电脑数量的限制。

关系

关系	类型	说明
assignments	cloudPcProvisioningPolicyAssignment 集合	预配策略分配的已定义集合。 表示Microsoft Entra ID中分配了预配策略的Microsoft 365 个组和安全组的集合。 仅在 $expand 上返回。 有关如何获取分配关系的示例，请参阅 获取 cloudPcProvisioningPolicy。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
  "alternateResourceUrl": "String",
  "autopatch": {"@odata.type": "microsoft.graph.cloudPcProvisioningPolicyAutopatch"},
  "autopilotConfiguration": {"@odata.type": "microsoft.graph.cloudPcAutopilotConfiguration"},
  "cloudPcGroupDisplayName": "String",
  "cloudPcNamingTemplate": "String",
  "description": "String",
  "displayName": "String",
  "domainJoinConfiguration": {
    "@odata.type": "microsoft.graph.cloudPcDomainJoinConfiguration"
  },
  "domainJoinConfigurations": [{"@odata.type": "microsoft.graph.cloudPcDomainJoinConfiguration"}],
  "enableSingleSignOn": "Boolean",
  "gracePeriodInHours": "Int32",
  "id": "String (identifier)",
  "imageDisplayName": "String",
  "imageId": "String",
  "imageType": "String",
  "localAdminEnabled": "Boolean",
  "managedBy": "String",
  "microsoftManagedDesktop": {
    "@odata.type": "microsoft.graph.microsoftManagedDesktop"
  },
  "onPremisesConnectionId": "String",
  "provisioningType": "String",
  "windowsSetting": {
    "@odata.type": "microsoft.graph.cloudPcWindowsSetting"
  },
  "windowsSettings": {
    "@odata.type": "microsoft.graph.cloudPcWindowsSettings"
  }
}