Edit

Share via

Create deviceManagementConfigurationSettingGroupCollectionDefinition

  • Article

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 deviceManagementConfigurationSettingGroupCollectionDefinition object.

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

HTTP Request

POST /deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfigurationId}/settings/{deviceManagementConfigurationSettingId}/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 deviceManagementConfigurationSettingGroupCollectionDefinition object.

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

Property Type Description
applicability deviceManagementConfigurationSettingApplicability Details which device setting is applicable on Inherited from deviceManagementConfigurationSettingDefinition
accessTypes deviceManagementConfigurationSettingAccessTypes Read/write access mode of the setting Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: none, add, copy, delete, get, replace, execute.
keywords String collection Tokens which to search settings on Inherited from deviceManagementConfigurationSettingDefinition
infoUrls String collection List of links more info for the setting can be found at Inherited from deviceManagementConfigurationSettingDefinition
occurrence deviceManagementConfigurationSettingOccurrence Indicates whether the setting is required or not Inherited from deviceManagementConfigurationSettingDefinition
baseUri String Base CSP Path Inherited from deviceManagementConfigurationSettingDefinition
offsetUri String Offset CSP Path from Base Inherited from deviceManagementConfigurationSettingDefinition
rootDefinitionId String Root setting definition if the setting is a child setting. Inherited from deviceManagementConfigurationSettingDefinition
categoryId String Specifies the area group under which the setting is configured in a specified configuration service provider (CSP) Inherited from deviceManagementConfigurationSettingDefinition
settingUsage deviceManagementConfigurationSettingUsage Setting type, for example, configuration and compliance Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: none, configuration, compliance.
uxBehavior deviceManagementConfigurationControlType Setting control type representation in the UX Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: default, dropdown, smallTextBox, largeTextBox, toggle, multiheaderGrid, contextPane.
visibility deviceManagementConfigurationSettingVisibility Setting visibility scope to UX Inherited from deviceManagementConfigurationSettingDefinition. Possible values are: none, settingsCatalog, template.
referredSettingInformationList deviceManagementConfigurationReferredSettingInformation collection List of referred setting information. Inherited from deviceManagementConfigurationSettingDefinition
id String Identifier for item Inherited from deviceManagementConfigurationSettingDefinition
description String Description of the item Inherited from deviceManagementConfigurationSettingDefinition
helpText String Help text of the item Inherited from deviceManagementConfigurationSettingDefinition
name String Name of the item Inherited from deviceManagementConfigurationSettingDefinition
displayName String Display name of the item Inherited from deviceManagementConfigurationSettingDefinition
version String Item Version Inherited from deviceManagementConfigurationSettingDefinition
childIds String collection Dependent child settings to this group of settings Inherited from deviceManagementConfigurationSettingGroupDefinition
dependentOn deviceManagementConfigurationDependentOn collection List of Dependencies for the setting group Inherited from deviceManagementConfigurationSettingGroupDefinition
dependedOnBy deviceManagementConfigurationSettingDependedOnBy collection List of child settings that depend on this setting Inherited from deviceManagementConfigurationSettingGroupDefinition
maximumCount Int32 Maximum number of setting group count in the collection
minimumCount Int32 Minimum number of setting group count in the collection

Response

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

Example

Request

Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceAppManagement/targetedManagedAppConfigurations/{targetedManagedAppConfigurationId}/settings/{deviceManagementConfigurationSettingId}/settingDefinitions
Content-type: application/json
Content-length: 1787

{
  "@odata.type": "#microsoft.graph.deviceManagementConfigurationSettingGroupCollectionDefinition",
  "applicability": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingApplicability",
    "description": "Description value",
    "platform": "android",
    "deviceMode": "kiosk",
    "technologies": "mdm"
  },
  "accessTypes": "add",
  "keywords": [
    "Keywords value"
  ],
  "infoUrls": [
    "Info Urls value"
  ],
  "occurrence": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingOccurrence",
    "minDeviceOccurrence": 3,
    "maxDeviceOccurrence": 3
  },
  "baseUri": "Base Uri value",
  "offsetUri": "Offset Uri value",
  "rootDefinitionId": "Root Definition Id value",
  "categoryId": "Category Id value",
  "settingUsage": "configuration",
  "uxBehavior": "dropdown",
  "visibility": "settingsCatalog",
  "referredSettingInformationList": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationReferredSettingInformation",
      "settingDefinitionId": "Setting Definition Id value"
    }
  ],
  "description": "Description value",
  "helpText": "Help Text value",
  "name": "Name value",
  "displayName": "Display Name value",
  "version": "Version value",
  "childIds": [
    "Child Ids value"
  ],
  "dependentOn": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationDependentOn",
      "dependentOn": "Dependent On value",
      "parentSettingId": "Parent Setting Id value"
    }
  ],
  "dependedOnBy": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingDependedOnBy",
      "dependedOnBy": "Depended On By value",
      "required": true
    }
  ],
  "maximumCount": 12,
  "minimumCount": 12
}

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

{
  "@odata.type": "#microsoft.graph.deviceManagementConfigurationSettingGroupCollectionDefinition",
  "applicability": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingApplicability",
    "description": "Description value",
    "platform": "android",
    "deviceMode": "kiosk",
    "technologies": "mdm"
  },
  "accessTypes": "add",
  "keywords": [
    "Keywords value"
  ],
  "infoUrls": [
    "Info Urls value"
  ],
  "occurrence": {
    "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingOccurrence",
    "minDeviceOccurrence": 3,
    "maxDeviceOccurrence": 3
  },
  "baseUri": "Base Uri value",
  "offsetUri": "Offset Uri value",
  "rootDefinitionId": "Root Definition Id value",
  "categoryId": "Category Id value",
  "settingUsage": "configuration",
  "uxBehavior": "dropdown",
  "visibility": "settingsCatalog",
  "referredSettingInformationList": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationReferredSettingInformation",
      "settingDefinitionId": "Setting Definition Id value"
    }
  ],
  "id": "739da194-a194-739d-94a1-9d7394a19d73",
  "description": "Description value",
  "helpText": "Help Text value",
  "name": "Name value",
  "displayName": "Display Name value",
  "version": "Version value",
  "childIds": [
    "Child Ids value"
  ],
  "dependentOn": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationDependentOn",
      "dependentOn": "Dependent On value",
      "parentSettingId": "Parent Setting Id value"
    }
  ],
  "dependedOnBy": [
    {
      "@odata.type": "microsoft.graph.deviceManagementConfigurationSettingDependedOnBy",
      "dependedOnBy": "Depended On By value",
      "required": true
    }
  ],
  "maximumCount": 12,
  "minimumCount": 12
}