为指定客户更新配置策略

适用于:合作伙伴中心

如何更新指定客户的指定配置策略。

必备条件

  • 合作伙伴中心身份验证中所述的凭据。 此方案支持使用独立应用和应用+用户凭据进行身份验证。

  • 客户 ID (customer-tenant-id)。 如果不知道客户的 ID,可以通过选择“客户”工作区、客户列表中的“客户”和“帐户”,在合作伙伴中心中查找该 ID。 在客户的“帐户”页上,在“客户帐户信息”部分查找 Microsoft ID。 Microsoft ID 与客户 ID (customer-tenant-id) 相同。

  • 策略标识符。

C#

若要更新指定客户的现有配置策略,请实例化新的 ConfigurationPolicy 对象,如以下代码片段所示。 此新对象中的值将替换现有 对象中的相应值。 然后,使用客户 ID 调用 IAggregatePartner.Customers.ById 方法,以检索对指定客户的操作的接口。 接下来,使用策略 ID 调用 ConfigurationPolicies.ById 方法,以检索指定策略的配置策略操作的接口。 最后,调用 PatchPatchAsync 方法来更新配置策略。

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedConfigurationPolicyId;

ConfigurationPolicy configPolicyToBeUpdated = new ConfigurationPolicy()
{
    Name= "Test Config Policy",
    Id = selectedConfigurationPolicyId,
    PolicySettings = new List<PolicySettingsType>() {
        PolicySettingsType.OobeUserNotLocalAdmin,
        PolicySettingsType.RemoveOemPreinstalls }
};

ConfigurationPolicy updatedConfigurationPolicy =
    partnerOperations.Customers.ById(selectedCustomerId).ConfigurationPolicies.ById(selectedConfigurationPolicyId).Patch(configPolicyToBeUpdated);

示例控制台测试应用项目:合作伙伴中心 SDK 示例 :UpdateConfigurationPolicy.cs

REST 请求

请求语法

方法 请求 URI
PUT {baseURL}/v1/customers/{customer-id}/policies/{policy-id} HTTP/1.1

URI 参数

创建请求时使用以下路径参数。

名称 类型 必须 说明
customer-id string 一个 GUID 格式的字符串,用于标识客户。
policy-id 字符串 标识要更新的策略的 GUID 格式字符串。

请求标头

有关详细信息,请参阅合作伙伴中心 REST 标头

请求正文

请求正文必须包含提供策略信息的对象。

名称 类型 必须 可更新 说明
id string 标识策略的 GUID 格式字符串。
name 字符串 策略的友好名称。
category 字符串 策略类别。
description 字符串 策略说明。
devicesAssigned number 设备数。
policySettings 字符串的数组 策略设置:“none”、“remove_oem_preinstalls”、“oobe_user_not_local_admin”、“skip_express_settings”、“skip _oem_registration”、“skip_eula”。

请求示例

PUT https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/policies/56edf752-ee77-4fd8-b7f5-df1f74a3a9ac HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Length: 256
Content-Type: application/json
Host: api.partnercenter.microsoft.com

{
    "id": "56edf752-ee77-4fd8-b7f5-df1f74a3a9ac",
    "name": "Windows test policy",
    "category": "o_o_b_e",
    "description": "Test policy creation from API",
    "devicesAssigned": 0,
    "policySettings": ["skip_express_settings"]
}

REST 响应

如果成功,响应正文将包含新策略的 ConfigurationPolicy 资源。

响应的成功和错误代码

每个响应都带有一个 HTTP 状态代码,用于指示成功或失败以及其他调试信息。 请使用网络跟踪工具来读取此代码、错误类型和其他参数。 如需完整列表,请参阅合作伙伴中心 REST 错误代码

响应示例

HTTP/1.1 200 OK
Content-Length: 421
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: cb1fa1f3-1381-45d9-99c5-511e5d3efa7c
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 18:10:29 GMT

{
    "id": "56edf752-ee77-4fd8-b7f5-df1f74a3a9ac",
    "name": "Windows test policy",
    "category": "o_o_b_e",
    "description": "Test policy creation from API",
    "devicesAssigned": 0,
    "policySettings": ["skip_express_settings"],
    "createdDate": "2017-01-01T00:00:00",
    "lastModifiedDate": "2017-07-25T18:10:15",
    "attributes": {
        "objectType": "ConfigurationPolicy"
    }
}