Обновление политики конфигурации для указанного клиента

Статья
09/11/2024

Область применения: Центр партнеров

Как обновить указанную политику конфигурации для указанного клиента.

Предварительные условия

Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. В этом сценарии поддерживается проверка подлинности с использованием учетных данных автономного приложения и приложения и пользователя.
Идентификатор клиента (customer-tenant-id). Если вы не знаете идентификатор клиента, вы можете найти его в Центре партнеров , выбрав рабочую область Клиенты , а затем клиента в списке клиентов, а затем Учетная запись. На странице Учетная запись клиента найдите идентификатор Майкрософт в разделе Сведения об учетной записи клиента . Идентификатор Майкрософт совпадает с идентификатором клиента (customer-tenant-id).
Идентификатор политики.

C#

Чтобы обновить существующую политику конфигурации для указанного клиента, создайте экземпляр нового объекта ConfigurationPolicy , как показано в следующем фрагменте кода. Значения в этом новом объекте заменяют соответствующие значения в существующем объекте. Затем вызовите метод IAggregatePartner.Customers.ById с идентификатором клиента, чтобы получить интерфейс для операций с указанным клиентом. Затем вызовите метод ConfigurationPolicies.ById с идентификатором политики, чтобы получить интерфейс для операций политики конфигурации для указанной политики. Наконец, вызовите метод Patch или PatchAsync , чтобы обновить политику конфигурации.

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	строка	Да	Строка в формате GUID, определяющая клиент.
policy-id	строка	Да	Строка в формате GUID, идентифицирующая обновляемую политику.

Заголовки запроса

Дополнительные сведения см. в статье о заголовках REST Центра партнеров.

Тело запроса

Текст запроса должен содержать объект , предоставляющий сведения о политике.

Имя	Тип	Обязательно	Обновляется	Описание
идентификатор	строка	Да	Нет	Строка в формате GUID, идентифицирующая политику.
name	строка	Да	Да	Понятное имя политики.
категория	строка	Да	Нет	Категория политики.
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"
    }
}

Поделиться через