Microsoft.Cdn (stable:2016-10-02)

2025/09/26 • 33 new, 33 deleted methods

Profiles_List (new)
Description :  Lists all of the CDN profiles within an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of profile objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_ListByResourceGroup (new)
Description :  Lists all of the CDN profiles within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of profile objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Get (new)
Description :  Gets a CDN profile with the specified profile name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Create (new)
Description :  Creates a new CDN profile with a profile name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
profile:
{
Description: Profile properties needed to create a new profile. ,
Required: True ,
}
{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Update (new)
Description :  Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
profileUpdateParameters:
{
Description: Profile properties needed to update an existing profile. ,
Required: True ,
}
{
tags:
{
Description: Profile tags ,
Required: True ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Delete (new)
Description :  Deletes an existing 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.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_GenerateSsoUri (new)
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ssoUriValue:
{
Description: The URI used to login to the supplemental portal. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_GetSupportedOptimizationTypes (new)
Description :  Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
supportedOptimizationTypes:
{
Description: Supported optimization types for a profile. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_ListResourceUsage (new)
Description :  Checks the quota and actual usage of endpoints under the given CDN profile.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource type of the usages. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage. e.g. Count. ,
Required: False ,
}
string ,
currentValue:
{
Description: Actual value of the resource type. ,
Required: False ,
}
integer ,
limit:
{
Description: Quota of the resource type. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_ListByProfile (new)
Description :  Lists existing CDN endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of endpoint objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Get (new)
Description :  Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Create (new)
Description :  Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpoint:
{
Description: Endpoint properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Update (new)
Description :  Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags and Origin HostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpointUpdateProperties:
{
Description: Endpoint update properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags. ,
Required: False ,
}
object ,
properties:
{
Description: Result of the request to list endpoints. It contains a list of endpoints and a URL link to get the next set of results. ,
Required: False ,
}
{
originHostHeader:
{
Description: The host header CDN sends along with content requests to origin. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used when CDN sends request to origin. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression applies. The value should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. ,
Required: False ,
}
boolean ,
isHttpAllowed:
{
Description: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
isHttpsAllowed:
{
Description: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
queryStringCachingBehavior:
{
Description: Defines the query string caching behavior ,
Enum:
{
IgnoreQueryString: No description available. ,
BypassCaching: No description available. ,
UseQueryString: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
optimizationType:
{
Description: Customer can specify what scenario they want this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. ,
Enum:
{
GeneralWebDelivery: No description available. ,
GeneralMediaStreaming: No description available. ,
VideoOnDemandMediaStreaming: No description available. ,
LargeFileDownload: No description available. ,
DynamicSiteAcceleration: No description available. ,
}
,
Required: False ,
}
enum ,
geoFilters:
{
Description: List of rules defining user geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ ,
Required: False ,
}
[
{
relativePath:
{
Description: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) ,
Required: True ,
}
string ,
action:
{
Description: Action of the geo filter, i.e. allow or block access. ,
Enum:
{
Block: No description available. ,
Allow: No description available. ,
}
,
Required: True ,
}
enum ,
countryCodes:
{
Description: Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Delete (new)
Description :  Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Start (new)
Description :  Starts an existing CDN endpoint that is on a stopped state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Stop (new)
Description :  Stops an existing running CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_PurgeContent (new)
Description :  Removes a content from CDN.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contentFilePaths:
{
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. '/pictures/*' which removes all folders and files in the directory. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_LoadContent (new)
Description :  Pre-loads a content to CDN. Available for Verizon Profiles.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be loaded. Path should be a relative file URL of the origin. ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_ValidateCustomDomain (new)
Description :  Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain to be validated. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
customDomainValidated:
{
Description: Indicates whether the custom domain is validated or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the custom domain is not valid. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing why the custom domain is not valid. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_ListResourceUsage (new)
Description :  Checks the quota and usage of geo filters and custom domains under the given endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource type of the usages. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage. e.g. Count. ,
Required: False ,
}
string ,
currentValue:
{
Description: Actual value of the resource type. ,
Required: False ,
}
integer ,
limit:
{
Description: Quota of the resource type. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Origins_ListByEndpoint (new)
Description :  Lists all of the existing origins within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Origins_Get (new)
Description :  Gets an existing origin within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Origins_Update (new)
Description :  Updates an existing origin within an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_ListByEndpoint (new)
Description :  Lists all of the existing custom domains within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN CustomDomains within an endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_Get (new)
Description :  Gets an existing custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_Create (new)
Description :  Creates a new custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Properties required to create a new custom domain. ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_Delete (new)
Description :  Deletes an existing custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_DisableCustomHttps (new)
Description :  Disable https delivery of the custom domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_EnableCustomHttps (new)
Description :  Enable https delivery of the custom domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CheckNameAvailability (new)
Description :  Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Cdn/checkNameAvailability
{
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. ,
Enum:
{
Microsoft.Cdn/Profiles/Endpoints: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ListResourceUsage (new)
Description :  Check the quota and actual usage of the CDN profiles under the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource type of the usages. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage. e.g. Count. ,
Required: False ,
}
string ,
currentValue:
{
Description: Actual value of the resource type. ,
Required: False ,
}
integer ,
limit:
{
Description: Quota of the resource type. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ListOperations (new)
Description :  Lists all of the available CDN REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cdn/operations
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN operations supported by the CDN resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Cdn ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EdgeNodes_List (new)
Description :  Lists all the edge nodes of a CDN service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cdn/edgenodes
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Edge node of CDN service. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an edgenode. ,
Required: False ,
}
{
ipAddressGroups:
{
Description: List of ip address groups. ,
Required: True ,
}
[
{
deliveryRegion:
{
Description: The delivery region of the ip address group ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: The list of ip v4 addresses. ,
Required: False ,
}
[
{
baseIpAddress:
{
Description: IP address itself. ,
Required: False ,
}
string ,
prefixLength:
{
Description: The length of the prefix of the ip address. ,
Required: False ,
}
integer ,
}
,
]
,
ipv6Addresses:
{
Description: The list of ip v6 addresses. ,
Required: False ,
}
[
{
baseIpAddress:
{
Description: IP address itself. ,
Required: False ,
}
string ,
prefixLength:
{
Description: The length of the prefix of the ip address. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of edgenode list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_List (removed)
Description :  Lists all of the CDN profiles within an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of profile objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_ListByResourceGroup (removed)
Description :  Lists all of the CDN profiles within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of profile objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Get (removed)
Description :  Gets a CDN profile with the specified profile name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Create (removed)
Description :  Creates a new CDN profile with a profile name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
profile:
{
Description: Profile properties needed to create a new profile. ,
Required: True ,
}
{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Update (removed)
Description :  Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
profileUpdateParameters:
{
Description: Profile properties needed to update an existing profile. ,
Required: True ,
}
{
tags:
{
Description: Profile tags ,
Required: True ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
Description: The JSON object that contains the properties required to create a profile. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the profile. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the profile. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_Delete (removed)
Description :  Deletes an existing 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.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_GenerateSsoUri (removed)
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.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ssoUriValue:
{
Description: The URI used to login to the supplemental portal. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_GetSupportedOptimizationTypes (removed)
Description :  Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
supportedOptimizationTypes:
{
Description: Supported optimization types for a profile. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_ListResourceUsage (removed)
Description :  Checks the quota and actual usage of endpoints under the given CDN profile.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource type of the usages. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage. e.g. Count. ,
Required: False ,
}
string ,
currentValue:
{
Description: Actual value of the resource type. ,
Required: False ,
}
integer ,
limit:
{
Description: Quota of the resource type. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_ListByProfile (removed)
Description :  Lists existing CDN endpoints.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of endpoint objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Get (removed)
Description :  Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Create (removed)
Description :  Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpoint:
{
Description: Endpoint properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Update (removed)
Description :  Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags and Origin HostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpointUpdateProperties:
{
Description: Endpoint update properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags. ,
Required: False ,
}
object ,
properties:
{
Description: Result of the request to list endpoints. It contains a list of endpoints and a URL link to get the next set of results. ,
Required: False ,
}
{
originHostHeader:
{
Description: The host header CDN sends along with content requests to origin. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used when CDN sends request to origin. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression applies. The value should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. ,
Required: False ,
}
boolean ,
isHttpAllowed:
{
Description: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
isHttpsAllowed:
{
Description: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
queryStringCachingBehavior:
{
Description: Defines the query string caching behavior ,
Enum:
{
IgnoreQueryString: No description available. ,
BypassCaching: No description available. ,
UseQueryString: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
optimizationType:
{
Description: Customer can specify what scenario they want this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. ,
Enum:
{
GeneralWebDelivery: No description available. ,
GeneralMediaStreaming: No description available. ,
VideoOnDemandMediaStreaming: No description available. ,
LargeFileDownload: No description available. ,
DynamicSiteAcceleration: No description available. ,
}
,
Required: False ,
}
enum ,
geoFilters:
{
Description: List of rules defining user geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ ,
Required: False ,
}
[
{
relativePath:
{
Description: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) ,
Required: True ,
}
string ,
action:
{
Description: Action of the geo filter, i.e. allow or block access. ,
Enum:
{
Block: No description available. ,
Allow: No description available. ,
}
,
Required: True ,
}
enum ,
countryCodes:
{
Description: Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Delete (removed)
Description :  Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Start (removed)
Description :  Starts an existing CDN endpoint that is on a stopped state.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_Stop (removed)
Description :  Stops an existing running CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of origin Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain names, IPv4 address, or IPv6 address. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_PurgeContent (removed)
Description :  Removes a content from CDN.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contentFilePaths:
{
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. '/pictures/*' which removes all folders and files in the directory. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_LoadContent (removed)
Description :  Pre-loads a content to CDN. Available for Verizon Profiles.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be loaded. Path should be a relative file URL of the origin. ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_ValidateCustomDomain (removed)
Description :  Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain to be validated. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
customDomainValidated:
{
Description: Indicates whether the custom domain is validated or not. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the custom domain is not valid. ,
Required: False ,
}
string ,
message:
{
Description: Error message describing why the custom domain is not valid. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_ListResourceUsage (removed)
Description :  Checks the quota and usage of geo filters and custom domains under the given endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource type of the usages. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage. e.g. Count. ,
Required: False ,
}
string ,
currentValue:
{
Description: Actual value of the resource type. ,
Required: False ,
}
integer ,
limit:
{
Description: Quota of the resource type. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Origins_ListByEndpoint (removed)
Description :  Lists all of the existing origins within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Origins_Get (removed)
Description :  Gets an existing origin within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Origins_Update (removed)
Description :  Updates an existing origin within an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin to create. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported. ,
Required: True ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the https port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_ListByEndpoint (removed)
Description :  Lists all of the existing custom domains within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN CustomDomains within an endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_Get (removed)
Description :  Gets an existing custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_Create (removed)
Description :  Creates a new custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Properties required to create a new custom domain. ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_Delete (removed)
Description :  Deletes an existing custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_DisableCustomHttps (removed)
Description :  Disable https delivery of the custom domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CustomDomains_EnableCustomHttps (removed)
Description :  Enable https delivery of the custom domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning state of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
CheckNameAvailability (removed)
Description :  Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Cdn/checkNameAvailability
{
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. ,
Enum:
{
Microsoft.Cdn/Profiles/Endpoints: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates whether the name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ListResourceUsage (removed)
Description :  Check the quota and actual usage of the CDN profiles under the given subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resource usages. ,
Required: False ,
}
[
{
resourceType:
{
Description: Resource type of the usages. ,
Required: False ,
}
string ,
unit:
{
Description: Unit of the usage. e.g. Count. ,
Required: False ,
}
string ,
currentValue:
{
Description: Actual value of the resource type. ,
Required: False ,
}
integer ,
limit:
{
Description: Quota of the resource type. ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ListOperations (removed)
Description :  Lists all of the available CDN REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cdn/operations
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN operations supported by the CDN resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Cdn ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EdgeNodes_List (removed)
Description :  Lists all the edge nodes of a CDN service.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Cdn/edgenodes
{
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2016-10-02. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Edge node of CDN service. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an edgenode. ,
Required: False ,
}
{
ipAddressGroups:
{
Description: List of ip address groups. ,
Required: True ,
}
[
{
deliveryRegion:
{
Description: The delivery region of the ip address group ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: The list of ip v4 addresses. ,
Required: False ,
}
[
{
baseIpAddress:
{
Description: IP address itself. ,
Required: False ,
}
string ,
prefixLength:
{
Description: The length of the prefix of the ip address. ,
Required: False ,
}
integer ,
}
,
]
,
ipv6Addresses:
{
Description: The list of ip v6 addresses. ,
Required: False ,
}
[
{
baseIpAddress:
{
Description: IP address itself. ,
Required: False ,
}
string ,
prefixLength:
{
Description: The length of the prefix of the ip address. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of edgenode list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}