Create deviceManagementAutopilotEvent
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.
Create a new deviceManagementAutopilotEvent 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
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All |
| Delegated (personal Microsoft account) | Not supported. |
| Application | DeviceManagementConfiguration.ReadWrite.All, DeviceManagementManagedDevices.ReadWrite.All |
HTTP Request
POST /deviceManagement/autopilotEvents
Request headers
| Header | Value |
|---|---|
| Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
| Accept | application/json |
Request body
In the request body, supply a JSON representation for the deviceManagementAutopilotEvent object.
The following table shows the properties that are required when you create the deviceManagementAutopilotEvent.
| Property | Type | Description |
|---|---|---|
| id | String | UUID for the object |
| deviceId | String | Device id associated with the object |
| userId | String | UserId id associated with the object |
| eventDateTime | DateTimeOffset | Time when the event occurred . |
| deviceRegisteredDateTime | DateTimeOffset | Device registration date. |
| enrollmentStartDateTime | DateTimeOffset | Device enrollment start date. |
| enrollmentType | windowsAutopilotEnrollmentType | Enrollment type. Possible values are: unknown, azureADJoinedWithAutopilotProfile, offlineDomainJoined, azureADJoinedUsingDeviceAuthWithAutopilotProfile, azureADJoinedUsingDeviceAuthWithoutAutopilotProfile, azureADJoinedWithOfflineAutopilotProfile, azureADJoinedWithWhiteGlove, offlineDomainJoinedWithWhiteGlove, offlineDomainJoinedWithOfflineAutopilotProfile. |
| deviceSerialNumber | String | Device serial number. |
| managedDeviceName | String | Managed device name. |
| userPrincipalName | String | User principal name used to enroll the device. |
| windowsAutopilotDeploymentProfileDisplayName | String | Autopilot profile name. |
| enrollmentState | enrollmentState | Enrollment state like Enrolled, Failed. Possible values are: unknown, enrolled, pendingReset, failed, notContacted, blocked. |
| windows10EnrollmentCompletionPageConfigurationDisplayName | String | Enrollment Status Page profile name |
| windows10EnrollmentCompletionPageConfigurationId | String | Enrollment Status Page profile ID |
| deploymentState | windowsAutopilotDeploymentState | Deployment state like Success, Failure, InProgress, SuccessWithTimeout. Possible values are: unknown, success, inProgress, failure, successWithTimeout, notAttempted, disabled, successOnRetry. |
| deviceSetupStatus | windowsAutopilotDeploymentState | Deployment status for the enrollment status page’s device setup phase. Possible values are: unknown, success, inProgress, failure, successWithTimeout, notAttempted, disabled, successOnRetry. |
| accountSetupStatus | windowsAutopilotDeploymentState | Deployment status for the enrollment status page’s account setup phase. Possible values are: unknown, success, inProgress, failure, successWithTimeout, notAttempted, disabled, successOnRetry. |
| osVersion | String | Device operating system version. |
| deploymentDuration | Duration | Autopilot deployment duration including enrollment. |
| deploymentTotalDuration | Duration | Total deployment duration from enrollment to Desktop screen. |
| deviceSetupDuration | Duration | Time spent in device ESP. |
| accountSetupDuration | Duration | Time spent in user ESP. |
| deploymentStartDateTime | DateTimeOffset | Deployment start time. |
| deploymentEndDateTime | DateTimeOffset | Deployment end time. |
| enrollmentFailureDetails | String | Enrollment failure details. |
Response
If successful, this method returns a 201 Created response code and a deviceManagementAutopilotEvent object in the response body.
Example
Request
Here is an example of the request.
POST https://graph.microsoft.com/beta/deviceManagement/autopilotEvents
Content-type: application/json
Content-length: 1468
{
"@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent",
"deviceId": "Device Id value",
"userId": "User Id value",
"eventDateTime": "2016-12-31T23:59:23.3984029-08:00",
"deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00",
"enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00",
"enrollmentType": "azureADJoinedWithAutopilotProfile",
"deviceSerialNumber": "Device Serial Number value",
"managedDeviceName": "Managed Device Name value",
"userPrincipalName": "User Principal Name value",
"windowsAutopilotDeploymentProfileDisplayName": "Windows Autopilot Deployment Profile Display Name value",
"enrollmentState": "enrolled",
"windows10EnrollmentCompletionPageConfigurationDisplayName": "Windows10Enrollment Completion Page Configuration Display Name value",
"windows10EnrollmentCompletionPageConfigurationId": "Windows10Enrollment Completion Page Configuration Id value",
"deploymentState": "success",
"deviceSetupStatus": "success",
"accountSetupStatus": "success",
"osVersion": "Os Version value",
"deploymentDuration": "PT3M21.5549443S",
"deploymentTotalDuration": "PT1M43.5284261S",
"deviceSetupDuration": "-PT2M57.2190107S",
"accountSetupDuration": "-PT2M32.0507894S",
"deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00",
"deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",
"enrollmentFailureDetails": "Enrollment Failure Details value"
}
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1517
{
"@odata.type": "#microsoft.graph.deviceManagementAutopilotEvent",
"id": "3e455cab-5cab-3e45-ab5c-453eab5c453e",
"deviceId": "Device Id value",
"userId": "User Id value",
"eventDateTime": "2016-12-31T23:59:23.3984029-08:00",
"deviceRegisteredDateTime": "2017-01-01T00:02:48.7185581-08:00",
"enrollmentStartDateTime": "2017-01-01T00:00:19.6280481-08:00",
"enrollmentType": "azureADJoinedWithAutopilotProfile",
"deviceSerialNumber": "Device Serial Number value",
"managedDeviceName": "Managed Device Name value",
"userPrincipalName": "User Principal Name value",
"windowsAutopilotDeploymentProfileDisplayName": "Windows Autopilot Deployment Profile Display Name value",
"enrollmentState": "enrolled",
"windows10EnrollmentCompletionPageConfigurationDisplayName": "Windows10Enrollment Completion Page Configuration Display Name value",
"windows10EnrollmentCompletionPageConfigurationId": "Windows10Enrollment Completion Page Configuration Id value",
"deploymentState": "success",
"deviceSetupStatus": "success",
"accountSetupStatus": "success",
"osVersion": "Os Version value",
"deploymentDuration": "PT3M21.5549443S",
"deploymentTotalDuration": "PT1M43.5284261S",
"deviceSetupDuration": "-PT2M57.2190107S",
"accountSetupDuration": "-PT2M32.0507894S",
"deploymentStartDateTime": "2016-12-31T23:59:37.257201-08:00",
"deploymentEndDateTime": "2017-01-01T00:00:46.5128291-08:00",
"enrollmentFailureDetails": "Enrollment Failure Details value"
}