ディレクトリの更新設定

[アーティクル]
03/05/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

特定のディレクトリ設定オブジェクトのプロパティを更新します。

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

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

アクセス許可

次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可またはアクセス許可を示しています。ベストプラクティスに従って、最小限の特権のアクセス許可を要求します。委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。これらのアクセス許可の詳細については、アクセス許可のリファレンスを参照してください。

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

"同意ポリシー設定" directorySetting オブジェクトを更新するには、次のアクセス許可が必要です。

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

委任されたシナリオの場合、呼び出し元のユーザーには、次のMicrosoft Entraロールの少なくとも 1 つが必要です。

Microsoft Entraロール	許可される特権
参加済みデバイスローカル管理者のMicrosoft Entra ディレクトリリーダーグローバル閲覧者	テンプレートと設定の設定に関する基本的なプロパティの読み取り
グループ管理者ディレクトリ製作者	すべてのグループ設定を管理する
認証ポリシー管理者	更新 `Password Rule Settings`
ユーザー管理者	テンプレートと設定の設定に関する基本的なプロパティの読み取り設定を更新する

HTTP 要求

テナント全体の設定を更新します。

PATCH /settings/{directorySettingId}

グループ固有の設定を更新します。

PATCH /groups/{groupId}/settings/{directorySettingId}

オプションの要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。

要求本文

要求本文で、更新する関連フィールドの値を指定します。

プロパティ	型	説明
values	settingValue コレクション	更新された値のセット。注: コレクションセット全体を指定する必要があります。 1 つの値セットを更新することはできません。

応答

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

例

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/beta/settings/3c105fc3-2254-4861-9e2d-d59e2126f3ef
Content-type: application/json

{
    "values": [
        {
            "name": "CustomBlockedWordsList",
            "value": "Contoso"
        }
    ]
}


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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new DirectorySetting
{
	Values = new List<SettingValue>
	{
		new SettingValue
		{
			Name = "CustomBlockedWordsList",
			Value = "Contoso",
		},
	},
};

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

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta settings patch --directory-setting-id {directorySetting-id} --body '{\
    "values": [\
        {\
            "name": "CustomBlockedWordsList",\
            "value": "Contoso"\
        }\
    ]\
}\
'

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewDirectorySetting()


settingValue := graphmodels.NewSettingValue()
name := "CustomBlockedWordsList"
settingValue.SetName(&name) 
value := "Contoso"
settingValue.SetValue(&value) 

values := []graphmodels.SettingValueable {
	settingValue,
}
requestBody.SetValues(values)

settings, err := graphClient.Settings().ByDirectorySettingId("directorySetting-id").Patch(context.Background(), requestBody, nil)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DirectorySetting directorySetting = new DirectorySetting();
LinkedList<SettingValue> values = new LinkedList<SettingValue>();
SettingValue settingValue = new SettingValue();
settingValue.setName("CustomBlockedWordsList");
settingValue.setValue("Contoso");
values.add(settingValue);
directorySetting.setValues(values);
DirectorySetting result = graphClient.settings().byDirectorySettingId("{directorySetting-id}").patch(directorySetting);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const directorySetting = {
    values: [
        {
            name: 'CustomBlockedWordsList',
            value: 'Contoso'
        }
    ]
};

await client.api('/settings/3c105fc3-2254-4861-9e2d-d59e2126f3ef')
	.version('beta')
	.update(directorySetting);

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\DirectorySetting;
use Microsoft\Graph\Generated\Models\SettingValue;


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

$requestBody = new DirectorySetting();
$valuesSettingValue1 = new SettingValue();
$valuesSettingValue1->setName('CustomBlockedWordsList');
$valuesSettingValue1->setValue('Contoso');
$valuesArray []= $valuesSettingValue1;
$requestBody->setValues($valuesArray);


$result = $graphServiceClient->settings()->byDirectorySettingId('directorySetting-id')->patch($requestBody)->wait();

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	values = @(
		@{
			name = "CustomBlockedWordsList"
			value = "Contoso"
		}
	)
}

Update-MgBetaDirectorySetting -DirectorySettingId $directorySettingId -BodyParameter $params

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


from msgraph import GraphServiceClient
from msgraph.generated.models.directory_setting import DirectorySetting
from msgraph.generated.models.setting_value import SettingValue

graph_client = GraphServiceClient(credentials, scopes)

request_body = DirectorySetting(
	values = [
		SettingValue(
			name = "CustomBlockedWordsList",
			value = "Contoso",
		),
	],
)

result = await graph_client.settings.by_directory_setting_id('directorySetting-id').patch(request_body)

重要

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

HTTP/1.1 204 No Content

ディレクトリの更新設定

アクセス許可

HTTP 要求

オプションの要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース

ディレクトリの更新設定

アクセス許可

同意ポリシー設定オブジェクトを除くすべての設定

同意ポリシー設定オブジェクトの場合

HTTP 要求

オプションの要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース