更新 deviceManagementCollectionSettingDefinitionUpdate deviceManagementCollectionSettingDefinition

命名空间: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.

更新 deviceManagementCollectionSettingDefinition 对象的属性。Update the properties of a deviceManagementCollectionSettingDefinition 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 most to least 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

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

请求标头Request headers

标头Header Value
AuthorizationAuthorization Bearer <token>。必需。Bearer <token> Required.
接受Accept application/jsonapplication/json

请求正文Request body

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

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

属性Property 类型Type 说明Description
idid StringString DeviceManagementSettingDefinition继承的设置定义的 IDThe ID of the setting definition Inherited from deviceManagementSettingDefinition
valueTypevalueType deviceManangementIntentValueTypedeviceManangementIntentValueType 继承自 deviceManagementSettingDefinition的值的数据类型。The data type of the value Inherited from deviceManagementSettingDefinition. 可取值为:integerbooleanstringcomplexcollectionabstractComplexPossible values are: integer, boolean, string, complex, collection, abstractComplex.
displayNamedisplayName StringString 设置的显示名称继承自 deviceManagementSettingDefinitionThe setting's display name Inherited from deviceManagementSettingDefinition
isTopLevelisTopLevel BooleanBoolean 如果设置是顶级的,则可以对其进行配置,而无需将其包装在从DeviceManagementSettingDefinition继承的集合或复杂设置中。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
descriptiondescription StringString 该设置的说明继承自 deviceManagementSettingDefinitionThe setting's description Inherited from deviceManagementSettingDefinition
placeholderTextplaceholderText StringString 占位符文本作为从DeviceManagementSettingDefinition继承的有效输入的示例Placeholder text as an example of valid input Inherited from deviceManagementSettingDefinition
documentationUrldocumentationUrl StringString 设置从DeviceManagementSettingDefinition继承的文档的 UrlUrl to setting documentation Inherited from deviceManagementSettingDefinition
keywordskeywords String collectionString collection 与继承自deviceManagementSettingDefinition的设置关联的关键字Keywords associated with the setting Inherited from deviceManagementSettingDefinition
施加constraints deviceManagementConstraint 集合deviceManagementConstraint collection 继承自deviceManagementSettingDefinition的设置值的约束集合Collection of constraints for the setting value Inherited from deviceManagementSettingDefinition
dependencies deviceManagementSettingDependency 集合deviceManagementSettingDependency collection 继承自deviceManagementSettingDefinition的其他设置的依赖项集合Collection of dependencies on other settings Inherited from deviceManagementSettingDefinition
elementDefinitionIdelementDefinitionId StringString 描述集合的每个元素外观的设置定义 IDThe Setting Definition ID that describes what each element of the collection looks like

响应Response

如果成功,此方法 200 OK 在响应正文中返回响应代码和更新的 deviceManagementCollectionSettingDefinition 对象。If successful, this method returns a 200 OK response code and an updated deviceManagementCollectionSettingDefinition object in the response body.

示例Example

请求Request

下面是一个请求示例。Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/settingDefinitions/{deviceManagementSettingDefinitionId}
Content-type: application/json
Content-length: 995

{
  "@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/",
  "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 200 OK
Content-Type: application/json
Content-Length: 1044

{
  "@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/",
  "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"
}