microsoft.graph.cloudPcProvisioningPolicy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.cloudPcProvisioningPolicy",
  "title": "microsoft.graph.cloudPcProvisioningPolicy",
  "allOf": [
    {
      "$ref": "#/components/schemas/microsoft.graph.entity"
    },
    {
      "title": "cloudPcProvisioningPolicy",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "alternateResourceUrl": {
          "type": "string",
          "description": "The URL of the alternate resource that links to this provisioning policy. Read-only.",
          "nullable": true
        },
        "autopatch": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.cloudPcProvisioningPolicyAutopatch"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "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. Supports $select."
        },
        "cloudPcGroupDisplayName": {
          "type": "string",
          "description": "The display name of the Cloud PC group that the Cloud PCs reside in. Read-only.",
          "nullable": true
        },
        "cloudPcNamingTemplate": {
          "type": "string",
          "description": "The template used to name Cloud PCs provisioned using this policy. The template can contain custom text and replacement tokens, including %USERNAME:x% and %RAND:x%, which represent the user's name and a randomly generated number, respectively. For example, CPC-%USERNAME:4%-%RAND:5% means that the name of the Cloud PC starts with CPC-, followed by a four-character username, a - character, and then five random characters. The total length of the text generated by the template can't exceed 15 characters. Supports $filter, $select, and $orderby.",
          "nullable": true
        },
        "description": {
          "type": "string",
          "description": "The provisioning policy description. Supports $filter, $select, and $orderBy.",
          "nullable": true
        },
        "displayName": {
          "type": "string",
          "description": "The display name for the provisioning policy."
        },
        "domainJoinConfigurations": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.cloudPcDomainJoinConfiguration"
          },
          "description": "Specifies a list ordered by priority on how Cloud PCs join Microsoft Entra ID (Azure AD). Supports $select."
        },
        "enableSingleSignOn": {
          "type": "boolean",
          "description": "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. The 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.",
          "nullable": true
        },
        "gracePeriodInHours": {
          "maximum": 2147483647,
          "minimum": -2147483648,
          "type": "number",
          "description": "The number of hours to wait before reprovisioning/deprovisioning happens. Read-only.",
          "format": "int32",
          "nullable": true
        },
        "imageDisplayName": {
          "type": "string",
          "description": "The display name of the operating system image that is used for provisioning. For example, Windows 11 Preview + Microsoft 365 Apps 23H2 23H2. Supports $filter, $select, and $orderBy."
        },
        "imageId": {
          "type": "string",
          "description": "The unique identifier that represents an operating system image that is used for provisioning new Cloud PCs. The format for a gallery type image is: {publisherNameofferNameskuName}. Supported values for each of the parameters are: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 Supports $filter, $select, and $orderBy."
        },
        "imageType": {
          "$ref": "#/components/schemas/microsoft.graph.cloudPcProvisioningPolicyImageType"
        },
        "localAdminEnabled": {
          "type": "boolean",
          "description": "When true, the local admin is enabled for Cloud PCs; false indicates that the local admin isn't enabled for Cloud PCs. The default value is false. Supports $filter, $select, and $orderBy.",
          "nullable": true
        },
        "microsoftManagedDesktop": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.microsoftManagedDesktop"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "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. Supports $filter, $select, and $orderBy."
        },
        "provisioningType": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.cloudPcProvisioningType"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Specifies the type of license used when provisioning Cloud PCs using this policy. By default, the license type is dedicated if the provisioningType isn't specified when you create the cloudPcProvisioningPolicy. You can't change this property after the cloudPcProvisioningPolicy was created. The possible values are: dedicated, shared, unknownFutureValue."
        },
        "windowsSetting": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/microsoft.graph.cloudPcWindowsSetting"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Indicates a specific Windows setting to configure during the creation of Cloud PCs for this provisioning policy. Supports $select."
        },
        "assignments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/microsoft.graph.cloudPcProvisioningPolicyAssignment"
          },
          "description": "A defined collection of provisioning policy assignments. Represents the set of Microsoft 365 groups and security groups in Microsoft Entra ID that have provisioning policy assigned. Returned only on $expand. For an example about how to get the assignments relationship, see Get cloudPcProvisioningPolicy.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.cloudPcProvisioningPolicy"
}