updateDeviceProperties action

Namespace: microsoft.graph

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

Updates properties on Autopilot devices.

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)	DeviceManagementServiceConfig.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementServiceConfig.ReadWrite.All

HTTP Request

POST /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/updateDeviceProperties

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Property	Type	Description
userPrincipalName	String	Not yet documented
addressableUserName	String	Not yet documented
groupTag	String	Not yet documented
displayName	String	Not yet documented

Response

If successful, this action returns a 204 No Content response code.

Example

Request

Here is an example of the request.

HTTP

POST https://graph.microsoft.com/v1.0/deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/updateDeviceProperties
Content-type: application/json
Content-length: 187

{
  "userPrincipalName": "User Principal Name value",
  "addressableUserName": "Addressable User Name value",
  "groupTag": "Group Tag value",
  "displayName": "Display Name value"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.DeviceManagement.WindowsAutopilotDeviceIdentities.Item.UpdateDeviceProperties;

var requestBody = new UpdateDevicePropertiesPostRequestBody
{
	UserPrincipalName = "User Principal Name value",
	AddressableUserName = "Addressable User Name value",
	GroupTag = "Group Tag value",
	DisplayName = "Display Name value",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.WindowsAutopilotDeviceIdentities["{windowsAutopilotDeviceIdentity-id}"].UpdateDeviceProperties.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

mgc device-management windows-autopilot-device-identities update-device-properties post --windows-autopilot-device-identity-id {windowsAutopilotDeviceIdentity-id} --body '{\
  "userPrincipalName": "User Principal Name value",\
  "addressableUserName": "Addressable User Name value",\
  "groupTag": "Group Tag value",\
  "displayName": "Display Name value"\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdevicemanagement "github.com/microsoftgraph/msgraph-sdk-go/devicemanagement"
	  //other-imports
)

requestBody := graphdevicemanagement.NewUpdateDevicePropertiesPostRequestBody()
userPrincipalName := "User Principal Name value"
requestBody.SetUserPrincipalName(&userPrincipalName) 
addressableUserName := "Addressable User Name value"
requestBody.SetAddressableUserName(&addressableUserName) 
groupTag := "Group Tag value"
requestBody.SetGroupTag(&groupTag) 
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().WindowsAutopilotDeviceIdentities().ByWindowsAutopilotDeviceIdentityId("windowsAutopilotDeviceIdentity-id").UpdateDeviceProperties().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.devicemanagement.windowsautopilotdeviceidentities.item.updatedeviceproperties.UpdateDevicePropertiesPostRequestBody updateDevicePropertiesPostRequestBody = new com.microsoft.graph.devicemanagement.windowsautopilotdeviceidentities.item.updatedeviceproperties.UpdateDevicePropertiesPostRequestBody();
updateDevicePropertiesPostRequestBody.setUserPrincipalName("User Principal Name value");
updateDevicePropertiesPostRequestBody.setAddressableUserName("Addressable User Name value");
updateDevicePropertiesPostRequestBody.setGroupTag("Group Tag value");
updateDevicePropertiesPostRequestBody.setDisplayName("Display Name value");
graphClient.deviceManagement().windowsAutopilotDeviceIdentities().byWindowsAutopilotDeviceIdentityId("{windowsAutopilotDeviceIdentity-id}").updateDeviceProperties().post(updateDevicePropertiesPostRequestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const updateDeviceProperties = {
  userPrincipalName: 'User Principal Name value',
  addressableUserName: 'Addressable User Name value',
  groupTag: 'Group Tag value',
  displayName: 'Display Name value'
};

await client.api('/deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/updateDeviceProperties')
	.post(updateDeviceProperties);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\DeviceManagement\WindowsAutopilotDeviceIdentities\Item\UpdateDeviceProperties\UpdateDevicePropertiesPostRequestBody;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new UpdateDevicePropertiesPostRequestBody();
$requestBody->setUserPrincipalName('User Principal Name value');
$requestBody->setAddressableUserName('Addressable User Name value');
$requestBody->setGroupTag('Group Tag value');
$requestBody->setDisplayName('Display Name value');

$graphServiceClient->deviceManagement()->windowsAutopilotDeviceIdentities()->byWindowsAutopilotDeviceIdentityId('windowsAutopilotDeviceIdentity-id')->updateDeviceProperties()->post($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.DeviceManagement.Enrollment

$params = @{
	userPrincipalName = "User Principal Name value"
	addressableUserName = "Addressable User Name value"
	groupTag = "Group Tag value"
	displayName = "Display Name value"
}

Update-MgDeviceManagementWindowsAutopilotDeviceIdentityDeviceProperty -WindowsAutopilotDeviceIdentityId $windowsAutopilotDeviceIdentityId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.devicemanagement.windowsautopilotdeviceidentities.item.update_device_properties.update_device_properties_post_request_body import UpdateDevicePropertiesPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = UpdateDevicePropertiesPostRequestBody(
	user_principal_name = "User Principal Name value",
	addressable_user_name = "Addressable User Name value",
	group_tag = "Group Tag value",
	display_name = "Display Name value",
)

await graph_client.device_management.windows_autopilot_device_identities.by_windows_autopilot_device_identity_id('windowsAutopilotDeviceIdentity-id').update_device_properties.post(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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 204 No Content