Update azureADWindowsAutopilotDeploymentProfile
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.
Update the properties of a azureADWindowsAutopilotDeploymentProfile object.
Prerequisites
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 most to least privileged) |
---|---|
Delegated (work or school account) | DeviceManagementServiceConfig.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. |
Application | DeviceManagementServiceConfig.ReadWrite.All |
HTTP Request
PATCH /deviceManagement/windowsAutopilotDeploymentProfiles/{windowsAutopilotDeploymentProfileId}
PATCH /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/deploymentProfile
PATCH /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/intendedDeploymentProfile
Request headers
Header | Value |
---|---|
Authorization | Bearer <token> Required. |
Accept | application/json |
Request body
In the request body, supply a JSON representation for the azureADWindowsAutopilotDeploymentProfile object.
The following table shows the properties that are required when you create the azureADWindowsAutopilotDeploymentProfile.
Property | Type | Description |
---|---|---|
id | String | Profile Key Inherited from windowsAutopilotDeploymentProfile |
displayName | String | Name of the profile Inherited from windowsAutopilotDeploymentProfile |
description | String | Description of the profile Inherited from windowsAutopilotDeploymentProfile |
language | String | Language configured on the device Inherited from windowsAutopilotDeploymentProfile |
createdDateTime | DateTimeOffset | Profile creation time Inherited from windowsAutopilotDeploymentProfile |
lastModifiedDateTime | DateTimeOffset | Profile last modified time Inherited from windowsAutopilotDeploymentProfile |
outOfBoxExperienceSettings | outOfBoxExperienceSettings | Out of box experience setting Inherited from windowsAutopilotDeploymentProfile |
enrollmentStatusScreenSettings | windowsEnrollmentStatusScreenSettings | Enrollment status screen setting Inherited from windowsAutopilotDeploymentProfile |
extractHardwareHash | Boolean | HardwareHash Extraction for the profile Inherited from windowsAutopilotDeploymentProfile |
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. Inherited from windowsAutopilotDeploymentProfile |
deviceType | windowsAutopilotDeviceType | The AutoPilot device type that this profile is applicable to. Inherited from windowsAutopilotDeploymentProfile. Possible values are: windowsPc , surfaceHub2 , holoLens . |
enableWhiteGlove | Boolean | Enable Autopilot White Glove for the profile. Inherited from windowsAutopilotDeploymentProfile |
roleScopeTagIds | String collection | Scope tags for the profile. Inherited from windowsAutopilotDeploymentProfile |
Response
If successful, this method returns a 200 OK
response code and an updated azureADWindowsAutopilotDeploymentProfile object in the response body.
Example
Request
Here is an example of the request.
PATCH https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeploymentProfiles/{windowsAutopilotDeploymentProfileId}
Content-type: application/json
Content-length: 1159
{
"@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile",
"displayName": "Display Name value",
"description": "Description value",
"language": "Language value",
"outOfBoxExperienceSettings": {
"@odata.type": "microsoft.graph.outOfBoxExperienceSettings",
"hidePrivacySettings": true,
"hideEULA": true,
"userType": "standard",
"deviceUsageType": "shared",
"skipKeyboardSelectionPage": true,
"hideEscapeLink": true
},
"enrollmentStatusScreenSettings": {
"@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings",
"hideInstallationProgress": true,
"allowDeviceUseBeforeProfileAndAppInstallComplete": true,
"blockDeviceSetupRetryByUser": true,
"allowLogCollectionOnInstallFailure": true,
"customErrorMessage": "Custom Error Message value",
"installProgressTimeoutInMinutes": 15,
"allowDeviceUseOnInstallFailure": true
},
"extractHardwareHash": true,
"deviceNameTemplate": "Device Name Template value",
"deviceType": "surfaceHub2",
"enableWhiteGlove": true,
"roleScopeTagIds": [
"Role Scope Tag Ids 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 200 OK
Content-Type: application/json
Content-Length: 1331
{
"@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile",
"id": "e2ec4e69-4e69-e2ec-694e-ece2694eece2",
"displayName": "Display Name value",
"description": "Description value",
"language": "Language value",
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"outOfBoxExperienceSettings": {
"@odata.type": "microsoft.graph.outOfBoxExperienceSettings",
"hidePrivacySettings": true,
"hideEULA": true,
"userType": "standard",
"deviceUsageType": "shared",
"skipKeyboardSelectionPage": true,
"hideEscapeLink": true
},
"enrollmentStatusScreenSettings": {
"@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings",
"hideInstallationProgress": true,
"allowDeviceUseBeforeProfileAndAppInstallComplete": true,
"blockDeviceSetupRetryByUser": true,
"allowLogCollectionOnInstallFailure": true,
"customErrorMessage": "Custom Error Message value",
"installProgressTimeoutInMinutes": 15,
"allowDeviceUseOnInstallFailure": true
},
"extractHardwareHash": true,
"deviceNameTemplate": "Device Name Template value",
"deviceType": "surfaceHub2",
"enableWhiteGlove": true,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
]
}