Update windowsDomainJoinConfiguration

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.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a windowsDomainJoinConfiguration object. ## 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 most to least privileged)
Delegated (work or school account)
Device configuration	DeviceManagementConfiguration.ReadWrite.All
Enrollment	DeviceManagementServiceConfig.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application
Device configuration	DeviceManagementConfiguration.ReadWrite.All
Enrollment	DeviceManagementServiceConfig.ReadWrite.All

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

HTTP Request

Device configuration

PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId}

Enrollment

PATCH /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/deploymentProfile/microsoft.graph.activeDirectoryWindowsAutopilotDeploymentProfile/domainJoinConfiguration

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 windowsDomainJoinConfiguration object.

The following table shows the properties that are required when you create the windowsDomainJoinConfiguration.

Property	Type	Description
id	String	Key of the entity. Inherited from deviceConfiguration
Device configuration
activeDirectoryDomainName	String	Active Directory domain name to join.
computerNameStaticPrefix	String	Fixed prefix to be used for computer name.
computerNameSuffixRandomCharCount	Int32	Dynamically generated characters used as suffix for computer name. Valid values 3 to 14
createdDateTime	DateTimeOffset	DateTime the object was created. Inherited from deviceConfiguration
description	String	Admin provided description of the Device Configuration. Inherited from deviceConfiguration
displayName	String	Admin provided name of the device configuration. Inherited from deviceConfiguration
lastModifiedDateTime	DateTimeOffset	DateTime the object was last modified. Inherited from deviceConfiguration
organizationalUnit	String	Organizational unit (OU) where the computer account will be created. If this parameter is NULL, the well known computer object container will be used as published in the domain.
roleScopeTagIds	String collection	List of Scope Tags for this Entity instance. Inherited from deviceConfiguration
supportsScopeTags	Boolean	Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration
version	Int32	Version of the device configuration. Inherited from deviceConfiguration

Note: Request body properties support depends on the context of the call. Not all properties are appropriate for all workflows.

Response

If successful, this method returns a 200 OK response code and an updated windowsDomainJoinConfiguration object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId}
Content-type: application/json
Content-length: 344

{
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "computerNameStaticPrefix": "Computer Name Static Prefix value",
  "computerNameSuffixRandomCharCount": 1,
  "activeDirectoryDomainName": "Active Directory Domain Name value"
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. Properties returned by actual calls vary according to the context.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 521

{
  "@odata.type": "#microsoft.graph.windowsDomainJoinConfiguration",
  "id": "40118d08-8d08-4011-088d-1140088d1140",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "computerNameStaticPrefix": "Computer Name Static Prefix value",
  "computerNameSuffixRandomCharCount": 1,
  "activeDirectoryDomainName": "Active Directory Domain Name value"
}