Actualizar una directiva de configuración para el cliente especificado

Artículo
09/11/2024

Se aplica a: Centro de partners

Cómo actualizar la directiva de configuración especificada para el cliente especificado.

Requisitos previos

Credenciales tal como se describen en el artículo Autenticación del Centro de partners. Este escenario admite la autenticación con las credenciales de aplicación independiente y app+usuario.
Un id. de cliente (customer-tenant-id). Si no conoce el identificador del cliente, puede buscarlo en el Centro de partners si selecciona el área de trabajo Clientes , el cliente de la lista de clientes y, a continuación, cuenta. En la página Cuenta del cliente, busque el identificador de Microsoft en la sección Información de la cuenta de cliente . El id. de Microsoft es el mismo que el de cliente (customer-tenant-id).
Identificador de directiva.

C#

Para actualizar una directiva de configuración existente para el cliente especificado, cree una instancia de un nuevo objeto ConfigurationPolicy como se muestra en el siguiente fragmento de código. Los valores de este nuevo objeto reemplazan los valores correspondientes del objeto existente. A continuación, llame al método IAggregatePartner.Customers.ById con el identificador de cliente para recuperar una interfaz a las operaciones del cliente especificado. A continuación, llame al método ConfigurationPolicies.ById con el identificador de directiva para recuperar una interfaz para las operaciones de directiva de configuración de la directiva especificada. Por último, llame al método Patch o PatchAsync para actualizar la directiva de configuración.

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);

Ejemplo: Aplicación de prueba de consola. Project: Clase de ejemplos del SDK del Centro de partners: UpdateConfigurationPolicy.cs

Solicitud REST

Sintaxis de la solicitud

Método	URI de solicitud
PUT	{baseURL}/v1/customers/{customer-id}/policies/{policy-id} HTTP/1.1

Parámetro de URI

Use los siguientes parámetros de ruta de acceso al crear la solicitud.

Nombre	Tipo	Obligatorio	Descripción
customer-id	string	Sí	Cadena con formato de GUID que identifica al cliente.
policy-id	string	Sí	Cadena con formato GUID que identifica la directiva que se va a actualizar.

Encabezados de solicitud

Para obtener más información, consulta Encabezados REST del Centro de partners.

Cuerpo de la solicitud

El cuerpo de la solicitud debe contener un objeto que proporcione la información de la directiva.

Nombre	Tipo	Obligatorio	Actualizable	Descripción
id	string	Sí	No	Cadena con formato GUID que identifica la directiva.
name	string	Sí	Sí	Nombre descriptivo de la directiva.
category	string	Sí	No	Categoría de directiva.
description	string	No	Sí	Descripción de la directiva.
devicesAssigned	number	No	No	Número de dispositivos.
policySettings	Matriz de cadenas	Sí	Sí	La configuración de directiva: "none","remove_oem_preinstalls","oobe_user_not_local_admin","skip_express_settings","skip _oem_registration,"skip_eula".

Ejemplo de solicitud

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"]
}

Respuesta REST

Si se ejecuta correctamente, el cuerpo de la respuesta contiene el recurso ConfigurationPolicy para la nueva directiva.

Códigos de error y de respuesta correctos

Cada respuesta incluye un código de estado HTTP que indica si la operación se ha realizado correctamente o con errores y proporciona información de depuración adicional. Use una herramienta de seguimiento de red para leer este código, el tipo de error y los parámetros adicionales. Para obtener la lista completa, consulta Códigos de error de REST del Centro de partners.

Ejemplo de respuesta

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"
    }
}

Compartir a través de