Update cloudPcProvisioningPolicy

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a cloudPcProvisioningPolicy object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) CloudPC.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application CloudPC.ReadWrite.All Not available.

HTTP request

PATCH /deviceManagement/virtualEndpoint/provisioningPolicies/{id}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the cloudPcProvisioningPolicy object.

The following table shows the properties that can be updated for the cloudPcProvisioningPolicy.

Property Type Description
autopatch cloudPcProvisioningPolicyAutopatch The specific settings for Windows Autopatch that enable its customers to experience it on Cloud PC. The settings take effect when the tenant enrolls in Windows Autopatch and the managedType of the microsoftManagedDesktop property is set as starterManaged.
autopilotConfiguration cloudPcAutopilotConfiguration The specific settings for Windows Autopilot that enable Windows 365 customers to experience it on Cloud PC.
description String The provisioning policy description.
displayName String The display name for the provisioning policy.
domainJoinConfigurations cloudPcDomainJoinConfiguration collection Specifies a list ordered by priority on how Cloud PCs join Microsoft Entra ID.
enableSingleSignOn Boolean True if the provisioned Cloud PC can be accessed by single sign-on. False indicates that the provisioned Cloud PC doesn't support this feature. Default value is false. Windows 365 users can use single sign-on to authenticate to Microsoft Entra ID with passwordless options (for example, FIDO keys) to access their Cloud PC. Optional.
imageDisplayName String The display name for the OS image you're provisioning.
imageId String The ID of the OS image you want to provision on Cloud PCs. The format for a gallery type image is: {publisher_offer_sku}. Supported values for each of the parameters are as follows:
  • publisher: Microsoftwindowsdesktop.
  • offer: windows-ent-cpc.
  • sku: 21h1-ent-cpc-m365, 21h1-ent-cpc-os, 20h2-ent-cpc-m365, 20h2-ent-cpc-os, 20h1-ent-cpc-m365, 20h1-ent-cpc-os, 19h2-ent-cpc-m365 and 19h2-ent-cpc-os.
imageType cloudPcProvisioningPolicyImageType The type of OS image (custom or gallery) you want to provision on Cloud PCs. Possible values are: gallery, custom.
microsoftManagedDesktop microsoftManagedDesktop The specific settings to microsoftManagedDesktop that enables Microsoft Managed Desktop customers to get device managed experience for Cloud PC. To enable microsoftManagedDesktop to provide more value, an admin needs to specify certain settings in it.
windowsSetting cloudPcWindowsSettings Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports $select.
domainJoinConfiguration (deprecated) cloudPcDomainJoinConfiguration Specifies how Cloud PCs join Microsoft Entra ID. The domainJoinConfiguration property is deprecated and will stop returning data on May 31, 2024. Going forward, use the domainJoinConfigurations property.
onPremisesConnectionId (deprecated) String The ID of the cloudPcOnPremisesConnection. To ensure that Cloud PCs have network connectivity and that they domain join, choose a connection with a virtual network that’s validated by the Cloud PC service. The onPremisesConnectionId property is deprecated and will stop returning data on May 31, 2024. Going forward, use the domainJoinConfigurations property.
windowsSettings (deprecated) cloudPcWindowsSettings Specific Windows settings to configure during the creation of Cloud PCs for this provisioning policy. Supports $select. The windowsSettings property is deprecated and will stop returning data on January 31, 2024. Going forward, use the windowsSetting property.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/provisioningPolicies/1d164206-bf41-4fd2-8424-a3192d39ffff
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
  "displayName": "HR provisioning policy",
  "description": "Provisioning policy for India HR employees",
  "onPremisesConnectionId": "4e47d0f6-6f77-44f0-8893-c0fe1701ffff",
  "imageId": "Image ID value",
  "imageDisplayName": "Image Display Name value",
  "imageType": "custom",
  "windowsSettings": {
    "language": "en-US"
  },
  "windowsSetting": {
    "locale": "en-US"
  },
  "microsoftManagedDesktop": {
    "managedType": "starterManaged",
    "profile": null
  },
  "autopatch": {
    "autopatchGroupId": "91197a0b-3a74-408d-ba88-bce3fdc4e5eb"
  },
  "autopilotConfiguration": {
    "devicePreparationProfileId": "59e5d3d2-ec68-4bfe-9693-27975b318990",
    "applicationTimeoutInMinutes": 30,
    "onFailureDeviceAccessDenied": false
  }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content