Skip to content

Latest commit

 

History

History
165 lines (129 loc) · 8.84 KB

File metadata and controls

165 lines (129 loc) · 8.84 KB
title Update cloudPcProvisioningPolicy
description Update the properties of a cloudPcProvisioningPolicy object.
author AshleyYangSZ
ms.localizationpriority medium
ms.subservice cloud-pc
doc_type apiPageType
ms.date 10/01/2024

Update cloudPcProvisioningPolicy

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of a cloudPcProvisioningPolicy object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

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 Indicates the Windows Autopatch settings for Cloud PCs using this provisioning policy. The settings take effect when the tenant enrolls in 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. The 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.
userSettingsPersistenceConfiguration cloudPcUserSettingsPersistenceConfiguration Indicates specific settings that enable the persistence of user application settings between Cloud PC sessions. The default value is null. This feature is only available for Cloud PC provisioning policies of type sharedByEntraGroup. Supports $select.
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
  },
  "userSettingsPersistenceConfiguration": {
    "userSettingsPersistenceEnabled": false,
    "userSettingsPersistenceStorageSizeCategory": "fourGB"
  }
}

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]


Response

The following example shows the response.

HTTP/1.1 204 No Content