ディレクトリ設定を作成するCreate a directory setting

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

この API を使用して、directorySettingTemplates で利用可能なテンプレートに基づいて新しい設定を作成します。Use this API to create a new setting, based on the templates available in directorySettingTemplates. これらの設定は、テナントレベルまたはオブジェクトレベルで行うことができます (現在はグループに対してのみ)。These settings can be at the tenant-level or at an object level (currently only for groups). 作成要求では、テンプレートで定義されているすべての設定の settingValues を指定する必要があります。The creation request must provide settingValues for all the settings defined in the template. グループ固有の設定では、グループのメンバーがゲストユーザーを招待できるかどうかを制御する設定のみが可能です。For group-specific settings, only the setting governing whether members of a group can invite guest users can be set. これは、グループにゲストユーザーを追加する機能が一般に利用可能になったときに、この動作を制御します。This will govern this behavior once the ability to add guest users to a group is generally available.

: この API のベータ版は、グループにのみ適用されます。Note: The /beta version of this API is only applies to groups. この API の/v1.0 バージョンが、 groupSettings を作成する名前に変更されました。The /v1.0 version of this API has been renamed to Create groupSettings.

テンプレートと、ベータ版でサポートされているプロパティの一覧については、 Directorysettingtemplate クエリを使用してください。For a list of templates and the properties they support in beta, use a directorySettingTemplate query. (V2.0 エンドポイントの場合は、[ Groupsettingtemplates] を呼び出します)。(For v1.0 endpoints, call groupSettingTemplates.)

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。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) Directory.ReadWrite.All、Directory.AccessAsUser.AllDirectory.ReadWrite.All, Directory.AccessAsUser.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication Directory.ReadWrite.AllDirectory.ReadWrite.All

HTTP 要求HTTP request

POST /settings
POST /groups/{id}/settings

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

要求本文で、 Directorysettingオブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of directorySetting object. ただし、設定の表示名は、参照される設定テンプレート名に基づいて設定されます。However, the display name for the setting will be set based on the referenced settings template name.

応答Response

成功した場合、この201 Createdメソッドは応答コードと、応答本文でdirectorysettingオブジェクトを返します。If successful, this method returns 201 Created response code and directorySetting object in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

POST https://graph.microsoft.com/beta/settings
Content-type: application/json
Content-length: 222

{
  "templateId": "templateId-value",
  "values": [
    {
      "name": "name-value",
      "value": "value-value"
    }
  ]
}

要求本文で、 Directorysettingオブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation of directorySetting object.

応答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 201 Created
Content-type: application/json
Content-length: 244

{
    "@odata.context": "https://graph.microsoft.com/stagingbeta/$metadata#settings/$entity",
    "id": "id-value",
    "displayName": "displayName-value",
    "templateId": "templateId-value",
    "values": [
      {
        "name": "name-value",
        "value": "value-value"
      }
    ]
}

SDK サンプル コードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var directorySetting = new DirectorySetting
{
    TemplateId = "templateId-value",
    Values = new List<SettingValue>()
    {
        new SettingValue
        {
            Name = "name-value",
            Value = "value-value"
        }
    }
};

await graphClient.Settings
    .Request()
    .AddAsync(directorySetting);

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.