Atualizar uma política de configuração para o cliente especificado

Artigo
09/11/2024

Aplica-se a: Partner Center

Como atualizar a política de configuração especificada para o cliente especificado.

Pré-requisitos

Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá pesquisá-la no Partner Center selecionando o workspace Clientes , o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente . A ID da Microsoft é igual à ID do cliente (customer-tenant-id).
O identificador de política.

C#

Para atualizar uma política de configuração existente para o cliente especificado, crie uma instância de um novo objeto ConfigurationPolicy , conforme mostrado no snippet de código a seguir. Os valores neste novo objeto substituem os valores correspondentes no objeto existente. Em seguida, chame o método IAggregatePartner.Customers.ById com a ID do cliente para recuperar uma interface para operações no cliente especificado. Em seguida, chame o método ConfigurationPolicies.ById com a ID da política para recuperar uma interface para operações de política de configuração para a política especificada. Por fim, chame o método Patch ou PatchAsync para atualizar a política de configuração.

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

Exemplo: aplicativo de teste do console. Project: Classe de exemplos do SDK do Partner Center: UpdateConfigurationPolicy.cs

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
PUT	{baseURL}/v1/customers/{customer-id}/policies/{policy-id} HTTP/1.1

Parâmetro do URI

Use os seguintes parâmetros de caminho ao criar a solicitação.

Nome	Type	Obrigatório	Descrição
id do cliente	string	Sim	Uma cadeia com formato de GUID que identifica o cliente.
policy-id	string	Sim	Uma cadeia de caracteres formatada por GUID que identifica a política a ser atualizada.

Cabeçalhos de solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

O corpo da solicitação deve conter um objeto que forneça as informações da política.

Nome	Type	Obrigatório	Atualizável	Descrição
id	string	Sim	Não	A cadeia de caracteres formatada por GUID que identifica a política.
name	string	Sim	Sim	O nome amigável da política.
category	string	Sim	Não	A categoria de política.
descrição	string	Não	Sim	A descrição da política.
devicesAssigned	número	Não	Não	O número de dispositivos.
policySettings	Matriz de cadeias de caracteres	Sim	Sim	As configurações de política: "none","remove_oem_preinstalls","oobe_user_not_local_admin","skip_express_settings","skip _oem_registration,"skip_eula".

Exemplo de solicitação

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

Resposta REST

Se tiver êxito, o corpo da resposta conterá o recurso ConfigurationPolicy para a nova política.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplo de resposta

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

Compartilhar via