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

Aplica-se a: Centro de Parceiros

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

Pré-requisitos

  • Credenciais conforme descrito na autenticação do Centro de Parceiros. Este cenário suporta a autenticação com credenciais autónomas da Aplicação e da Aplicação+Utilizador.

  • Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Centro de Parceiros selecionando a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure o ID Microsoft na secção Informações da Conta de Cliente . O ID da Microsoft é o mesmo que o 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, instanciar um novo objeto ConfigurationPolicy , conforme mostrado no fragmento de código seguinte. Os valores neste novo objeto substituem os valores correspondentes no objeto existente. Em seguida, chame o método IAggregatePartner.Customers.ById com o ID do cliente para obter uma interface para operações no cliente especificado. Em seguida, chame o método ConfigurationPolicies.ById com o ID de política para obter 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: aplicação de teste da consola. Project: Classe de Exemplos do SDK do Centro de Parceiros: UpdateConfigurationPolicy.cs

Pedido REST

Sintaxe do pedido

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

Parâmetro URI

Utilize os seguintes parâmetros de caminho ao criar o pedido.

Nome Tipo Necessário Descrição
customer-id string Yes Uma cadeia formatada por GUID que identifica o cliente.
policy-id string Yes Uma cadeia formatada por GUID que identifica a política a atualizar.

Cabeçalhos do pedido

Para obter mais informações, veja Cabeçalhos REST do Centro de Parceiros.

Corpo do pedido

O corpo do pedido tem de conter um objeto que forneça as informações da política.

Nome Tipo Necessário Atualizável Descrição
ID string Yes Não A cadeia formatada por GUID que identifica a política.
name string Yes Sim O nome amigável da política.
categoria string Yes Não A categoria de política.
descrição cadeia (de carateres) No Sim A descrição da política.
dispositivos Atribuídos número No Não O número de dispositivos.
policySettings matriz de cadeias (de carateres) Sim Sim As definições de política: "none", "remove_oem_preinstalls", "oobe_user_not_local_admin", "skip_express_settings", "skip _oem_registration",skip_eula".

Exemplo de pedido

PUT https://api.partnercenter.microsoft.com/v1/customers/aaaabbbb-0000-cccc-1111-dddd2222eeee/policies/bbbbcccc-1111-dddd-2222-eeee3333ffff 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": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "name": "Windows test policy",
    "category": "o_o_b_e",
    "description": "Test policy creation from API",
    "devicesAssigned": 0,
    "policySettings": ["skip_express_settings"]
}

Resposta do REST

Se for bem-sucedido, o corpo da resposta contém o recurso ConfigurationPolicy para a nova política.

Códigos de erro e êxito da resposta

Cada resposta inclui um código de estado HTTP que indica êxito ou falha e informações adicionais de depuração. Utilize uma ferramenta de rastreio de rede para ler este código, tipo de erro e parâmetros adicionais. Para obter a lista completa, veja Códigos de erro REST do Centro de Parceiros.

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": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "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"
    }
}
  • Last updated on