Endpoints - Purge Content

Service:

Front Door Service

API Version:

2019-05-01

Removes a content from Front Door.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge?api-version=2019-05-01

URI Parameters

Name	In	Required	Type	Description
frontDoorName	path	True	string	Name of the Front Door which is globally unique. Regex pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Request Body

Name	Required	Type	Description
contentPaths	True	string[]	The path to the content to be purged. Can describe a file path or a wild card directory.

Responses

Name	Type	Description
200 OK		OK. The request has succeeded.
202 Accepted		Accepted and the operation will complete asynchronously.
Other Status Codes	ErrorResponse	Front Door 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

Purge content from Front Door

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/purge?api-version=2019-05-01

{
  "contentPaths": [
    "/pictures.aspx",
    "/pictures/*"
  ]
}

Sample Response

Status code:

200

Status code:

202

Definitions

Name	Description
ErrorResponse	Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
PurgeParameters	Parameters required for content purge.

ErrorResponse

Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

PurgeParameters

Parameters required for content purge.

Name	Type	Description
contentPaths	string[]	The path to the content to be purged. Can describe a file path or a wild card directory.