Create deviceManagementCollectionSettingDefinition

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

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

Create a new deviceManagementCollectionSettingDefinition object.

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

HTTP Request

POST /deviceManagement/settingDefinitions
POST /deviceManagement/categories/{deviceManagementSettingCategoryId}/settingDefinitions
POST /deviceManagement/intents/{deviceManagementIntentId}/categories/{deviceManagementIntentSettingCategoryId}/settingDefinitions
POST /deviceManagement/templates/{deviceManagementTemplateId}/categories/{deviceManagementTemplateSettingCategoryId}/settingDefinitions

Request headers

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

Request body

In the request body, supply a JSON representation for the deviceManagementCollectionSettingDefinition object.

The following table shows the properties that are required when you create the deviceManagementCollectionSettingDefinition.

Property	Type	Description
id	String	The ID of the setting definition Inherited from deviceManagementSettingDefinition
valueType	deviceManangementIntentValueType	The data type of the value Inherited from deviceManagementSettingDefinition. Possible values are: integer, boolean, string, complex, collection, abstractComplex.
displayName	String	The setting's display name Inherited from deviceManagementSettingDefinition
isTopLevel	Boolean	If the setting is top level, it can be configured without the need to be wrapped in a collection or complex setting Inherited from deviceManagementSettingDefinition
description	String	The setting's description Inherited from deviceManagementSettingDefinition
placeholderText	String	Placeholder text as an example of valid input Inherited from deviceManagementSettingDefinition
documentationUrl	String	Url to setting documentation Inherited from deviceManagementSettingDefinition
headerTitle	String	title of the setting header represents a category/section of a setting/settings Inherited from deviceManagementSettingDefinition
headerSubtitle	String	subtitle of the setting header for more details about the category/section Inherited from deviceManagementSettingDefinition
keywords	String collection	Keywords associated with the setting Inherited from deviceManagementSettingDefinition
constraints	deviceManagementConstraint collection	Collection of constraints for the setting value Inherited from deviceManagementSettingDefinition
dependencies	deviceManagementSettingDependency collection	Collection of dependencies on other settings Inherited from deviceManagementSettingDefinition
elementDefinitionId	String	The Setting Definition ID that describes what each element of the collection looks like

Response

If successful, this method returns a 201 Created response code and a deviceManagementCollectionSettingDefinition object in the response body.

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceManagement/settingDefinitions
Content-type: application/json
Content-length: 1081

{
  "@odata.type": "#microsoft.graph.deviceManagementCollectionSettingDefinition",
  "valueType": "boolean",
  "displayName": "Display Name value",
  "isTopLevel": true,
  "description": "Description value",
  "placeholderText": "Placeholder Text value",
  "documentationUrl": "https://example.com/documentationUrl/",
  "headerTitle": "Header Title value",
  "headerSubtitle": "Header Subtitle value",
  "keywords": [
    "Keywords value"
  ],
  "constraints": [
    {
      "@odata.type": "microsoft.graph.deviceManagementSettingAppConstraint",
      "supportedTypes": [
        "Supported Types value"
      ]
    }
  ],
  "dependencies": [
    {
      "@odata.type": "microsoft.graph.deviceManagementSettingDependency",
      "definitionId": "Definition Id value",
      "constraints": [
        {
          "@odata.type": "microsoft.graph.deviceManagementSettingAppConstraint",
          "supportedTypes": [
            "Supported Types value"
          ]
        }
      ]
    }
  ],
  "elementDefinitionId": "Element Definition Id value"
}

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: 1130

{
  "@odata.type": "#microsoft.graph.deviceManagementCollectionSettingDefinition",
  "id": "0419c4a7-c4a7-0419-a7c4-1904a7c41904",
  "valueType": "boolean",
  "displayName": "Display Name value",
  "isTopLevel": true,
  "description": "Description value",
  "placeholderText": "Placeholder Text value",
  "documentationUrl": "https://example.com/documentationUrl/",
  "headerTitle": "Header Title value",
  "headerSubtitle": "Header Subtitle value",
  "keywords": [
    "Keywords value"
  ],
  "constraints": [
    {
      "@odata.type": "microsoft.graph.deviceManagementSettingAppConstraint",
      "supportedTypes": [
        "Supported Types value"
      ]
    }
  ],
  "dependencies": [
    {
      "@odata.type": "microsoft.graph.deviceManagementSettingDependency",
      "definitionId": "Definition Id value",
      "constraints": [
        {
          "@odata.type": "microsoft.graph.deviceManagementSettingAppConstraint",
          "supportedTypes": [
            "Supported Types value"
          ]
        }
      ]
    }
  ],
  "elementDefinitionId": "Element Definition Id value"
}