The Microsoft Azure CDN Management Client is a tool that allows users to easily manage their content delivery network (CDN) resources within the Azure platform. With this client, users can create, update, and delete CDN profiles, endpoints, and custom domains. They can also configure caching rules, set up load balancing, and monitor the performance of their CDN resources.
swagger: '2.0'
info:
version: 2023-07-01-preview
title: Microsoft Azure CdnManagementClient
description: >-
Use these APIs to manage Azure CDN resources through the Azure Resource
Manager. You must make sure that requests made to these resources are
secure.
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow.
scopes:
user_impersonation: impersonate your user account
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles:
get:
tags:
- Profiles
description: >-
Lists all of the Azure Front Door Standard, Azure Front Door Premium,
and CDN profiles within an Azure subscription.
operationId: microsoftAzureProfilesList
x-ms-examples:
Profiles_List:
$ref: ./examples/Profiles_List.json
parameters:
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/ProfileListResult'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Cdn Profiles
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles:
get:
tags:
- Profiles
description: >-
Lists all of the Azure Front Door Standard, Azure Front Door Premium,
and CDN profiles within a resource group.
operationId: microsoftAzureProfilesListbyresourcegroup
x-ms-examples:
Profiles_ListByResourceGroup:
$ref: ./examples/Profiles_ListByResourceGroup.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/ProfileListResult'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}:
get:
tags:
- Profiles
description: >-
Gets an Azure Front Door Standard or Azure Front Door Premium or CDN
profile with the specified profile name under the specified subscription
and resource group.
operationId: microsoftAzureProfilesGet
x-ms-examples:
Profiles_Get:
$ref: ./examples/Profiles_Get.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: >-
Name of the Azure Front Door Standard or Azure Front Door Premium or
CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Profile'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename
put:
tags:
- Profiles
description: >-
Creates a new Azure Front Door Standard or Azure Front Door Premium or
CDN profile with a profile name under the specified subscription and
resource group.
operationId: microsoftAzureProfilesCreate
x-ms-examples:
Profiles_Create:
$ref: ./examples/Profiles_Create.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: >-
Name of the Azure Front Door Standard or Azure Front Door Premium or
CDN profile which is unique within the resource group.
required: true
type: string
- description: Profile properties needed to create a new profile.
in: body
name: profile
required: true
schema:
$ref: '#/definitions/Profile'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Profile'
'201':
description: >-
Created. The request has been fulfilled and a new profile has been
created.
schema:
$ref: '#/definitions/Profile'
'202':
description: >-
Accepted. The request has been accepted for processing and the
operation will complete asynchronously.
headers:
location:
type: string
schema:
$ref: '#/definitions/Profile'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename
patch:
tags:
- Profiles
description: >-
Updates an existing Azure Front Door Standard or Azure Front Door
Premium or CDN profile with the specified profile name under the
specified subscription and resource group.
operationId: microsoftAzureProfilesUpdate
x-ms-examples:
Profiles_Update:
$ref: ./examples/Profiles_Update.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: >-
Name of the Azure Front Door Standard or Azure Front Door Premium or
CDN profile which is unique within the resource group.
required: true
type: string
- name: profileUpdateParameters
in: body
description: Profile properties needed to update an existing profile.
required: true
schema:
$ref: '#/definitions/ProfileUpdateParameters'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Profile'
'202':
description: >-
Accepted. The request has been accepted for processing and the
operation will complete asynchronously.
headers:
location:
type: string
schema:
$ref: '#/definitions/Profile'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename
delete:
tags:
- Profiles
description: >-
Deletes an existing Azure Front Door Standard or Azure Front Door
Premium or CDN profile with the specified parameters. Deleting a profile
will result in the deletion of all of the sub-resources including
endpoints, origins and custom domains.
operationId: microsoftAzureProfilesDelete
x-ms-examples:
Profiles_Delete:
$ref: ./examples/Profiles_Delete.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: >-
Name of the Azure Front Door Standard or Azure Front Door Premium or
CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
'202':
description: >-
Accepted. The request has been accepted for processing and the
operation will complete asynchronously.
headers:
location:
type: string
'204':
description: >-
No Content. The request has been accepted but the profile was not
found.
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate:
post:
tags:
- Profiles
description: >-
Checks if CDN profile can be migrated to Azure
Frontdoor(Standard/Premium) profile.
operationId: microsoftAzureProfilesCanmigrate
x-ms-examples:
Profiles_CanMigrate:
$ref: ./examples/Profiles_CanMigrate.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
- description: >-
Properties needed to check if cdn profile or classic frontdoor can
be migrated.
in: body
name: canMigrateParameters
required: true
schema:
$ref: '#/definitions/CanMigrateParameters'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/CanMigrateResult'
'202':
description: >-
Accepted. The request has been accepted for processing and the
operation will complete asynchronously.
headers:
location:
type: string
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Canmigrate
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/migrate:
post:
tags:
- Profiles
description: >-
Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile.
The change need to be committed after this.
operationId: microsoftAzureProfilesMigrate
x-ms-examples:
Profiles_Migrate:
$ref: ./examples/Profiles_Migrate.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
- description: Properties needed to migrate the profile.
in: body
name: migrationParameters
required: true
schema:
$ref: '#/definitions/MigrationParameters'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/MigrateResult'
'202':
description: >-
Accepted. The request has been accepted for processing and the
operation will complete asynchronously.
headers:
location:
type: string
schema:
$ref: '#/definitions/MigrateResult'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Migrate
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationCommit
: post:
tags:
- Profiles
description: Commit the migrated Azure Frontdoor(Standard/Premium) profile.
operationId: microsoftAzureProfilesMigrationcommit
x-ms-examples:
Profiles_MigrationCommit:
$ref: ./examples/Profiles_MigrationCommit.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
'202':
description: Accepted and the operation will complete asynchronously.
headers:
location:
type: string
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Migrationcommit
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri
: post:
tags:
- Profiles
description: >-
Generates a dynamic SSO URI used to sign in to the CDN supplemental
portal. Supplemental portal is used to configure advanced feature
capabilities that are not yet available in the Azure portal, such as
core reports in a standard profile; rules engine, advanced HTTP reports,
and real-time stats and alerts in a premium profile. The SSO URI changes
approximately every 10 minutes.
operationId: microsoftAzureProfilesGeneratessouri
x-ms-examples:
Profiles_GenerateSsoUri:
$ref: ./examples/Profiles_GenerateSsoUri.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/SsoUri'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Generatessouri
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes
: post:
tags:
- Profiles
description: >-
Gets the supported optimization types for the current profile. A user
can create an endpoint with an optimization type from the listed values.
operationId: microsoftAzureProfilesListsupportedoptimizationtypes
x-ms-examples:
Profiles_ListSupportedOptimizationTypes:
$ref: ./examples/Profiles_ListSupportedOptimizationTypes.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: >-
Name of the Azure Front Door Standard or Azure Front Door Premium or
CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/SupportedOptimizationTypesListResult'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Getsupportedoptimizationtypes
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage
: post:
tags:
- Profiles
description: >-
Checks the quota and actual usage of endpoints under the given Azure
Front Door Standard or Azure Front Door Premium or CDN profile.
operationId: microsoftAzureProfilesListresourceusage
x-ms-examples:
Profiles_ListResourceUsage:
$ref: ./examples/Profiles_ListResourceUsage.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: >-
Name of the Azure Front Door Standard or Azure Front Door Premium or
CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/ResourceUsageListResult'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Checkresourceusage
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
: get:
tags:
- Endpoints
description: Lists existing CDN endpoints.
operationId: microsoftAzureEndpointsListbyprofile
x-ms-examples:
Endpoints_ListByProfile:
$ref: ./examples/Endpoints_ListByProfile.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/EndpointListResult'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
: get:
tags:
- Endpoints
description: >-
Gets an existing CDN endpoint with the specified endpoint name under the
specified subscription, resource group and profile.
operationId: microsoftAzureEndpointsGet
x-ms-examples:
Endpoints_Get:
$ref: ./examples/Endpoints_Get.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Endpoint'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
put:
tags:
- Endpoints
description: >-
Creates a new CDN endpoint with the specified endpoint name under the
specified subscription, resource group and profile.
operationId: microsoftAzureEndpointsCreate
x-ms-examples:
Endpoints_Create:
$ref: ./examples/Endpoints_Create.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- name: endpoint
in: body
description: Endpoint properties
required: true
schema:
$ref: '#/definitions/Endpoint'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Endpoint'
'201':
description: >-
Created. The request has been fulfilled and a new endpoint has been
created.
schema:
$ref: '#/definitions/Endpoint'
'202':
description: Accepted and the operation will complete asynchronously.
headers:
location:
type: string
schema:
$ref: '#/definitions/Endpoint'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
patch:
tags:
- Endpoints
description: >-
Updates an existing CDN endpoint with the specified endpoint name under
the specified subscription, resource group and profile. Only tags can be
updated after creating an endpoint. To update origins, use the Update
Origin operation. To update origin groups, use the Update Origin group
operation. To update custom domains, use the Update Custom Domain
operation.
operationId: microsoftAzureEndpointsUpdate
x-ms-examples:
Endpoints_Update:
$ref: ./examples/Endpoints_Update.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- name: endpointUpdateProperties
in: body
description: Endpoint update properties
required: true
schema:
$ref: '#/definitions/EndpointUpdateParameters'
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Endpoint'
'202':
description: Accepted and the operation will complete asynchronously
headers:
location:
type: string
schema:
$ref: '#/definitions/Endpoint'
default:
description: CDN error response describing why the operation failed
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
delete:
tags:
- Endpoints
description: >-
Deletes an existing CDN endpoint with the specified endpoint name under
the specified subscription, resource group and profile.
operationId: microsoftAzureEndpointsDelete
x-ms-examples:
Endpoints_Delete:
$ref: ./examples/Endpoints_Delete.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
'202':
description: Accepted and the operation will complete asynchronously.
headers:
location:
type: string
'204':
description: >-
No Content. The request has been accepted but the endpoint was not
found.
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
: post:
tags:
- Endpoints
description: Starts an existing CDN endpoint that is on a stopped state.
operationId: microsoftAzureEndpointsStart
x-ms-examples:
Endpoints_Start:
$ref: ./examples/Endpoints_Start.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Endpoint'
'202':
description: Accepted and the operation will complete asynchronously.
headers:
location:
type: string
schema:
$ref: '#/definitions/Endpoint'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Start
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop
: post:
tags:
- Endpoints
description: Stops an existing running CDN endpoint.
operationId: microsoftAzureEndpointsStop
x-ms-examples:
Endpoints_Stop:
$ref: ./examples/Endpoints_Stop.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- $ref: '#/parameters/subscriptionIdParameter'
- $ref: '#/parameters/apiVersionParameter'
responses:
'200':
description: OK. The request has succeeded.
schema:
$ref: '#/definitions/Endpoint'
'202':
description: Accepted and the operation will complete asynchronously.
headers:
location:
type: string
schema:
$ref: '#/definitions/Endpoint'
default:
description: CDN error response describing why the operation failed.
schema:
$ref: '#/definitions/ErrorResponse'
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Cdn Profiles Profilename Endpoints Endpointname Stop
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
: post:
tags:
- Endpoints
description: Removes a content from CDN.
operationId: microsoftAzureEndpointsPurgecontent
x-ms-examples:
Endpoints_PurgeContent:
$ref: ./examples/Endpoints_PurgeContent.json
parameters:
- $ref: '#/parameters/resourceGroupNameParameter'
- name: profileName
in: path
description: Name of the CDN profile which is unique within the resource group.
required: true
type: string
- name: endpointName
in: path
description: Name of the endpoint under the profile which is unique globally.
required: true
type: string
- name: contentFilePaths
in: body
description: >-
The path to the content to be purged. Path can be a full URL, e.g.
'/pictures/city.png' which removes a single file, or a directory
with a wildcard, e.g. '/picture
# --- truncated at 32 KB (180 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/cdnmanagementclient-openapi-original.yml