Recuperar a política de configuração de um cliente
Aplica-se a: Partner Center
Como recuperar 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 e, em seguida, 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 recuperar uma política de configuração para o cliente especificado, primeiro 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 Get ou GetAsync para recuperar a política de configuração.
IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedConfigurationPolicyId;
ConfigurationPolicy retrievedConfigurationPolicy =
partnerOperations.Customers.ById(selectedCustomerId).ConfigurationPolicies.ById(selectedConfigurationPolicyId).Get();
Exemplo: aplicativo de teste de console. Projeto: Classe de exemplos do SDK do Partner Center: GetConfigurationPolicy.cs
Solicitação REST
Sintaxe da solicitação
Método | URI da solicitação |
---|---|
GET | {baseURL}/v1/customers/{customer-id}/policies/{policy-id} HTTP/1.1 |
Parâmetro do URI
Use os seguintes parâmetros de caminho e consulta 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 em GUID que identifica a política. |
Cabeçalhos de solicitação
Para obter mais informações, confira Cabeçalhos REST do Partner Center.
Corpo da solicitação
Nenhum
Exemplo de solicitação
GET 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: 0
Host: api.partnercenter.microsoft.com
Resposta REST
Se tiver êxito, a resposta conterá o recurso ConfigurationPolicy solicitado.
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: 443
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: ab3abfe7-dce7-46c0-ab20-4fd49bc3e2f7
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 18:08:27 GMT
{
"id": "56edf752-ee77-4fd8-b7f5-df1f74a3a9ac",
"name": "Test policy",
"category": "o_o_b_e",
"description": "Test policy creation from API 1",
"devicesAssigned": 0,
"policySettings": ["skip_express_settings"],
"createdDate": "2017-07-25T11:03:03.8457116-07:00",
"lastModifiedDate": "2017-07-25T11:04:00.8149974-07:00",
"attributes": {
"objectType": "ConfigurationPolicy"
}
}