デバイスを更新する

[アーティクル]
10/30/2023

名前空間: microsoft.graph

登録済みデバイスのプロパティを更新します。

承認済みモバイルデバイス管理 (MDM) アプリによって、デバイスの特定のプロパティのみを更新できます。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	Directory.AccessAsUser.All	注意事項なし。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Device.ReadWrite.All	Directory.ReadWrite.All

アプリケーションのみのシナリオと Windows 以外のデバイスの場合、つまり 、operatingSystem プロパティがではない Windows場合、アプリは extensionAttributes プロパティのみを更新できます。

呼び出し元のユーザーは、次のいずれかのMicrosoft Entraロールである必要があります: Intune Administrator。 Cloud Device Administrator ロールの呼び出し元ユーザーは、この API を使用してデバイスのみを有効または無効にでき、Windows 365管理者ロールを持つユーザーは基本的なデバイスプロパティのみを更新できます。グローバル管理者には、デバイスに対する完全な管理特権があります。

HTTP 要求

ID またはdeviceId を使用してデバイスをアドレス指定できます。

PATCH /devices/{id}
PATCH /devices(deviceId='{deviceId}')

要求ヘッダー

名前	型	説明
Authorization	string	ベアラー {token}。必須です。

要求本文

要求本文で、更新するデバイスプロパティの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。

プロパティ	型	説明
accountEnabled	Boolean	アカウントが有効な場合は `true` であり、それ以外の場合は `false` です。このプロパティを更新できるのは、グローバル管理者ロールとクラウドデバイス管理者ロールの呼び出し元のみです。
operatingSystem	String	デバイス上のオペレーティングシステムの種類。
operatingSystemVersion	String	デバイス上のオペレーティングシステムのバージョン
displayName	String	デバイスの表示名。
isCompliant	ブール値	`true`デバイスがモバイルデバイス管理 (MDM) ポリシーに準拠している場合は。それ以外の場合`false`は。これは、任意のデバイス OS の種類のIntune、または Windows OS デバイス用の承認済みの MDM アプリによってのみ更新できます。
isManaged	ブール型	`true`デバイスが Mobile デバイス管理 (MDM) アプリによって管理されている場合は。それ以外の場合`false`は。これは、任意のデバイス OS の種類のIntune、または Windows OS デバイス用の承認済みの MDM アプリによってのみ更新できます。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。

例

例 1: デバイスの accountEnabled プロパティを更新する

要求

PATCH https://graph.microsoft.com/v1.0/devices/7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac
Content-type: application/json

{
  "accountEnabled": false
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Device
{
	AccountEnabled = false,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Devices["{device-id}"].PatchAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc devices patch --device-id {device-id} --body '{\
  "accountEnabled": false\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewDevice()
accountEnabled := false
requestBody.SetAccountEnabled(&accountEnabled) 

devices, err := graphClient.Devices().ByDeviceId("device-id").Patch(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Device device = new Device();
device.setAccountEnabled(false);
Device result = graphClient.devices().byDeviceId("{device-id}").patch(device);


const options = {
	authProvider,
};

const client = Client.init(options);

const device = {
  accountEnabled: false
};

await client.api('/devices/7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac')
	.update(device);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Device;


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

$requestBody = new Device();
$requestBody->setAccountEnabled(false);

$result = $graphServiceClient->devices()->byDeviceId('device-id')->patch($requestBody)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	accountEnabled = $false
}

Update-MgDevice -DeviceId $deviceId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.device import Device

graph_client = GraphServiceClient(credentials, scopes)

request_body = Device(
	account_enabled = False,
)

result = await graph_client.devices.by_device_id('device-id').patch(request_body)

応答

HTTP/1.1 204 No Content

例 2: デバイスに extensionAttributes を書き込む

要求

PATCH https://graph.microsoft.com/v1.0/devices/7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac
Content-type: application/json

{
    "extensionAttributes": {
        "extensionAttribute1": "BYOD-Device"
    }
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Device
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"extensionAttributes" , new 
			{
				ExtensionAttribute1 = "BYOD-Device",
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Devices["{device-id}"].PatchAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc devices patch --device-id {device-id} --body '{\
    "extensionAttributes": {\
        "extensionAttribute1": "BYOD-Device"\
    }\
}\
'



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewDevice()
additionalData := map[string]interface{}{
extensionAttributes := graphmodels.New()
extensionAttribute1 := "BYOD-Device"
extensionAttributes.SetExtensionAttribute1(&extensionAttribute1) 
	requestBody.SetExtensionAttributes(extensionAttributes)
}
requestBody.SetAdditionalData(additionalData)

devices, err := graphClient.Devices().ByDeviceId("device-id").Patch(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Device device = new Device();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
 extensionAttributes = new ();
extensionAttributes.setExtensionAttribute1("BYOD-Device");
additionalData.put("extensionAttributes", extensionAttributes);
device.setAdditionalData(additionalData);
Device result = graphClient.devices().byDeviceId("{device-id}").patch(device);


const options = {
	authProvider,
};

const client = Client.init(options);

const device = {
    extensionAttributes: {
        extensionAttribute1: 'BYOD-Device'
    }
};

await client.api('/devices/7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac')
	.update(device);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\Device;


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

$requestBody = new Device();
$additionalData = [
	'extensionAttributes' => [
		'extensionAttribute1' => 'BYOD-Device',
	],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->devices()->byDeviceId('device-id')->patch($requestBody)->wait();


Import-Module Microsoft.Graph.Identity.DirectoryManagement

$params = @{
	extensionAttributes = @{
		extensionAttribute1 = "BYOD-Device"
	}
}

Update-MgDevice -DeviceId $deviceId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.device import Device

graph_client = GraphServiceClient(credentials, scopes)

request_body = Device(
	additional_data = {
			"extension_attributes" : {
					"extension_attribute1" : "BYOD-Device",
			},
	}
)

result = await graph_client.devices.by_device_id('device-id').patch(request_body)

応答

HTTP/1.1 204 No Content