Delete a configuration policy for the specified customer
Applies to: Partner Center
How to delete a configuration policy for a specified customer and policy identifier.
Prerequisites
Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
A customer ID (
customer-tenant-id
). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id
).The policy identifier.
C#
To delete a configuration policy for a specified customer:
Call the IAggregatePartner.Customers.ById method with the customer ID to retrieve an interface to operations on the specified customer.
Call the ConfigurationPolicies.ById method with the policy ID to retrieve an interface to configuration policy operations for the specified policy.
Call the Delete or DeleteAsync method to delete the configuration policy.
IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedPolicyId;
partnerOperations.Customers.ById(selectedCustomerId).ConfigurationPolicies.ById(selectedPolicyId).Delete();
Sample: Console test app. Project: Partner Center SDK Samples Class: DeleteConfigurationPolicy.cs
REST request
Request syntax
Method | Request URI |
---|---|
DELETE | {baseURL}/v1/customers/{customer-id}/policies/{policy-id} HTTP/1.1 |
URI parameters
Use the following path parameters when creating the request.
Name | Type | Required | Description |
---|---|---|---|
customer-id | string | Yes | A GUID-formatted string that identifies the customer. |
policy-id | string | Yes | A GUID-formatted string that identifies the policy to delete. |
Request headers
For more information, see Partner Center REST headers.
Request body
None
Request example
DELETE https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/policies/56edf752-ee77-4fd8-b7f5-df1f74a3a9ac HTTP/1.1
Authorization: Bearer <token>
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Length: 0
Content-Type: application/json
Host: api.partnercenter.microsoft.com
REST response
If successful, the response returns a 204 No Content status code.
Response success and error codes
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters. For the full list, see Partner Center REST error codes.
Response example
HTTP/1.1 204 No Content
Content-Length: 0
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 76b6f317-1da1-4b61-a6fd-9952439a2c46
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 18:10:41 GMT