Product - Delete
Delete product.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?api-version=2021-08-01
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}?deleteSubscriptions={deleteSubscriptions}&api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
product
|
path | True |
string |
Product identifier. Must be unique in the current API Management service instance. |
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
delete
|
query |
boolean |
Delete existing subscriptions associated with the product or not. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
If-Match | True |
string |
ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Product was successfully removed. |
|
204 No Content |
Product was successfully removed by previous request or does not exist. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
ApiManagementDeleteProduct
Sample request
Sample response
Definitions
Name | Description |
---|---|
Error |
Error Field contract. |
Error |
Error Response. |
ErrorFieldContract
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |