windowsAutopilotDeploymentProfile resource type
Namespace: microsoft.graph
Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.
Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.
Windows Autopilot Deployment Profile
Methods
| Method | Return Type | Description |
|---|---|---|
| Get windowsAutopilotDeploymentProfile | windowsAutopilotDeploymentProfile | Read properties and relationships of the windowsAutopilotDeploymentProfile object. |
| assign action | None | |
| Policy Set | ||
| hasPayloadLinks action | hasPayloadLinkResultItem collection |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | Profile Key |
| displayName | String | The display name of the deployment profile. Max allowed length is 200 chars. Returned by default. Supports: $select, $top, $skip, $orderby. $Search and $filter are not supported. |
| description | String | A description of the deployment profile. Max allowed length is 1500 chars. Supports: $select, $top, $skip, $orderBy. $Search and $filter are not supported. |
| language | String | The language code to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use locale instead. |
| locale | String | The locale (language) to be used when configuring the device. E.g. en-US. The default value is os-default. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. |
| createdDateTime | DateTimeOffset | The date and time of when the deployment profile was created. The value cannot be modified and is automatically populated when the profile was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. |
| lastModifiedDateTime | DateTimeOffset | The date and time of when the deployment profile was last modified. The value cannot be updated manually and is automatically populated when any changes are made to the profile. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported Read-Only. |
| outOfBoxExperienceSettings | outOfBoxExperienceSettings | The Windows Autopilot Deployment Profile settings used by the Autopilot device for out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use outOfBoxExperienceSetting instead. |
| outOfBoxExperienceSetting | outOfBoxExperienceSetting | The Windows Autopilot Deployment Profile settings used by the device for the out-of-box experience. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. |
| enrollmentStatusScreenSettings | windowsEnrollmentStatusScreenSettings | Enrollment status screen setting |
| extractHardwareHash | Boolean | Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use hardwareHashExtractionEnabled instead. |
| hardwareHashExtractionEnabled | Boolean | Indicates whether the profile supports the extraction of hardware hash values and registration of the device into Windows Autopilot. When TRUE, indicates if hardware extraction and Windows Autopilot registration will happen on the next successful check-in. When FALSE, hardware hash extraction and Windows Autopilot registration will not happen. Default value is FALSE. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. |
| deviceNameTemplate | String | The template used to name the Autopilot device. This can be a custom text and can also contain either the serial number of the device, or a randomly generated number. The total length of the text generated by the template can be no more than 15 characters. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. |
| deviceType | windowsAutopilotDeviceType | The Windows device type that this profile is applicable to. Possible values include windowsPc, holoLens, and virtualMachine. The default is windowsPc. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. Possible values are: windowsPc, holoLens, surfaceHub2, surfaceHub2S, virtualMachine, unknownFutureValue. |
| enableWhiteGlove | Boolean | Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode is allowed. When false, Windows Autopilot for pre-provisioned deployment mode is not allowed. The default is FALSE. Read-Only. Starting from May 2024 this property will no longer be supported and will be marked as deprecated. Use preprovisioningAllowed instead. |
| preprovisioningAllowed | Boolean | Indicates whether the user is allowed to use Windows Autopilot for pre-provisioned deployment mode during Out of Box experience (OOBE). When TRUE, indicates that Windows Autopilot for pre-provisioned deployment mode for OOBE is allowed to be used. When false, Windows Autopilot for pre-provisioned deployment mode for OOBE is not allowed. The default is FALSE. |
| roleScopeTagIds | String collection | List of role scope tags for the deployment profile. |
| managementServiceAppId | String | The Entra management service App ID which gets used during client device-based enrollment discovery. Supports: $select, $top, $skip. $Search, $orderBy and $filter are not supported. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| Enrollment | ||
| assignedDevices | windowsAutopilotDeviceIdentity collection | The list of assigned devices for the profile. |
| assignments | windowsAutopilotDeploymentProfileAssignment collection | The list of group assignments for the profile. |
JSON Representation
Here is a JSON representation of the resource.
{
"@odata.type": "#microsoft.graph.windowsAutopilotDeploymentProfile",
"id": "String (identifier)",
"displayName": "String",
"description": "String",
"language": "String",
"locale": "String",
"createdDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"outOfBoxExperienceSettings": {
"@odata.type": "microsoft.graph.outOfBoxExperienceSettings",
"hidePrivacySettings": true,
"hideEULA": true,
"userType": "String",
"deviceUsageType": "String",
"skipKeyboardSelectionPage": true,
"hideEscapeLink": true
},
"outOfBoxExperienceSetting": {
"@odata.type": "microsoft.graph.outOfBoxExperienceSetting",
"privacySettingsHidden": true,
"eulaHidden": true,
"userType": "String",
"deviceUsageType": "String",
"keyboardSelectionPageSkipped": true,
"escapeLinkHidden": true
},
"enrollmentStatusScreenSettings": {
"@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings",
"hideInstallationProgress": true,
"allowDeviceUseBeforeProfileAndAppInstallComplete": true,
"blockDeviceSetupRetryByUser": true,
"allowLogCollectionOnInstallFailure": true,
"customErrorMessage": "String",
"installProgressTimeoutInMinutes": 1024,
"allowDeviceUseOnInstallFailure": true
},
"extractHardwareHash": true,
"hardwareHashExtractionEnabled": true,
"deviceNameTemplate": "String",
"deviceType": "String",
"enableWhiteGlove": true,
"preprovisioningAllowed": true,
"roleScopeTagIds": [
"String"
],
"managementServiceAppId": "String"
}