Edit

cloudPcProvisioningPolicy resource type

  • Article
  • 2 minutes to read

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.

Represents a Cloud PC provisioning policy.

Methods

Method Return type Description
List provisioningPolicies cloudPcProvisioningPolicy collection List properties and relationships of the cloudPcProvisioningPolicy objects.
Get cloudPcProvisioningPolicy cloudPcProvisioningPolicy Read the properties and relationships of a cloudPcProvisioningPolicy object.
Create cloudPcProvisioningPolicy cloudPcProvisioningPolicy Create a new cloudPcProvisioningPolicy object.
Update cloudPcProvisioningPolicy cloudPcProvisioningPolicy Update the properties of a cloudPcProvisioningPolicy object.
Delete cloudPcProvisioningPolicy None Delete a cloudPcProvisioningPolicy object.
Assign cloudPcProvisioningPolicy None Assign a cloudPcProvisioningPolicy to user groups.

Properties

Property Type Description
alternateResourceUrl String The URL of the alternate resource that links to this provisioning policy. Read-only.
cloudPcGroupDisplayName String The display name of the Cloud PC group that the Cloud PCs reside in. Read-only.
description String The provisioning policy description.
displayName String The display name for the provisioning policy.
domainJoinConfiguration cloudPcDomainJoinConfiguration Specifies how Cloud PCs will join Azure Active Directory.
gracePeriodInHours Int32 The number of hours to wait before reprovisioning/deprovisioning happens. Read-only.
id String Unique identifier for the Cloud PC provisioning policy. Read-only.
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.
localAdminEnabled Boolean Indicates whether the local admin option is enabled. If the local admin option is enabled, the end user can be an admin of the Cloud PC device. Read-only.
managedBy cloudPcManagementService Specifies which services manage the Azure network connection. Possible values are: windows365, devBox, unknownFutureValue, rpaBox. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value(s) in this evolvable enum: rpaBox. Read-only.
microsoftManagedDesktop microsoftManagedDesktop The specific settings for the Microsoft Managed Desktop, which enables customers to get a managed device experience for the Cloud PC. Before you can enable Microsoft Managed Desktop, an admin must configure it.
onPremisesConnectionId 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.
windowsSettings cloudPcWindowsSettings Specific Windows settings to configure while creating Cloud PCs for this provisioning policy.

Relationships

Relationship Type Description
assignments cloudPcProvisioningPolicyAssignment collection A defined collection of provisioning policy assignments. Represents the set of Microsoft 365 groups and security groups in Azure AD that have provisioning policy assigned. Returned only on $expand. See an example of getting the assignments relationship.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.cloudPcProvisioningPolicy",
  "alternateResourceUrl": "String",
  "cloudPcGroupDisplayName": "String",
  "description": "String",
  "displayName": "String",
  "domainJoinConfiguration": {
    "@odata.type": "microsoft.graph.cloudPcDomainJoinConfiguration"
  },
  "gracePeriodInHours": "Integer",
  "id": "String (identifier)",
  "imageDisplayName": "String",
  "imageId": "String",
  "imageType": "String",
  "localAdminEnabled": "Boolean",
  "managedBy": "String",
  "microsoftManagedDesktop": {
    "type": "String",
    "profile": "String"
  },
  "onPremisesConnectionId": "String",
  "windowsSettings": {
    "@odata.type": "microsoft.graph.cloudPcWindowsSettings"
  }
}