groupSetting を取得する

[アーティクル]
11/07/2024

名前空間: microsoft.graph

特定のグループ設定オブジェクトのプロパティを取得します。設定には、テナントレベルまたはグループ固有の設定を指定できます。

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

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

アクセス許可

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

テナント全体の設定を一覧表示する

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

グループ固有の設定を一覧表示する

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

重要

職場または学校アカウントを使用した委任されたシナリオでは、サインインしているユーザーに、サポートされているMicrosoft Entraロールまたはサポートされているロールのアクセス許可を持つカスタムロールを割り当てる必要があります。この操作では、次の最小特権ロールがサポートされています。

テンプレートと設定の設定に関する基本的なプロパティの読み取り - Microsoft Entra参加済みデバイスローカル管理者、ディレクトリリーダー、グローバルリーダー
すべてのグループ/ディレクトリ設定を管理する - ディレクトリライター
グループのグローバル設定とローカル設定を管理する。Group.Unified.GuestとGroup.Unifiedの設定を管理する - 管理者グループ
Password Rule Settingsの更新 - 認証ポリシー管理者
設定の更新、テンプレートと設定の設定に関する基本的なプロパティの読み取り - ユーザー管理者

HTTP 要求

テナント全体の設定を取得します。

GET /groupSettings/{groupSettingId}

グループ固有の設定を取得します。

GET /groups/{groupId}/settings/{groupSettingId}

オプションのクエリパラメーター

このメソッドは、応答のカスタマイズに役立つ $selectOData クエリパラメーターをサポートします。

要求ヘッダー

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

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは応答コード 200 OK を返し、応答本文に groupSetting オブジェクトを返します。

例

例 1: 特定のグループのグループ設定を取得する

要求

GET https://graph.microsoft.com/v1.0/groups/05aa6a98-956a-45c0-b13b-88076a23f2cd/settings/a06fa228-3042-4662-bd09-33e298da1afe


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

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



mgc groups settings get --group-id {group-id} --group-setting-id {groupSetting-id}



// 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"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
settings, err := graphClient.Groups().ByGroupId("group-id").Settings().ByGroupSettingId("groupSetting-id").Get(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

GroupSetting result = graphClient.groups().byGroupId("{group-id}").settings().byGroupSettingId("{groupSetting-id}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

let groupSetting = await client.api('/groups/05aa6a98-956a-45c0-b13b-88076a23f2cd/settings/a06fa228-3042-4662-bd09-33e298da1afe')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->groups()->byGroupId('group-id')->settings()->byGroupSettingId('groupSetting-id')->get()->wait();


Import-Module Microsoft.Graph.Groups

Get-MgGroupSetting -GroupId $groupId -GroupSettingId $groupSettingId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.groups.by_group_id('group-id').settings.by_group_setting_id('groupSetting-id').get()

応答

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "a06fa228-3042-4662-bd09-33e298da1afe",
    "displayName": "Group.Unified.Guest",
    "templateId": "08d542b9-071f-4e16-94b0-74abb372e3d9",
    "values": [
        {
            "name": "AllowToAddGuests",
            "value": "false"
        }
    ]
}

例 2: すべての Microsoft 365 グループのグループ設定を取得する

要求

GET https://graph.microsoft.com/v1.0/groupSettings/84af2ca5-c274-41bf-86e4-6e374ec4def6


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

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



mgc group-settings get --group-setting-id {groupSetting-id}



// 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"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
groupSettings, err := graphClient.GroupSettings().ByGroupSettingId("groupSetting-id").Get(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

GroupSetting result = graphClient.groupSettings().byGroupSettingId("{groupSetting-id}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

let groupSetting = await client.api('/groupSettings/84af2ca5-c274-41bf-86e4-6e374ec4def6')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->groupSettings()->byGroupSettingId('groupSetting-id')->get()->wait();

Snippet not available


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.group_settings.by_group_setting_id('groupSetting-id').get()

応答

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groupSettings/$entity",
    "id": "84af2ca5-c274-41bf-86e4-6e374ec4def6",
    "displayName": "Group.Unified",
    "templateId": "62375ab9-6b52-47ed-826b-58e47e0e304b",
    "values": [
        {
            "name": "EnableMIPLabels",
            "value": "true"
        },
        {
            "name": "CustomBlockedWordsList",
            "value": ""
        },
        {
            "name": "EnableMSStandardBlockedWords",
            "value": "true"
        },
        {
            "name": "ClassificationDescriptions",
            "value": ""
        },
        {
            "name": "DefaultClassification",
            "value": ""
        },
        {
            "name": "PrefixSuffixNamingRequirement",
            "value": "[Contoso-][GroupName]"
        },
        {
            "name": "AllowGuestsToBeGroupOwner",
            "value": "false"
        },
        {
            "name": "AllowGuestsToAccessGroups",
            "value": "true"
        },
        {
            "name": "GuestUsageGuidelinesUrl",
            "value": "https://privacy.contoso.com/privacystatement"
        },
        {
            "name": "GroupCreationAllowedGroupId",
            "value": ""
        },
        {
            "name": "AllowToAddGuests",
            "value": "true"
        },
        {
            "name": "UsageGuidelinesUrl",
            "value": ""
        },
        {
            "name": "ClassificationList",
            "value": ""
        },
        {
            "name": "EnableGroupCreation",
            "value": "true"
        }
    ]
}

次の方法で共有

groupSetting を取得する

アクセス許可

テナント全体の設定を一覧表示する

グループ固有の設定を一覧表示する

HTTP 要求

オプションのクエリパラメーター

要求ヘッダー

要求本文

応答

例

例 1: 特定のグループのグループ設定を取得する

要求

応答

例 2: すべての Microsoft 365 グループのグループ設定を取得する

要求

応答

フィードバック

その他のリソース

次の方法で共有

groupSetting を取得する

アクセス許可

テナント全体の設定を一覧表示する

グループ固有の設定を一覧表示する

HTTP 要求

オプションのクエリ パラメーター

要求ヘッダー

要求本文

応答

例

例 1: 特定のグループのグループ設定を取得する

要求

応答

例 2: すべての Microsoft 365 グループのグループ設定を取得する

要求

応答

フィードバック

その他のリソース

オプションのクエリパラメーター