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

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

Profiles_ListBySubscriptionId (new)
Description :  Lists 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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
profileProperties:
{
Description: Profile properties needed for creation. ,
Required: True ,
}
{
location:
{
Description: Profile location ,
Required: True ,
}
string ,
tags:
{
Description: Profile tags ,
Required: False ,
}
object ,
sku:
{
Description: The SKU (pricing tier) 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
profileProperties:
{
Description: Profile properties needed for update. ,
Required: True ,
}
{
tags:
{
Description: Profile tags ,
Required: True ,
}
object ,
}
,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_DeleteIfExists (new)
Description :  Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all subresources including endpoints, origins and custom domains.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 used for advanced management tasks, such as Country Filtering, Advanced HTTP Reports, and Real-time Stats and Alerts. The SSO URI changes approximately every 10 minutes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ssoUriValue:
{
Description: The URI used to login to third party web 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 ,
}
Endpoints_ListByProfile (new)
Description :  Lists existing CDN endpoints within a profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
endpointProperties:
{
Description: Endpoint properties ,
Required: True ,
}
{
location:
{
Description: Endpoint location ,
Required: True ,
}
string ,
tags:
{
Description: Endpoint tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
originHostHeader:
{
Description: The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 ,
}
,
}
,
]
,
}
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 parameters. Only tags and OriginHostHeader 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}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
endpointProperties:
{
Description: Endpoint properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
}
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_DeleteIfExists (new)
Description :  Deletes an existing CDN endpoint with the specified parameters.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 stopped CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 :  Forcibly purges CDN endpoint content.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be purged. Path can describe a file or 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 ,
]
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 :  Forcibly pre-loads CDN endpoint content.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be loaded. Path should describe a file. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be loaded. Should describe a file path. ,
Required: True ,
}
[
string ,
]
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 a custom domain mapping to ensure it maps to the correct CNAME in DNS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain to validate. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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: The 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 ,
}
Origins_ListByEndpoint (new)
Description :  Lists the existing CDN origins within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 CDN origin within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin, an arbitrary value but it needs to be unique under endpoint ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin, an arbitrary value but it needs to be unique under endpoint ,
Required: True ,
}
string ,
originProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
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 ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 CDN origin within an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin. Must be unique within endpoint. ,
Required: True ,
}
string ,
originProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
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 ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin. Must be unique within endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ 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 the existing CDN custom domains within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN CustomDomains within an endpoint. ,
Required: False ,
}
[
{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 CDN custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 CDN custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain properties required for creation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain properties to update. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NameAvailability_CheckNameAvailability (new)
Description :  Check the availability of a resource name without creating the resource. 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-04-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 ,
}
Operations_List (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-04-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:
{
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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_ListBySubscriptionId (removed)
Description :  Lists 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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN profiles within a resource group. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
profileProperties:
{
Description: Profile properties needed for creation. ,
Required: True ,
}
{
location:
{
Description: Profile location ,
Required: True ,
}
string ,
tags:
{
Description: Profile tags ,
Required: False ,
}
object ,
sku:
{
Description: The SKU (pricing tier) 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
profileProperties:
{
Description: Profile properties needed for update. ,
Required: True ,
}
{
tags:
{
Description: Profile tags ,
Required: True ,
}
object ,
}
,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
sku:
{
Description: The SKU (pricing tier) of the CDN profile. ,
Required: False ,
}
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_DeleteIfExists (removed)
Description :  Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all subresources including endpoints, origins and custom domains.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 used for advanced management tasks, such as Country Filtering, Advanced HTTP Reports, and Real-time Stats and Alerts. The SSO URI changes approximately every 10 minutes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
ssoUriValue:
{
Description: The URI used to login to third party web 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 ,
}
Endpoints_ListByProfile (removed)
Description :  Lists existing CDN endpoints within a profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints
{
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
endpointProperties:
{
Description: Endpoint properties ,
Required: True ,
}
{
location:
{
Description: Endpoint location ,
Required: True ,
}
string ,
tags:
{
Description: Endpoint tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
originHostHeader:
{
Description: The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: True ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 ,
}
,
}
,
]
,
}
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 parameters. Only tags and OriginHostHeader 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}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
endpointProperties:
{
Description: Endpoint properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
}
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Endpoints_DeleteIfExists (removed)
Description :  Deletes an existing CDN endpoint with the specified parameters.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 stopped CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint {endpointName}.{DNSZone} ,
Required: False ,
}
string ,
originHostHeader:
{
Description: The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin. ,
Required: False ,
}
string ,
originPath:
{
Description: The path used for origin requests. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression will be applied. The value for the elements should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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 ,
origins:
{
Description: The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. ,
Required: False ,
}
[
{
name:
{
Description: Origin name ,
Required: True ,
}
string ,
properties:
{
Description: Properties of deep created origin on a CDN endpoint. ,
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 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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 :  Forcibly purges CDN endpoint content.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be purged. Path can describe a file or 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 ,
]
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 :  Forcibly pre-loads CDN endpoint content.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be loaded. Path should describe a file. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be loaded. Should describe a file path. ,
Required: True ,
}
[
string ,
]
,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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 a custom domain mapping to ensure it maps to the correct CNAME in DNS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain to validate. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-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: The 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 ,
}
Origins_ListByEndpoint (removed)
Description :  Lists the existing CDN origins within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 CDN origin within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin, an arbitrary value but it needs to be unique under endpoint ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin, an arbitrary value but it needs to be unique under endpoint ,
Required: True ,
}
string ,
originProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
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 ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 CDN origin within an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin. Must be unique within endpoint. ,
Required: True ,
}
string ,
originProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
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 ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
originName:
{
Description: Name of the origin. Must be unique within endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
properties:
{
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. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ 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 the existing CDN custom domains within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains
{
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN CustomDomains within an endpoint. ,
Required: False ,
}
[
{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 CDN custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 CDN custom domain within an endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain properties required for creation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainProperties:
{
Description: Custom domain properties to update. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
}
,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}
{
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint within the CDN profile. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile within the resource group. ,
Required: True ,
}
string ,
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-04-02 ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
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 ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
NameAvailability_CheckNameAvailability (removed)
Description :  Check the availability of a resource name without creating the resource. 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-04-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 ,
}
Operations_List (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-04-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:
{
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 ,
}
,
}
,
]
,
}

⚐ Response (default)

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