Microsoft.Cdn (stable:2025-04-15)

2025/04/10 • 51 updated methods

AFDProfiles_ListResourceUsage (updated)
Description :  Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDProfiles_ListResourceUsage",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDProfiles_CheckHostNameAvailability (updated)
Description :  Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDProfiles_CheckHostNameAvailability",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. ,
Required: True ,
}
string ,
checkHostNameAvailabilityInput:
{
Description: Custom domain to be validated. ,
Required: True ,
}
{
hostName:
{
Description: The host name 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 2025-04-15. ,
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)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDCustomDomains_ListByProfile (updated)
Description :  Lists existing AzureFrontDoor domains.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDCustomDomains_ListByProfile",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDCustomDomains_Get (updated)
Description :  Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDCustomDomains_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDCustomDomains_Create (updated)
Description :  Creates a new domain within the specified profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDCustomDomains_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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 2025-04-15. ,
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com. ,
}
{
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDCustomDomains_Update (updated)
Description :  Updates an existing domain within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDCustomDomains_Update",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
profileName:
{
Description: The name of the profile which holds the domain. ,
Required: False ,
}
string ,
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. ,
AzureFirstPartyManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
cipherSuiteSetType:
{
Description: cipher suite set type that will be used for Https ,
Enum:
{
Customized: No description available. ,
TLS10_2019: No description available. ,
TLS12_2022: No description available. ,
TLS12_2023: No description available. ,
}
,
Required: False ,
}
enum ,
minimumTlsVersion:
{
Description: TLS protocol version that will be used for Https when cipherSuiteSetType is Customized. ,
Enum:
{
TLS10: No description available. ,
TLS12: No description available. ,
TLS13: No description available. ,
}
,
Required: False ,
}
enum ,
customizedCipherSuiteSet:
{
Description: Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized. ,
Required: False ,
}
{
cipherSuiteSetForTls12:
{
Description: Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2. ,
Required: False ,
}
[
string ,
]
,
cipherSuiteSetForTls13:
{
Description: Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3. ,
Required: False ,
}
[
string ,
]
,
}
,
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 ,
}
,
preValidatedCustomDomainResourceId:
{
Description: Resource reference to the Azure resource where custom domain ownership was prevalidated ,
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 2025-04-15. ,
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com. ,
}
{
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. ,
Rejected: No description available. ,
TimedOut: No description available. ,
PendingRevalidation: No description available. ,
Approved: No description available. ,
RefreshingValidationToken: No description available. ,
InternalError: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: The host name of the domain. Must be a domain name. ,
Required: True ,
}
string ,
extendedProperties:
{
Description: Key-Value pair representing migration properties for domains. ,
Required: False ,
}
object ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDCustomDomains_Delete (updated)
Description :  Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDCustomDomains_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDCustomDomains_RefreshValidationToken (updated)
Description :  Updates the domain validation token.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDCustomDomains_RefreshValidationToken",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_ListByProfile (updated)
Description :  Lists existing AzureFrontDoor endpoints.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_ListByProfile",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_Get (updated)
Description :  Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_Create (updated)
Description :  Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: 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 2025-04-15. ,
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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net. ,
}
{
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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_Update (updated)
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 ¶

⚶ Changes

{
  "#id": "AFDEndpoints_Update",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
profileName:
{
Description: The name of the profile which holds the endpoint. ,
Required: False ,
}
string ,
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 2025-04-15. ,
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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net. ,
}
{
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 ,
autoGeneratedDomainNameLabelScope:
{
Description: Indicates the endpoint name reuse scope. The default value is TenantReuse. ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_Delete (updated)
Description :  Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_PurgeContent (updated)
Description :  Removes a content from AzureFrontDoor.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_PurgeContent",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_ListResourceUsage (updated)
Description :  Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_ListResourceUsage",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDEndpoints_ValidateCustomDomain (updated)
Description :  Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDEndpoints_ValidateCustomDomain",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOriginGroups_ListByProfile (updated)
Description :  Lists all of the existing origin groups within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOriginGroups_ListByProfile",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Front Door origin groups within an Azure Front Door 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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOriginGroups_Get (updated)
Description :  Gets an existing origin group within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOriginGroups_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOriginGroups_Create (updated)
Description :  Creates a new origin group within the specified profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOriginGroups_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOriginGroups_Update (updated)
Description :  Updates an existing origin group within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOriginGroups_Update",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
profileName:
{
Description: The name of the profile which holds the origin group. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
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 ,
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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOriginGroups_Delete (updated)
Description :  Deletes an existing origin group within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOriginGroups_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOriginGroups_ListResourceUsage (updated)
Description :  Checks the quota and actual usage of endpoints under the given Azure Front Door profile..
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOriginGroups_ListResourceUsage",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_ListByOriginGroup (updated)
Description :  Lists all of the existing origins within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_ListByOriginGroup",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Azure Front Door origins within an Azure Front Door 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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Get (updated)
Description :  Gets an existing origin within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Create (updated)
Description :  Creates a new origin within the specified origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Update (updated)
Description :  Updates an existing origin within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Update",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
originGroupName:
{
Description: The name of the origin group which contains this origin. ,
Required: False ,
}
string ,
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 Front Door 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 ,
enforceCertificateNameCheck:
{
Description: Whether to enable certificate name check at origin level ,
Required: False ,
}
boolean ,
}
,
}
,
subscriptionId:
{
Description: Azure Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. Current version is 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AFDOrigins_Delete (updated)
Description :  Deletes an existing origin within an origin group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AFDOrigins_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Routes_ListByEndpoint (updated)
Description :  Lists all of the existing origins within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Routes_ListByEndpoint",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Routes_Get (updated)
Description :  Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Routes_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Routes_Create (updated)
Description :  Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Routes_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly Routes name mapping to the any Routes or secret related information. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Routes_Update (updated)
Description :  Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Routes_Update",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
endpointName:
{
Description: The name of the endpoint which holds the route. ,
Required: False ,
}
string ,
customDomains:
{
Description: Domains referenced by this endpoint. ,
Required: False ,
}
[
{
id:
{
Description: Resource ID. ,
Required: False ,
}
string ,
isActive:
{
Description: Whether the resource is active or inactive ,
Required: False ,
}
boolean ,
}
,
]
,
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 ,
]
,
cacheConfiguration:
{
Description: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object. ,
Required: False ,
}
{
queryStringCachingBehavior:
{
Description: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. ,
Enum:
{
IgnoreQueryString: No description available. ,
UseQueryString: No description available. ,
IgnoreSpecifiedQueryStrings: No description available. ,
IncludeSpecifiedQueryStrings: No description available. ,
}
,
Required: False ,
}
enum ,
queryParameters:
{
Description: query parameters to include or exclude (comma separated). ,
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 ,
}
,
}
,
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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly Routes name mapping to the any Routes or secret related information. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Routes_Delete (updated)
Description :  Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Routes_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RuleSets_ListByProfile (updated)
Description :  Lists existing AzureFrontDoor rule sets within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RuleSets_ListByProfile",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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 ,
}
{
profileName:
{
Description: The name of the profile which holds the rule set. ,
Required: False ,
}
string ,
}
,
}
,
]
,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RuleSets_Get (updated)
Description :  Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RuleSets_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the rule set. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RuleSets_Create (updated)
Description :  Creates a new rule set within the specified profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RuleSets_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the rule set. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The JSON object that contains the properties of the Rule Set to create. ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the rule set. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RuleSets_Delete (updated)
Description :  Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RuleSets_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RuleSets_ListResourceUsage (updated)
Description :  Checks the quota and actual usage of endpoints under the given Azure Front Door profile..
Reference :  Link ¶

⚶ Changes

{
  "#id": "RuleSets_ListResourceUsage",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_ListByRuleSet (updated)
Description :  Lists all of the existing delivery rules within a rule set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Rules_ListByRuleSet",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Get (updated)
Description :  Gets an existing delivery rule within a rule set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Rules_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Create (updated)
Description :  Creates a new delivery rule within the specified rule set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Rules_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly Rules name mapping to the any Rules or secret related information. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Update (updated)
Description :  Updates an existing delivery rule within a rule set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Rules_Update",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 rule to update. ,
Required: False ,
}
{
ruleSetName:
{
Description: The name of the rule set containing 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. ,
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. ,
SocketAddr: No description available. ,
ClientPort: No description available. ,
ServerPort: No description available. ,
HostName: No description available. ,
SslProtocol: 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. ,
RouteConfigurationOverride: 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly Rules name mapping to the any Rules or secret related information. ,
}
{
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Rules_Delete (updated)
Description :  Deletes an existing delivery rule within a rule set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Rules_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPolicies_ListByProfile (updated)
Description :  Lists security policies associated with the profile
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPolicies_ListByProfile",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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 ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPolicies_Get (updated)
Description :  Gets an existing security policy within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPolicies_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPolicies_Create (updated)
Description :  Creates a new security policy within the specified profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPolicies_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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 ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: SecurityPolicy association for AzureFrontDoor profile ,
}
{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPolicies_Patch (updated)
Description :  Updates an existing security policy within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPolicies_Patch",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. ,
Required: True ,
}
string ,
securityPolicyName:
{
Description: Name of the security policy under the profile. ,
Required: True ,
}
string ,
securityPolicyUpdateProperties:
{
Description: Security policy update properties ,
Required: True ,
}
{
properties:
{
Description: The json object that contains properties required to update 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: SecurityPolicy association for AzureFrontDoor profile ,
}
{
properties:
{
Description: The json object that contains properties required to create a security policy ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the security policy. ,
Required: False ,
}
string ,
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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPolicies_Delete (updated)
Description :  Deletes an existing security policy within profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPolicies_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_ListByProfile (updated)
Description :  Lists existing AzureFrontDoor secrets.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Secrets_ListByProfile",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
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 ,
}
{
profileName:
{
Description: The name of the profile which holds the secret. ,
Required: False ,
}
string ,
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the secret resource. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
AzureFirstPartyManagedCertificate: 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: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Get (updated)
Description :  Gets an existing Secret within a profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Secrets_Get",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Create (updated)
Description :  Creates a new Secret within the specified profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Secrets_Create",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 ,
}
{
profileName:
{
Description: The name of the profile which holds the secret. ,
Required: False ,
}
string ,
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the secret resource. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
AzureFirstPartyManagedCertificate: 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (201)

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

⚐ Response (202)

{
$headers:
{
location: string ,
}
,
$schema:
{
Description: Friendly Secret name mapping to the any Secret or secret related information. ,
}
{
properties:
{
Description: The JSON object that contains the properties of the Secret to create. ,
Required: False ,
}
{
profileName:
{
Description: The name of the profile which holds the secret. ,
Required: False ,
}
string ,
parameters:
{
Description: object which contains secret parameters ,
Required: False ,
}
{
type:
{
Description: The type of the secret resource. ,
Enum:
{
UrlSigningKey: No description available. ,
CustomerCertificate: No description available. ,
ManagedCertificate: No description available. ,
AzureFirstPartyManagedCertificate: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Secrets_Delete (updated)
Description :  Deletes an existing Secret within profile.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Secrets_Delete",
  "$parameters": [
    {
      "#name": "profileName",
      "Description": {
        "new": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.",
        "old": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group."
      }
    }
  ]
}

⚼ 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 Azure Front Door Standard or Azure Front Door Premium 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 2025-04-15. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}