创建 deviceManagementSettingDefinitionCreate deviceManagementSettingDefinition

命名空间:microsoft.graphNamespace: microsoft.graph

重要提示: /beta 版本下的 Microsoft Graph API 可能会更改;不支持生产使用。Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

注意: 适用于 Intune 的 Microsoft Graph API 需要适用于租户的 活动 Intune 许可证Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

创建新的 deviceManagementSettingDefinition 对象。Create a new deviceManagementSettingDefinition object.

先决条件Prerequisites

要调用此 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) DeviceManagementConfiguration.ReadWrite.AllDeviceManagementConfiguration.ReadWrite.All
委派(个人 Microsoft 帐户)Delegated (personal Microsoft account) 不支持。Not supported.
应用程序Application DeviceManagementConfiguration.ReadWrite.AllDeviceManagementConfiguration.ReadWrite.All

HTTP 请求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
AuthorizationAuthorization Bearer <token>。必需。Bearer <token> Required.
接受Accept application/jsonapplication/json

请求正文Request body

在请求正文中,提供 deviceManagementSettingDefinition 对象的 JSON 表示形式。In the request body, supply a JSON representation for the deviceManagementSettingDefinition object.

下表显示创建 deviceManagementSettingDefinition 时所需的属性。The following table shows the properties that are required when you create the deviceManagementSettingDefinition.

属性Property 类型Type 说明Description
idid StringString 设置定义的 IDThe ID of the setting definition
valueTypevalueType deviceManangementIntentValueTypedeviceManangementIntentValueType 值的 数据类型。The data type of the value. 可取值为:integerbooleanstringcomplexcollectionabstractComplexPossible values are: integer, boolean, string, complex, collection, abstractComplex.
displayNamedisplayName StringString 设置显示名称The setting's display name
isTopLevelisTopLevel BooleanBoolean 如果设置是顶级设置,则无需封装在集合或复杂设置中即可进行配置If the setting is top level, it can be configured without the need to be wrapped in a collection or complex setting
说明description StringString 设置的说明The setting's description
placeholderTextplaceholderText StringString 占位符文本作为有效输入的示例Placeholder text as an example of valid input
documentationUrldocumentationUrl StringString 设置文档的 URLUrl to setting documentation
headerTitleheaderTitle StringString 设置标头的标题表示设置/设置的类别/部分title of the setting header represents a category/section of a setting/settings
headerSubtitleheaderSubtitle StringString 有关类别/节的更多详细信息,请参阅设置标题的副标题subtitle of the setting header for more details about the category/section
keywordskeywords String collectionString collection 与设置关联的关键字Keywords associated with the setting
约束constraints deviceManagementConstraint 集合deviceManagementConstraint collection 设置值的约束集合Collection of constraints for the setting value
依赖项dependencies deviceManagementSettingDependency 集合deviceManagementSettingDependency collection 其他设置上依赖项的集合Collection of dependencies on other settings

响应Response

如果成功,此方法在响应正文中返回 响应代码和 201 Created deviceManagementSettingDefinition 对象。If successful, this method returns a 201 Created response code and a deviceManagementSettingDefinition 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: 1014

{
  "@odata.type": "#microsoft.graph.deviceManagementSettingDefinition",
  "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"
          ]
        }
      ]
    }
  ]
}

响应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: 1063

{
  "@odata.type": "#microsoft.graph.deviceManagementSettingDefinition",
  "id": "4ec3093d-093d-4ec3-3d09-c34e3d09c34e",
  "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"
          ]
        }
      ]
    }
  ]
}