Microsoft.Cdn (stable:2020-09-01)

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

AFDProfiles_ListResourceUsage (new)
Description :  Checks the quota and actual usage of endpoints under the given CDN profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
checkHostNameAvailabilityInput:
{
Description: Custom domain to be validated. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_ListByProfile (new)
Description :  Lists existing AzureFrontDoor domains.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor domains within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Get (new)
Description :  Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Create (new)
Description :  Creates a new domain within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the domain under the profile which is unique globally ,
Required: True ,
}
string ,
customDomain:
{
Description: Domain properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Update (new)
Description :  Updates an existing domain within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the domain under the profile which is unique globally ,
Required: True ,
}
string ,
customDomainUpdateProperties:
{
Description: Domain properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
tlsSettings:
{
Description: The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. ,
Required: False ,
}
{
certificateType:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
secret:
{
Description: Resource reference to the secret. ie. subs/rg/profile/secret ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
azureDnsZone:
{
Description: Resource reference to the Azure DNS zone ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Delete (new)
Description :  Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_RefreshValidationToken (new)
Description :  Updates the domain validation token.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
token:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDEndpoints_ListByProfile (new)
Description :  Lists existing AzureFrontDoor endpoints.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of endpoint objects if there is any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpoint:
{
Description: Endpoint properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpointUpdateProperties:
{
Description: Endpoint update properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags. ,
Required: False ,
}
object ,
properties:
{
Description: The JSON object containing endpoint update parameters. ,
Required: False ,
}
{
originResponseTimeoutSeconds:
{
Description: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. ,
Format: int32 ,
Required: False ,
}
integer ,
enabledState:
{
Description: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDEndpoints_PurgeContent (new)
Description :  Removes a content from AzureFrontDoor.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contents:
{
Description: The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
domains:
{
Description: List of domains. ,
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_ListByProfile (new)
Description :  Lists all of the existing origin groups within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN origin groups within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Get (new)
Description :  Gets an existing origin group within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Create (new)
Description :  Creates a new origin group within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originGroup:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Update (new)
Description :  Updates an existing origin group within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originGroupUpdateProperties:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
loadBalancingSettings:
{
Description: Load balancing settings for a backend pool ,
Required: False ,
}
{
sampleSize:
{
Description: The number of samples to consider for load balancing decisions ,
Format: int32 ,
Required: False ,
}
integer ,
successfulSamplesRequired:
{
Description: The number of samples within the sample period that must succeed ,
Format: int32 ,
Required: False ,
}
integer ,
additionalLatencyInMilliseconds:
{
Description: The additional latency in milliseconds for probes to fall into the lowest latency bucket ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Format: int32 ,
Required: False ,
}
integer ,
responseBasedAfdOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sessionAffinityState:
{
Description: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Delete (new)
Description :  Deletes an existing origin group within a profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOrigins_ListByOriginGroup (new)
Description :  Lists all of the existing origins within an origin group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOrigins_Create (new)
Description :  Creates a new origin within the specified origin group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin that is unique within the profile. ,
Required: True ,
}
string ,
origin:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOrigins_Delete (new)
Description :  Deletes an existing origin within an origin group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Routes_ListByEndpoint (new)
Description :  Lists all of the existing origins within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor routes within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of route objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
Required: True ,
}
string ,
route:
{
Description: Route properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Routes_Update (new)
Description :  Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
Required: True ,
}
string ,
routeUpdateProperties:
{
Description: Route update properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
customDomains:
{
Description: Domains referenced by this endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
originGroup:
{
Description: A reference to the origin group. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
originPath:
{
Description: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. ,
Required: False ,
}
string ,
ruleSets:
{
Description: rule sets referenced by this endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
supportedProtocols:
{
Description: List of supported protocols for this route. ,
Required: False ,
}
[
string ,
]
,
patternsToMatch:
{
Description: The route patterns of the rule. ,
Required: False ,
}
[
string ,
]
,
compressionSettings:
{
Description: compression settings. ,
Required: False ,
}
{
contentTypesToCompress:
{
Description: List of content types on which compression applies. The value should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. ,
Required: False ,
}
boolean ,
}
,
queryStringCachingBehavior:
{
Description: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. ,
Enum:
{
IgnoreQueryString: No description available. ,
UseQueryString: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
forwardingProtocol:
{
Description: Protocol this rule will use when forwarding traffic to backends. ,
Enum:
{
HttpOnly: No description available. ,
HttpsOnly: No description available. ,
MatchRequest: No description available. ,
}
,
Required: False ,
}
enum ,
linkToDefaultDomain:
{
Description: whether this route will be linked to the default endpoint domain. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
httpsRedirect:
{
Description: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_ListByProfile (new)
Description :  Lists existing AzureFrontDoor rule sets within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor rule sets within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rule set objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_Get (new)
Description :  Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_Create (new)
Description :  Creates a new rule set within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile which is unique globally ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_Delete (new)
Description :  Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_ListByRuleSet (new)
Description :  Lists all of the existing delivery rules within a rule set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor rules within a rule set. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rule objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Get (new)
Description :  Gets an existing delivery rule within a rule set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Create (new)
Description :  Creates a new delivery rule within the specified rule set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
rule:
{
Description: The delivery rule properties. ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Update (new)
Description :  Updates an existing delivery rule within a rule set.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
ruleUpdateProperties:
{
Description: Delivery rule properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
order:
{
Description: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. ,
Format: int32 ,
Required: False ,
}
integer ,
conditions:
{
Description: A list of conditions that must be matched for the actions to be executed ,
Required: False ,
}
[
{
name:
{
Description: The name of the condition for the delivery rule. ,
Enum:
{
RemoteAddress: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
RequestScheme: No description available. ,
UrlPath: No description available. ,
UrlFileExtension: No description available. ,
UrlFileName: No description available. ,
HttpVersion: No description available. ,
Cookies: No description available. ,
IsDevice: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
actions:
{
Description: A list of actions that are executed when all the conditions of a rule are satisfied. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action for the delivery rule. ,
Enum:
{
CacheExpiration: No description available. ,
CacheKeyQueryString: No description available. ,
ModifyRequestHeader: No description available. ,
ModifyResponseHeader: No description available. ,
UrlRedirect: No description available. ,
UrlRewrite: No description available. ,
UrlSigning: No description available. ,
OriginGroupOverride: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchProcessingBehavior:
{
Description: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. ,
Enum:
{
Continue: No description available. ,
Stop: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Delete (new)
Description :  Deletes an existing delivery rule within a rule set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_ListByProfile (new)
Description :  Lists security policies associated with the profile
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Security policies within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of security policy objects if there is any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Get (new)
Description :  Gets an existing security policy within a profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Create (new)
Description :  Creates a new security policy within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
Required: True ,
}
string ,
securityPolicy:
{
Description: The security policy properties. ,
Required: True ,
}
{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Patch (new)
Description :  Updates an existing Secret within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
Required: True ,
}
string ,
securityPolicyProperties:
{
Description: Security policy update properties ,
Required: True ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Delete (new)
Description :  Deletes an existing security policy within profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the Secret under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_ListByProfile (new)
Description :  Lists existing AzureFrontDoor secrets.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor secrets within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Secret objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Get (new)
Description :  Gets an existing Secret within a profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Create (new)
Description :  Creates a new Secret within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
Required: True ,
}
string ,
secret:
{
Description: The Secret properties. ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Update (new)
Description :  Updates an existing Secret within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
Required: True ,
}
string ,
secretProperties:
{
Description: Secret properties ,
Required: True ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Delete (new)
Description :  Deletes an existing Secret within profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Validate_Secret (new)
Description :  Validate a Secret in the profile.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateSecret
{
validateSecretInput:
{
Description: The Secret source. ,
Required: True ,
}
{
secretSource:
{
Description: The secret source. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The secret type. ,
Enum:
{
UrlSigningKey: No description available. ,
ManagedCertificate: No description available. ,
CustomerCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The validation status. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
AccessDenied: No description available. ,
CertificateExpired: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed error message ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsMetrics (new)
Description :  Get log report for AFD profile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
metrics:
{
Required: True ,
}
array ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
granularity:
{
Required: True ,
}
string ,
groupBy:
{
Required: False ,
}
array ,
continents:
{
Required: False ,
}
array ,
countryOrRegions:
{
Required: False ,
}
array ,
customDomains:
{
Required: True ,
}
array ,
protocols:
{
Required: True ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
granularity:
{
Enum:
{
PT5M: No description available. ,
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
series:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
unit:
{
Enum:
{
count: No description available. ,
bytes: No description available. ,
bitsPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
data:
{
Required: False ,
}
[
{
dateTime:
{
Format: date-time ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsRankings (new)
Description :  Get log analytics ranking report for AFD profile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
rankings:
{
Required: True ,
}
array ,
metrics:
{
Required: True ,
}
array ,
maxRanking:
{
Format: int32 ,
Required: True ,
}
integer ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
customDomains:
{
Required: False ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
tables:
{
Required: False ,
}
[
{
ranking:
{
Required: False ,
}
string ,
data:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
metrics:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
value:
{
Format: int64 ,
Required: False ,
}
integer ,
percentage:
{
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsLocations (new)
Description :  Get all available location names for AFD log analytics report.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
continents:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
countryOrRegions:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
continentId:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsResources (new)
Description :  Get all endpoints and custom domains available for AFD log report
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
endpoints:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
history:
{
Required: False ,
}
boolean ,
customDomains:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
endpointId:
{
Required: False ,
}
string ,
history:
{
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
customDomains:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
endpointId:
{
Required: False ,
}
string ,
history:
{
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetWafLogAnalyticsMetrics (new)
Description :  Get Waf related log analytics report for AFD profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
metrics:
{
Required: True ,
}
array ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
granularity:
{
Required: True ,
}
string ,
actions:
{
Required: False ,
}
array ,
groupBy:
{
Required: False ,
}
array ,
ruleTypes:
{
Required: False ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
granularity:
{
Enum:
{
PT5M: No description available. ,
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
series:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
unit:
{
Enum:
{
count: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
data:
{
Required: False ,
}
[
{
dateTime:
{
Format: date-time ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetWafLogAnalyticsRankings (new)
Description :  Get WAF log analytics charts for AFD profile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
metrics:
{
Required: True ,
}
array ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
maxRanking:
{
Format: int32 ,
Required: True ,
}
integer ,
rankings:
{
Required: True ,
}
array ,
actions:
{
Required: False ,
}
array ,
ruleTypes:
{
Required: False ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
groups:
{
Required: False ,
}
[
string ,
]
,
data:
{
Required: False ,
}
[
{
groupValues:
{
Required: False ,
}
[
string ,
]
,
metrics:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
value:
{
Format: int64 ,
Required: False ,
}
integer ,
percentage:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_GenerateSsoUri (new)
Description :  Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of endpoint objects if there is any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpoint:
{
Description: Endpoint properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpointUpdateProperties:
{
Description: Endpoint update properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags. ,
Required: False ,
}
object ,
properties:
{
Description: The JSON object containing endpoint update parameters. ,
Required: False ,
}
{
originPath:
{
Description: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression applies. The value should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
originHostHeader:
{
Description: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. ,
Required: False ,
}
boolean ,
isHttpAllowed:
{
Description: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
isHttpsAllowed:
{
Description: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
queryStringCachingBehavior:
{
Description: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. ,
Enum:
{
IgnoreQueryString: No description available. ,
BypassCaching: No description available. ,
UseQueryString: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
optimizationType:
{
Description: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. ,
Enum:
{
GeneralWebDelivery: No description available. ,
GeneralMediaStreaming: No description available. ,
VideoOnDemandMediaStreaming: No description available. ,
LargeFileDownload: No description available. ,
DynamicSiteAcceleration: No description available. ,
}
,
Required: False ,
}
enum ,
probePath:
{
Description: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. ,
Required: False ,
}
string ,
geoFilters:
{
Description: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ ,
Required: False ,
}
[
{
relativePath:
{
Description: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) ,
Required: True ,
}
string ,
action:
{
Description: Action of the geo filter, i.e. allow or block access. ,
Enum:
{
Block: No description available. ,
Allow: No description available. ,
}
,
Required: True ,
}
enum ,
countryCodes:
{
Description: Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
defaultOriginGroup:
{
Description: A reference to the origin group. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
urlSigningKeys:
{
Description: List of keys used to validate the signed URL hashes. ,
Required: False ,
}
[
{
keyId:
{
Description: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. ,
Required: True ,
}
string ,
keySourceParameters:
{
Description: Defines the parameters for using customer key vault for Url Signing Key. ,
Required: True ,
}
{
@odata.type:
{
Enum:
{
#Microsoft.Azure.Cdn.Models.KeyVaultSigningKeyParameters: No description available. ,
}
,
Required: True ,
}
enum ,
subscriptionId:
{
Description: Subscription Id of the user's Key Vault containing the secret ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group of the user's Key Vault containing the secret ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the user's Key Vault containing the secret ,
Required: True ,
}
string ,
secretName:
{
Description: The name of secret in Key Vault. ,
Required: True ,
}
string ,
secretVersion:
{
Description: The version(GUID) of secret in Key Vault. ,
Required: True ,
}
string ,
}
,
}
,
]
,
deliveryPolicy:
{
Description: A policy that specifies the delivery rules to be used for an endpoint. ,
Required: False ,
}
{
description:
{
Description: User-friendly description of the policy. ,
Required: False ,
}
string ,
rules:
{
Description: A list of the delivery rules. ,
Required: True ,
}
[
{
name:
{
Description: Name of the rule ,
Required: False ,
}
string ,
order:
{
Description: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. ,
Required: True ,
}
integer ,
conditions:
{
Description: A list of conditions that must be matched for the actions to be executed ,
Required: False ,
}
[
{
name:
{
Description: The name of the condition for the delivery rule. ,
Enum:
{
RemoteAddress: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
RequestScheme: No description available. ,
UrlPath: No description available. ,
UrlFileExtension: No description available. ,
UrlFileName: No description available. ,
HttpVersion: No description available. ,
Cookies: No description available. ,
IsDevice: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
actions:
{
Description: A list of actions that are executed when all the conditions of a rule are satisfied. ,
Required: True ,
}
[
{
name:
{
Description: The name of the action for the delivery rule. ,
Enum:
{
CacheExpiration: No description available. ,
CacheKeyQueryString: No description available. ,
ModifyRequestHeader: No description available. ,
ModifyResponseHeader: No description available. ,
UrlRedirect: No description available. ,
UrlRewrite: No description available. ,
UrlSigning: No description available. ,
OriginGroupOverride: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
webApplicationFirewallPolicyLink:
{
Description: Defines the Web Application Firewall policy for the endpoint (if applicable) ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: 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 origin within the specified endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin that is unique within the endpoint. ,
Required: True ,
}
string ,
origin:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: 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 origin within an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: 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_Delete (new)
Description :  Deletes an existing origin within an endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
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 ,
}
OriginGroups_ListByEndpoint (new)
Description :  Lists all of the existing origin groups within an endpoint.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN origin groups within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originGroup:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originGroupUpdateProperties:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
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 ,
}
CustomDomains_ListByEndpoint (new)
Description :  Lists all of the existing custom domains within an endpoint.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN CustomDomains within an endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainHttpsParameters:
{
Description: The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default. ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Cdn/checkNameAvailability
{
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. ,
Enum:
{
Microsoft.Cdn/Profiles/Endpoints: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
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 ,
}
CheckNameAvailabilityWithSubscription (new)
Description :  Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/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 ,
}
,
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 2020-09-01. ,
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 ,
}
ValidateProbe (new)
Description :  Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe
{
validateProbeInput:
{
Description: Input to check. ,
Required: True ,
}
{
probeURL:
{
Description: The probe URL to validate. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isValid:
{
Description: Indicates whether the probe URL is accepted or not. ,
Required: False ,
}
boolean ,
errorCode:
{
Description: Specifies the error code when the probe url is not accepted. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the probe URL is not accepted. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EdgeNodes_List (new)
Description :  Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies
{
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure CDN WebApplicationFirewallPolicies within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of WebApplicationFirewallPolicy objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_Get (new)
Description :  Retrieve protection policy with specified name within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: 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 ,
}
Policies_CreateOrUpdate (new)
Description :  Create or update policy with specified rule set name within a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
cdnWebApplicationFirewallPolicy:
{
Description: Policy to be created. ,
Required: True ,
}
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: 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 ,
}
Policies_Update (new)
Description :  Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
cdnWebApplicationFirewallPolicyPatchParameters:
{
Description: CdnWebApplicationFirewallPolicy parameters to be patched. ,
Required: True ,
}
{
tags:
{
Description: CdnWebApplicationFirewallPolicy tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: 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 ,
}
Policies_Delete (new)
Description :  Deletes Policy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ManagedRuleSets_List (new)
Description :  Lists all available managed rule sets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets
{
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of managed rule set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Describes managed rule set definition properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the managed rule set. ,
Required: False ,
}
string ,
ruleSetType:
{
Description: Type of the managed rule set. ,
Required: False ,
}
string ,
ruleSetVersion:
{
Description: Version of the managed rule set type. ,
Required: False ,
}
string ,
ruleGroups:
{
Description: Rule groups of the managed rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Name of the managed rule group. ,
Required: False ,
}
string ,
description:
{
Description: Description of the managed rule group. ,
Required: False ,
}
string ,
rules:
{
Description: List of rules within the managed rule group. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: False ,
}
string ,
description:
{
Description: Describes the functionality of the managed rule. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
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. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve next set of managed rule set definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
checkHostNameAvailabilityInput:
{
Description: Custom domain to be validated. ,
Required: True ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_ListByProfile (removed)
Description :  Lists existing AzureFrontDoor domains.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor domains within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Get (removed)
Description :  Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Create (removed)
Description :  Creates a new domain within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the domain under the profile which is unique globally ,
Required: True ,
}
string ,
customDomain:
{
Description: Domain properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Update (removed)
Description :  Updates an existing domain within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the domain under the profile which is unique globally ,
Required: True ,
}
string ,
customDomainUpdateProperties:
{
Description: Domain properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
tlsSettings:
{
Description: The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. ,
Required: False ,
}
{
certificateType:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
secret:
{
Description: Resource reference to the secret. ie. subs/rg/profile/secret ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
azureDnsZone:
{
Description: Resource reference to the Azure DNS zone ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
domainValidationState:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. ,
Enum:
{
Unknown: No description available. ,
Submitting: No description available. ,
Pending: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
validationProperties:
{
Description: Values the customer needs to validate domain ownership ,
Required: False ,
}
{
validationToken:
{
Description: Challenge used for DNS TXT record or file based validation ,
Required: False ,
}
string ,
expirationDate:
{
Description: The date time that the token expires ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_Delete (removed)
Description :  Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDCustomDomains_RefreshValidationToken (removed)
Description :  Updates the domain validation token.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
token:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDEndpoints_ListByProfile (removed)
Description :  Lists existing AzureFrontDoor endpoints.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of endpoint objects if there is any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpoint:
{
Description: Endpoint properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpointUpdateProperties:
{
Description: Endpoint update properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags. ,
Required: False ,
}
object ,
properties:
{
Description: The JSON object containing endpoint update parameters. ,
Required: False ,
}
{
originResponseTimeoutSeconds:
{
Description: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. ,
Format: int32 ,
Required: False ,
}
integer ,
enabledState:
{
Description: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDEndpoints_PurgeContent (removed)
Description :  Removes a content from AzureFrontDoor.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contents:
{
Description: The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
domains:
{
Description: List of domains. ,
Required: False ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_ListByProfile (removed)
Description :  Lists all of the existing origin groups within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN origin groups within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Get (removed)
Description :  Gets an existing origin group within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Create (removed)
Description :  Creates a new origin group within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originGroup:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Update (removed)
Description :  Updates an existing origin group within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originGroupUpdateProperties:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
loadBalancingSettings:
{
Description: Load balancing settings for a backend pool ,
Required: False ,
}
{
sampleSize:
{
Description: The number of samples to consider for load balancing decisions ,
Format: int32 ,
Required: False ,
}
integer ,
successfulSamplesRequired:
{
Description: The number of samples within the sample period that must succeed ,
Format: int32 ,
Required: False ,
}
integer ,
additionalLatencyInMilliseconds:
{
Description: The additional latency in milliseconds for probes to fall into the lowest latency bucket ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Format: int32 ,
Required: False ,
}
integer ,
responseBasedAfdOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
sessionAffinityState:
{
Description: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOriginGroups_Delete (removed)
Description :  Deletes an existing origin group within a profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOrigins_ListByOriginGroup (removed)
Description :  Lists all of the existing origins within an origin group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOrigins_Create (removed)
Description :  Creates a new origin within the specified origin group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin that is unique within the profile. ,
Required: True ,
}
string ,
origin:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
azureOrigin:
{
Description: Resource reference to the Azure origin resource. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Format: int32 ,
Required: False ,
}
integer ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Format: int32 ,
Required: False ,
}
integer ,
sharedPrivateLinkResource:
{
Description: The properties of the private link resource for private origin. ,
Required: False ,
}
{
privateLink:
{
Description: The resource id of the resource the shared private link resource is for. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
privateLinkLocation:
{
Description: The location of the shared private link resource ,
Required: False ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: False ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
enabledState:
{
Description: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
AFDOrigins_Delete (removed)
Description :  Deletes an existing origin within an origin group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the profile. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Routes_ListByEndpoint (removed)
Description :  Lists all of the existing origins within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor routes within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of route objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
Required: True ,
}
string ,
route:
{
Description: Route properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Routes_Update (removed)
Description :  Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
Required: True ,
}
string ,
routeUpdateProperties:
{
Description: Route update properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
customDomains:
{
Description: Domains referenced by this endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
originGroup:
{
Description: A reference to the origin group. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
originPath:
{
Description: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. ,
Required: False ,
}
string ,
ruleSets:
{
Description: rule sets referenced by this endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
supportedProtocols:
{
Description: List of supported protocols for this route. ,
Required: False ,
}
[
string ,
]
,
patternsToMatch:
{
Description: The route patterns of the rule. ,
Required: False ,
}
[
string ,
]
,
compressionSettings:
{
Description: compression settings. ,
Required: False ,
}
{
contentTypesToCompress:
{
Description: List of content types on which compression applies. The value should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. ,
Required: False ,
}
boolean ,
}
,
queryStringCachingBehavior:
{
Description: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. ,
Enum:
{
IgnoreQueryString: No description available. ,
UseQueryString: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
forwardingProtocol:
{
Description: Protocol this rule will use when forwarding traffic to backends. ,
Enum:
{
HttpOnly: No description available. ,
HttpsOnly: No description available. ,
MatchRequest: No description available. ,
}
,
Required: False ,
}
enum ,
linkToDefaultDomain:
{
Description: whether this route will be linked to the default endpoint domain. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
httpsRedirect:
{
Description: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
enabledState:
{
Description: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Routes to create. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
routeName:
{
Description: Name of the routing rule. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_ListByProfile (removed)
Description :  Lists existing AzureFrontDoor rule sets within a profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor rule sets within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rule set objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_Get (removed)
Description :  Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_Create (removed)
Description :  Creates a new rule set within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile which is unique globally ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
RuleSets_Delete (removed)
Description :  Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile which is unique globally. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resource usages. ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier. ,
Required: False ,
}
string ,
unit:
{
Description: An enum describing the unit of measurement. ,
Enum:
{
Count: No description available. ,
}
,
Required: True ,
}
enum ,
currentValue:
{
Description: The current value of the usage. ,
Format: int64 ,
Required: True ,
}
integer ,
limit:
{
Description: The limit of usage. ,
Format: int64 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the type of usage. ,
Required: True ,
}
{
value:
{
Description: A string describing the resource name. ,
Required: False ,
}
string ,
localizedValue:
{
Description: A localized string describing the resource name. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_ListByRuleSet (removed)
Description :  Lists all of the existing delivery rules within a rule set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor rules within a rule set. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rule objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Get (removed)
Description :  Gets an existing delivery rule within a rule set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Create (removed)
Description :  Creates a new delivery rule within the specified rule set.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
rule:
{
Description: The delivery rule properties. ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Update (removed)
Description :  Updates an existing delivery rule within a rule set.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
ruleUpdateProperties:
{
Description: Delivery rule properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the domain to create. ,
Required: False ,
}
{
order:
{
Description: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. ,
Format: int32 ,
Required: False ,
}
integer ,
conditions:
{
Description: A list of conditions that must be matched for the actions to be executed ,
Required: False ,
}
[
{
name:
{
Description: The name of the condition for the delivery rule. ,
Enum:
{
RemoteAddress: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
RequestScheme: No description available. ,
UrlPath: No description available. ,
UrlFileExtension: No description available. ,
UrlFileName: No description available. ,
HttpVersion: No description available. ,
Cookies: No description available. ,
IsDevice: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
actions:
{
Description: A list of actions that are executed when all the conditions of a rule are satisfied. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action for the delivery rule. ,
Enum:
{
CacheExpiration: No description available. ,
CacheKeyQueryString: No description available. ,
ModifyRequestHeader: No description available. ,
ModifyResponseHeader: No description available. ,
UrlRedirect: No description available. ,
UrlRewrite: No description available. ,
UrlSigning: No description available. ,
OriginGroupOverride: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
matchProcessingBehavior:
{
Description: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. ,
Enum:
{
Continue: No description available. ,
Stop: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Rules to create. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Rules_Delete (removed)
Description :  Deletes an existing delivery rule within a rule set.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
ruleSetName:
{
Description: Name of the rule set under the profile. ,
Required: True ,
}
string ,
ruleName:
{
Description: Name of the delivery rule which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_ListByProfile (removed)
Description :  Lists security policies associated with the profile
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of Security policies within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of security policy objects if there is any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Get (removed)
Description :  Gets an existing security policy within a profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Create (removed)
Description :  Creates a new security policy within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
Required: True ,
}
string ,
securityPolicy:
{
Description: The security policy properties. ,
Required: True ,
}
{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Patch (removed)
Description :  Updates an existing Secret within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
Required: True ,
}
string ,
securityPolicyProperties:
{
Description: Security policy update properties ,
Required: True ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
parameters:
{
Description: object which contains security policy parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Security policy to create. ,
Enum:
{
WebApplicationFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SecurityPolicies_Delete (removed)
Description :  Deletes an existing security policy within profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the Secret under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_ListByProfile (removed)
Description :  Lists existing AzureFrontDoor secrets.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of AzureFrontDoor secrets within a profile. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of Secret objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Get (removed)
Description :  Gets an existing Secret within a profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Create (removed)
Description :  Creates a new Secret within the specified profile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
Required: True ,
}
string ,
secret:
{
Description: The Secret properties. ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Update (removed)
Description :  Updates an existing Secret within a profile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
Required: True ,
}
string ,
secretProperties:
{
Description: Secret properties ,
Required: True ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the Secret to create. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Secrets_Delete (removed)
Description :  Deletes an existing Secret within profile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
secretName:
{
Description: Name of the Secret under the profile. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Validate_Secret (removed)
Description :  Validate a Secret in the profile.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateSecret
{
validateSecretInput:
{
Description: The Secret source. ,
Required: True ,
}
{
secretSource:
{
Description: The secret source. ,
Required: True ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
secretType:
{
Description: The secret type. ,
Enum:
{
UrlSigningKey: No description available. ,
ManagedCertificate: No description available. ,
CustomerCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: The validation status. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
AccessDenied: No description available. ,
CertificateExpired: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed error message ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsMetrics (removed)
Description :  Get log report for AFD profile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
metrics:
{
Required: True ,
}
array ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
granularity:
{
Required: True ,
}
string ,
groupBy:
{
Required: False ,
}
array ,
continents:
{
Required: False ,
}
array ,
countryOrRegions:
{
Required: False ,
}
array ,
customDomains:
{
Required: True ,
}
array ,
protocols:
{
Required: True ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
granularity:
{
Enum:
{
PT5M: No description available. ,
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
series:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
unit:
{
Enum:
{
count: No description available. ,
bytes: No description available. ,
bitsPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
data:
{
Required: False ,
}
[
{
dateTime:
{
Format: date-time ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsRankings (removed)
Description :  Get log analytics ranking report for AFD profile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
rankings:
{
Required: True ,
}
array ,
metrics:
{
Required: True ,
}
array ,
maxRanking:
{
Format: int32 ,
Required: True ,
}
integer ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
customDomains:
{
Required: False ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
tables:
{
Required: False ,
}
[
{
ranking:
{
Required: False ,
}
string ,
data:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
metrics:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
value:
{
Format: int64 ,
Required: False ,
}
integer ,
percentage:
{
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsLocations (removed)
Description :  Get all available location names for AFD log analytics report.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
continents:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
}
,
]
,
countryOrRegions:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
continentId:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetLogAnalyticsResources (removed)
Description :  Get all endpoints and custom domains available for AFD log report
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
endpoints:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
history:
{
Required: False ,
}
boolean ,
customDomains:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
endpointId:
{
Required: False ,
}
string ,
history:
{
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
customDomains:
{
Required: False ,
}
[
{
id:
{
Required: False ,
}
string ,
name:
{
Required: False ,
}
string ,
endpointId:
{
Required: False ,
}
string ,
history:
{
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetWafLogAnalyticsMetrics (removed)
Description :  Get Waf related log analytics report for AFD profile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
metrics:
{
Required: True ,
}
array ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
granularity:
{
Required: True ,
}
string ,
actions:
{
Required: False ,
}
array ,
groupBy:
{
Required: False ,
}
array ,
ruleTypes:
{
Required: False ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
granularity:
{
Enum:
{
PT5M: No description available. ,
PT1H: No description available. ,
P1D: No description available. ,
}
,
Required: False ,
}
enum ,
series:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
unit:
{
Enum:
{
count: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
value:
{
Required: False ,
}
string ,
}
,
]
,
data:
{
Required: False ,
}
[
{
dateTime:
{
Format: date-time ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
LogAnalytics_GetWafLogAnalyticsRankings (removed)
Description :  Get WAF log analytics charts for AFD profile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings
{
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
metrics:
{
Required: True ,
}
array ,
dateTimeBegin:
{
Format: date-time ,
Required: True ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: True ,
}
string ,
maxRanking:
{
Format: int32 ,
Required: True ,
}
integer ,
rankings:
{
Required: True ,
}
array ,
actions:
{
Required: False ,
}
array ,
ruleTypes:
{
Required: False ,
}
array ,
}

⚐ Response (200)

{
dateTimeBegin:
{
Format: date-time ,
Required: False ,
}
string ,
dateTimeEnd:
{
Format: date-time ,
Required: False ,
}
string ,
groups:
{
Required: False ,
}
[
string ,
]
,
data:
{
Required: False ,
}
[
{
groupValues:
{
Required: False ,
}
[
string ,
]
,
metrics:
{
Required: False ,
}
[
{
metric:
{
Required: False ,
}
string ,
value:
{
Format: int64 ,
Required: False ,
}
integer ,
percentage:
{
Format: double ,
Required: False ,
}
number ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Profiles_GenerateSsoUri (removed)
Description :  Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN endpoints within a profile ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of endpoint objects if there is any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpoint:
{
Description: Endpoint properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
endpointUpdateProperties:
{
Description: Endpoint update properties ,
Required: True ,
}
{
tags:
{
Description: Endpoint tags. ,
Required: False ,
}
object ,
properties:
{
Description: The JSON object containing endpoint update parameters. ,
Required: False ,
}
{
originPath:
{
Description: A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. ,
Required: False ,
}
string ,
contentTypesToCompress:
{
Description: List of content types on which compression applies. The value should be a valid MIME type. ,
Required: False ,
}
[
string ,
]
,
originHostHeader:
{
Description: The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
isCompressionEnabled:
{
Description: Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB. ,
Required: False ,
}
boolean ,
isHttpAllowed:
{
Description: Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
isHttpsAllowed:
{
Description: Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed. ,
Required: False ,
}
boolean ,
queryStringCachingBehavior:
{
Description: Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. ,
Enum:
{
IgnoreQueryString: No description available. ,
BypassCaching: No description available. ,
UseQueryString: No description available. ,
NotSet: No description available. ,
}
,
Required: False ,
}
enum ,
optimizationType:
{
Description: Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization. ,
Enum:
{
GeneralWebDelivery: No description available. ,
GeneralMediaStreaming: No description available. ,
VideoOnDemandMediaStreaming: No description available. ,
LargeFileDownload: No description available. ,
DynamicSiteAcceleration: No description available. ,
}
,
Required: False ,
}
enum ,
probePath:
{
Description: Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin. ,
Required: False ,
}
string ,
geoFilters:
{
Description: List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ ,
Required: False ,
}
[
{
relativePath:
{
Description: Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) ,
Required: True ,
}
string ,
action:
{
Description: Action of the geo filter, i.e. allow or block access. ,
Enum:
{
Block: No description available. ,
Allow: No description available. ,
}
,
Required: True ,
}
enum ,
countryCodes:
{
Description: Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
defaultOriginGroup:
{
Description: A reference to the origin group. ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
urlSigningKeys:
{
Description: List of keys used to validate the signed URL hashes. ,
Required: False ,
}
[
{
keyId:
{
Description: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. ,
Required: True ,
}
string ,
keySourceParameters:
{
Description: Defines the parameters for using customer key vault for Url Signing Key. ,
Required: True ,
}
{
@odata.type:
{
Enum:
{
#Microsoft.Azure.Cdn.Models.KeyVaultSigningKeyParameters: No description available. ,
}
,
Required: True ,
}
enum ,
subscriptionId:
{
Description: Subscription Id of the user's Key Vault containing the secret ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group of the user's Key Vault containing the secret ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the user's Key Vault containing the secret ,
Required: True ,
}
string ,
secretName:
{
Description: The name of secret in Key Vault. ,
Required: True ,
}
string ,
secretVersion:
{
Description: The version(GUID) of secret in Key Vault. ,
Required: True ,
}
string ,
}
,
}
,
]
,
deliveryPolicy:
{
Description: A policy that specifies the delivery rules to be used for an endpoint. ,
Required: False ,
}
{
description:
{
Description: User-friendly description of the policy. ,
Required: False ,
}
string ,
rules:
{
Description: A list of the delivery rules. ,
Required: True ,
}
[
{
name:
{
Description: Name of the rule ,
Required: False ,
}
string ,
order:
{
Description: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. ,
Required: True ,
}
integer ,
conditions:
{
Description: A list of conditions that must be matched for the actions to be executed ,
Required: False ,
}
[
{
name:
{
Description: The name of the condition for the delivery rule. ,
Enum:
{
RemoteAddress: No description available. ,
RequestMethod: No description available. ,
QueryString: No description available. ,
PostArgs: No description available. ,
RequestUri: No description available. ,
RequestHeader: No description available. ,
RequestBody: No description available. ,
RequestScheme: No description available. ,
UrlPath: No description available. ,
UrlFileExtension: No description available. ,
UrlFileName: No description available. ,
HttpVersion: No description available. ,
Cookies: No description available. ,
IsDevice: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
actions:
{
Description: A list of actions that are executed when all the conditions of a rule are satisfied. ,
Required: True ,
}
[
{
name:
{
Description: The name of the action for the delivery rule. ,
Enum:
{
CacheExpiration: No description available. ,
CacheKeyQueryString: No description available. ,
ModifyRequestHeader: No description available. ,
ModifyResponseHeader: No description available. ,
UrlRedirect: No description available. ,
UrlRewrite: No description available. ,
UrlSigning: No description available. ,
OriginGroupOverride: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
webApplicationFirewallPolicyLink:
{
Description: Defines the Web Application Firewall policy for the endpoint (if applicable) ,
Required: False ,
}
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties required to create an endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net ,
Required: False ,
}
string ,
origins:
{
Description: The source of the content being delivered via CDN. ,
Required: True ,
}
[
{
name:
{
Description: Origin name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin created on the CDN endpoint. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. ,
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 ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not. By default, origin is always enabled. ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
]
,
originGroups:
{
Description: The origin groups comprising of origins that are used for load balancing the traffic based on availability. ,
Required: False ,
}
[
{
name:
{
Description: Origin group name which must be unique within the endpoint. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the origin group created on the CDN endpoint. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: True ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
resourceState:
{
Description: Resource status of the endpoint. ,
Enum:
{
Creating: No description available. ,
Deleting: No description available. ,
Running: No description available. ,
Starting: No description available. ,
Stopped: No description available. ,
Stopping: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
contentFilePaths:
{
Description: The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory. ,
Required: True ,
}
{
contentPaths:
{
Description: The path to the content to be purged. Can describe a file path or a wild card directory. ,
Required: True ,
}
[
string ,
]
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN origins within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: 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 origin within the specified endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin that is unique within the endpoint. ,
Required: True ,
}
string ,
origin:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: 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 origin within an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
originUpdateProperties:
{
Description: Origin properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
hostName:
{
Description: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. ,
Required: False ,
}
string ,
httpPort:
{
Description: The value of the HTTP port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
httpsPort:
{
Description: The value of the HTTPS port. Must be between 1 and 65535. ,
Required: False ,
}
integer ,
originHostHeader:
{
Description: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint ,
Required: False ,
}
string ,
priority:
{
Description: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 ,
Required: False ,
}
integer ,
weight:
{
Description: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 ,
Required: False ,
}
integer ,
enabled:
{
Description: Origin is enabled for load balancing or not ,
Required: False ,
}
boolean ,
privateLinkAlias:
{
Description: The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' ,
Required: False ,
}
string ,
privateLinkResourceId:
{
Description: The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' ,
Required: False ,
}
string ,
privateLinkLocation:
{
Description: The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated ,
Required: False ,
}
string ,
privateLinkApprovalMessage:
{
Description: A custom message to be included in the approval request to connect to the Private Link. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin. ,
Required: False ,
}
string ,
privateEndpointStatus:
{
Description: The approval status for the connection to the Private Link ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
Timeout: 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_Delete (removed)
Description :  Deletes an existing origin within an endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originName:
{
Description: Name of the origin which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
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 ,
}
OriginGroups_ListByEndpoint (removed)
Description :  Lists all of the existing origin groups within an endpoint.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN origin groups within an endpoint ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of origin objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originGroup:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
originGroupUpdateProperties:
{
Description: Origin group properties ,
Required: True ,
}
{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
healthProbeSettings:
{
Description: Health probe settings to the origin that is used to determine the health of the origin. ,
Required: False ,
}
{
probePath:
{
Description: The path relative to the origin that is used to determine the health of the origin. ,
Required: False ,
}
string ,
probeRequestType:
{
Description: The type of health probe request that is made. ,
Enum:
{
NotSet: No description available. ,
GET: No description available. ,
HEAD: No description available. ,
}
,
Required: False ,
}
enum ,
probeProtocol:
{
Description: Protocol to use for health probe. ,
Enum:
{
NotSet: No description available. ,
Http: No description available. ,
Https: No description available. ,
}
,
Required: False ,
}
enum ,
probeIntervalInSeconds:
{
Description: The number of seconds between health probes.Default is 240sec. ,
Required: False ,
}
integer ,
}
,
origins:
{
Description: The source of the content being delivered via CDN within given origin group. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
}
,
]
,
trafficRestorationTimeToHealedOrNewEndpointsInMinutes:
{
Description: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. ,
Required: False ,
}
integer ,
responseBasedOriginErrorDetectionSettings:
{
Description: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported. ,
Required: False ,
}
{
responseBasedDetectedErrorTypes:
{
Description: Type of response errors for real user requests for which origin will be deemed unhealthy ,
Enum:
{
None: No description available. ,
TcpErrorsOnly: No description available. ,
TcpAndHttpErrors: No description available. ,
}
,
Required: False ,
}
enum ,
responseBasedFailoverThresholdPercentage:
{
Description: The percentage of failed requests in the sample where failover should trigger. ,
Required: False ,
}
integer ,
httpErrorRanges:
{
Description: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. ,
Required: False ,
}
[
{
begin:
{
Description: The inclusive start of the http status code range. ,
Required: False ,
}
integer ,
end:
{
Description: The inclusive end of the http status code range. ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the origin group. ,
Required: False ,
}
{
resourceState:
{
Description: Resource status of the origin group. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning status of the origin group. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
originGroupName:
{
Description: Name of the origin group which is unique within the endpoint. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
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 ,
}
CustomDomains_ListByEndpoint (removed)
Description :  Lists all of the existing custom domains within an endpoint.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of CDN CustomDomains within an endpoint. ,
Required: False ,
}
[
{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of custom domain objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
profileName:
{
Description: Name of the CDN profile which is unique within the resource group. ,
Required: True ,
}
string ,
endpointName:
{
Description: Name of the endpoint under the profile which is unique globally. ,
Required: True ,
}
string ,
customDomainName:
{
Description: Name of the custom domain within an endpoint. ,
Required: True ,
}
string ,
customDomainHttpsParameters:
{
Description: The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default. ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
properties:
{
Description: The JSON object that contains the properties of the custom domain to create. ,
Required: False ,
}
{
hostName:
{
Description: The host name of the custom domain. Must be a domain name. ,
Required: True ,
}
string ,
resourceState:
{
Description: Resource status of the custom domain. ,
Enum:
{
Creating: No description available. ,
Active: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningState:
{
Description: Provisioning status of Custom Https of the custom domain. ,
Enum:
{
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsProvisioningSubstate:
{
Description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. ,
Enum:
{
SubmittingDomainControlValidationRequest: No description available. ,
PendingDomainControlValidationREquestApproval: No description available. ,
DomainControlValidationRequestApproved: No description available. ,
DomainControlValidationRequestRejected: No description available. ,
DomainControlValidationRequestTimedOut: No description available. ,
IssuingCertificate: No description available. ,
DeployingCertificate: No description available. ,
CertificateDeployed: No description available. ,
DeletingCertificate: No description available. ,
CertificateDeleted: No description available. ,
}
,
Required: False ,
}
enum ,
customHttpsParameters:
{
Description: Certificate parameters for securing custom HTTPS ,
Required: False ,
}
{
certificateSource:
{
Description: Defines the source of the SSL certificate. ,
Enum:
{
AzureKeyVault: No description available. ,
Cdn: No description available. ,
}
,
Required: True ,
}
enum ,
protocolType:
{
Description: Defines the TLS extension protocol that is used for secure delivery. ,
Enum:
{
ServerNameIndication: No description available. ,
IPBased: No description available. ,
}
,
Required: True ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https ,
Enum:
{
None: No description available. ,
TLS10: No description available. ,
TLS12: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationData:
{
Description: Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning status of the custom domain. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

POST:  /providers/Microsoft.Cdn/checkNameAvailability
{
checkNameAvailabilityInput:
{
Description: Input to check. ,
Required: True ,
}
{
name:
{
Description: The resource name to validate. ,
Required: True ,
}
string ,
type:
{
Description: The type of the resource whose name is to be validated. ,
Enum:
{
Microsoft.Cdn/Profiles/Endpoints: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2020-09-01. ,
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 ,
}
CheckNameAvailabilityWithSubscription (removed)
Description :  Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/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 ,
}
,
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 2020-09-01. ,
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 ,
}
ValidateProbe (removed)
Description :  Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe
{
validateProbeInput:
{
Description: Input to check. ,
Required: True ,
}
{
probeURL:
{
Description: The probe URL to validate. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isValid:
{
Description: Indicates whether the probe URL is accepted or not. ,
Required: False ,
}
boolean ,
errorCode:
{
Description: Specifies the error code when the probe url is not accepted. ,
Required: False ,
}
string ,
message:
{
Description: The detailed error message describing why the probe URL is not accepted. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
EdgeNodes_List (removed)
Description :  Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies
{
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure CDN WebApplicationFirewallPolicies within a resource group. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of WebApplicationFirewallPolicy objects if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Policies_Get (removed)
Description :  Retrieve protection policy with specified name within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: 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 ,
}
Policies_CreateOrUpdate (removed)
Description :  Create or update policy with specified rule set name within a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
cdnWebApplicationFirewallPolicy:
{
Description: Policy to be created. ,
Required: True ,
}
{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: 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 ,
}
Policies_Update (removed)
Description :  Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
cdnWebApplicationFirewallPolicyPatchParameters:
{
Description: CdnWebApplicationFirewallPolicy parameters to be patched. ,
Required: True ,
}
{
tags:
{
Description: CdnWebApplicationFirewallPolicy tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the web application firewall policy. ,
Required: False ,
}
{
policySettings:
{
Description: Describes policySettings for policy ,
Required: False ,
}
{
enabledState:
{
Description: describes if the policy is in enabled state or disabled state ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: Describes if it is in detection mode or prevention mode at policy level. ,
Enum:
{
Prevention: No description available. ,
Detection: No description available. ,
}
,
Required: False ,
}
enum ,
defaultRedirectUrl:
{
Description: If action type is redirect, this field represents the default redirect URL for the client. ,
Required: False ,
}
string ,
defaultCustomBlockResponseStatusCode:
{
Description: If the action type is block, this field defines the default customer overridable http response status code. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultCustomBlockResponseBody:
{
Description: If the action type is block, customer can override the response body. The body must be specified in base64 encoding. ,
Required: False ,
}
string ,
}
,
rateLimitRules:
{
Description: Describes rate limit rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
rateLimitThreshold:
{
Description: Defines rate limit threshold. ,
Format: int32 ,
Required: True ,
}
integer ,
rateLimitDurationInMinutes:
{
Description: Defines rate limit duration. Default is 1 minute. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
customRules:
{
Description: Describes custom rules inside the policy. ,
Required: False ,
}
{
rules:
{
Description: List of rules ,
Required: False ,
}
[
{
name:
{
Description: Defines the name of the custom rule ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Defines in what order this rule be evaluated in the overall list of custom rules ,
Format: int32 ,
Required: True ,
}
integer ,
matchConditions:
{
Description: List of match conditions. ,
Required: True ,
}
[
{
matchVariable:
{
Description: Match variable to compare against. ,
Enum:
{
RemoteAddr: No description available. ,
SocketAddr: No description available. ,
RequestMethod: No description available. ,
RequestHeader: No description available. ,
RequestUri: No description available. ,
QueryString: No description available. ,
RequestBody: No description available. ,
Cookies: No description available. ,
PostArgs: No description available. ,
}
,
Required: True ,
}
enum ,
selector:
{
Description: Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. ,
Required: False ,
}
string ,
operator:
{
Description: Describes operator to be matched ,
Enum:
{
Any: No description available. ,
IPMatch: No description available. ,
GeoMatch: No description available. ,
Equal: No description available. ,
Contains: No description available. ,
LessThan: No description available. ,
GreaterThan: No description available. ,
LessThanOrEqual: No description available. ,
GreaterThanOrEqual: No description available. ,
BeginsWith: No description available. ,
EndsWith: No description available. ,
RegEx: No description available. ,
}
,
Required: True ,
}
enum ,
negateCondition:
{
Description: Describes if the result of this condition should be negated. ,
Required: False ,
}
boolean ,
matchValue:
{
Description: List of possible match values. ,
Required: True ,
}
[
string ,
]
,
transforms:
{
Description: List of transforms. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
action:
{
Description: Describes what action to be applied when rule matches ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
managedRules:
{
Description: Describes managed rules inside the policy. ,
Required: False ,
}
{
managedRuleSets:
{
Description: List of rule sets. ,
Required: False ,
}
[
{
ruleSetType:
{
Description: Defines the rule set type to use. ,
Required: True ,
}
string ,
ruleSetVersion:
{
Description: Defines the version of the rule set to use. ,
Required: True ,
}
string ,
anomalyScore:
{
Description: Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. ,
Required: False ,
}
integer ,
ruleGroupOverrides:
{
Description: Defines the rule overrides to apply to the rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Describes the managed rule group within the rule set to override ,
Required: True ,
}
string ,
rules:
{
Description: List of rules that will be disabled. If none specified, all rules in the group will be disabled. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: True ,
}
string ,
enabledState:
{
Description: Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
action:
{
Description: Describes the override action to be applied when rule matches. ,
Enum:
{
Allow: No description available. ,
Block: No description available. ,
Log: No description available. ,
Redirect: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
endpointLinks:
{
Description: Describes Azure CDN endpoints associated with this Web Application Firewall policy. ,
Required: False ,
}
[
{
id:
{
Description: ARM Resource ID string. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the WebApplicationFirewallPolicy. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceState:
{
Enum:
{
Creating: No description available. ,
Enabling: No description available. ,
Enabled: No description available. ,
Disabling: No description available. ,
Disabled: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Gets a unique read-only string that changes whenever the resource is updated. ,
Required: False ,
}
string ,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
Required: True ,
}
{
name:
{
Description: Name of the pricing tier. ,
Enum:
{
Standard_Verizon: No description available. ,
Premium_Verizon: No description available. ,
Custom_Verizon: No description available. ,
Standard_Akamai: No description available. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: 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 ,
}
Policies_Delete (removed)
Description :  Deletes Policy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{policyName}
{
resourceGroupName:
{
Description: Name of the Resource group within the Azure subscription. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the CdnWebApplicationFirewallPolicy. ,
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ManagedRuleSets_List (removed)
Description :  Lists all available managed rule sets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets
{
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 2020-09-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of managed rule set definitions. ,
Required: False ,
}
[
{
properties:
{
Description: Describes managed rule set definition properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the managed rule set. ,
Required: False ,
}
string ,
ruleSetType:
{
Description: Type of the managed rule set. ,
Required: False ,
}
string ,
ruleSetVersion:
{
Description: Version of the managed rule set type. ,
Required: False ,
}
string ,
ruleGroups:
{
Description: Rule groups of the managed rule set. ,
Required: False ,
}
[
{
ruleGroupName:
{
Description: Name of the managed rule group. ,
Required: False ,
}
string ,
description:
{
Description: Description of the managed rule group. ,
Required: False ,
}
string ,
rules:
{
Description: List of rules within the managed rule group. ,
Required: False ,
}
[
{
ruleId:
{
Description: Identifier for the managed rule. ,
Required: False ,
}
string ,
description:
{
Description: Describes the functionality of the managed rule. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
sku:
{
Description: The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy. ,
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. ,
Standard_ChinaCdn: No description available. ,
Standard_Microsoft: No description available. ,
Premium_ChinaCdn: No description available. ,
Standard_AzureFrontDoor: No description available. ,
Premium_AzureFrontDoor: No description available. ,
Standard_955BandWidth_ChinaCdn: No description available. ,
Standard_AvgBandWidth_ChinaCdn: No description available. ,
StandardPlus_ChinaCdn: No description available. ,
StandardPlus_955BandWidth_ChinaCdn: No description available. ,
StandardPlus_AvgBandWidth_ChinaCdn: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to retrieve next set of managed rule set definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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