Endpoints - List By Profile

Reference

Service:: CDN

API Version:: 2024-02-01

Lists existing CDN endpoints.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints?api-version=2024-02-01

URI Parameters

Name	In	Required	Type	Description
profileName	path	True	string	Name of the CDN profile which is unique within the resource group.
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2024-02-01.

Responses

Name	Type	Description
200 OK	EndpointListResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	CDN error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Endpoints_ListByProfile

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints?api-version=2024-02-01


/**
 * Samples for Endpoints ListByProfile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_ListByProfile.json
     */
    /**
     * Sample code: Endpoints_ListByProfile.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void endpointsListByProfile(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getEndpoints().listByProfile("RG", "profile1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python endpoints_list_by_profile.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.endpoints.list_by_profile(
        resource_group_name="RG",
        profile_name="profile1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_ListByProfile.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_ListByProfile.json
func ExampleEndpointsClient_NewListByProfilePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEndpointsClient().NewListByProfilePager("RG", "profile1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EndpointListResult = armcdn.EndpointListResult{
		// 	Value: []*armcdn.Endpoint{
		// 		{
		// 			Name: to.Ptr("endpoint1"),
		// 			Type: to.Ptr("Microsoft.Cdn/profiles/endpoints"),
		// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1"),
		// 			Location: to.Ptr("CentralUs"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armcdn.EndpointProperties{
		// 				ContentTypesToCompress: []*string{
		// 				},
		// 				DefaultOriginGroup: &armcdn.ResourceReference{
		// 					ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"),
		// 				},
		// 				GeoFilters: []*armcdn.GeoFilter{
		// 				},
		// 				IsCompressionEnabled: to.Ptr(false),
		// 				IsHTTPAllowed: to.Ptr(true),
		// 				IsHTTPSAllowed: to.Ptr(true),
		// 				OptimizationType: to.Ptr(armcdn.OptimizationTypeDynamicSiteAcceleration),
		// 				OriginHostHeader: to.Ptr("www.bing.com"),
		// 				ProbePath: to.Ptr("/image"),
		// 				QueryStringCachingBehavior: to.Ptr(armcdn.QueryStringCachingBehaviorNotSet),
		// 				CustomDomains: []*armcdn.DeepCreatedCustomDomain{
		// 					{
		// 						Name: to.Ptr("www-someDomain-net"),
		// 						Properties: &armcdn.DeepCreatedCustomDomainProperties{
		// 							HostName: to.Ptr("www.someDomain.Net"),
		// 						},
		// 				}},
		// 				HostName: to.Ptr("endpoint1.azureedge.net"),
		// 				OriginGroups: []*armcdn.DeepCreatedOriginGroup{
		// 					{
		// 						Name: to.Ptr("originGroup1"),
		// 						Properties: &armcdn.DeepCreatedOriginGroupProperties{
		// 							HealthProbeSettings: &armcdn.HealthProbeParameters{
		// 								ProbeIntervalInSeconds: to.Ptr[int32](120),
		// 								ProbePath: to.Ptr("/health.aspx"),
		// 								ProbeProtocol: to.Ptr(armcdn.ProbeProtocolHTTP),
		// 								ProbeRequestType: to.Ptr(armcdn.HealthProbeRequestTypeGET),
		// 							},
		// 							Origins: []*armcdn.ResourceReference{
		// 								{
		// 									ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"),
		// 							}},
		// 							ResponseBasedOriginErrorDetectionSettings: &armcdn.ResponseBasedOriginErrorDetectionParameters{
		// 								ResponseBasedDetectedErrorTypes: to.Ptr(armcdn.ResponseBasedDetectedErrorTypesTCPErrorsOnly),
		// 								ResponseBasedFailoverThresholdPercentage: to.Ptr[int32](10),
		// 							},
		// 						},
		// 				}},
		// 				Origins: []*armcdn.DeepCreatedOrigin{
		// 					{
		// 						Name: to.Ptr("www-bing-com"),
		// 						Properties: &armcdn.DeepCreatedOriginProperties{
		// 							Enabled: to.Ptr(true),
		// 							HostName: to.Ptr("www.bing.com"),
		// 							HTTPPort: to.Ptr[int32](80),
		// 							HTTPSPort: to.Ptr[int32](443),
		// 							OriginHostHeader: to.Ptr("www.someDomain2.net"),
		// 							Priority: to.Ptr[int32](2),
		// 							Weight: to.Ptr[int32](50),
		// 						},
		// 				}},
		// 				ProvisioningState: to.Ptr(armcdn.EndpointProvisioningStateSucceeded),
		// 				ResourceState: to.Ptr(armcdn.EndpointResourceStateRunning),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists existing CDN endpoints.
 *
 * @summary Lists existing CDN endpoints.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_ListByProfile.json
 */
async function endpointsListByProfile() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.endpoints.listByProfile(resourceGroupName, profileName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_ListByProfile.json
// this example is just showing the usage of "CdnEndpoints_ListByProfile" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ProfileResource created on azure
// for more information of creating ProfileResource, please refer to the document of ProfileResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
ResourceIdentifier profileResourceId = ProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
ProfileResource profile = client.GetProfileResource(profileResourceId);

// get the collection of this CdnEndpointResource
CdnEndpointCollection collection = profile.GetCdnEndpoints();

// invoke the operation and iterate over the result
await foreach (CdnEndpointResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    CdnEndpointData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "endpoint1",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
      "type": "Microsoft.Cdn/profiles/endpoints",
      "tags": {},
      "location": "CentralUs",
      "properties": {
        "hostName": "endpoint1.azureedge.net",
        "originHostHeader": "www.bing.com",
        "provisioningState": "Succeeded",
        "resourceState": "Running",
        "isHttpAllowed": true,
        "isHttpsAllowed": true,
        "queryStringCachingBehavior": "NotSet",
        "originPath": null,
        "origins": [
          {
            "name": "www-bing-com",
            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com",
            "properties": {
              "hostName": "www.bing.com",
              "httpPort": 80,
              "httpsPort": 443,
              "originHostHeader": "www.someDomain2.net",
              "priority": 2,
              "weight": 50,
              "enabled": true
            }
          }
        ],
        "originGroups": [
          {
            "name": "originGroup1",
            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
            "properties": {
              "healthProbeSettings": {
                "probePath": "/health.aspx",
                "probeRequestType": "GET",
                "probeProtocol": "Http",
                "probeIntervalInSeconds": 120
              },
              "origins": [
                {
                  "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
                }
              ],
              "responseBasedOriginErrorDetectionSettings": {
                "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
                "responseBasedFailoverThresholdPercentage": 10
              }
            }
          }
        ],
        "customDomains": [
          {
            "name": "www-someDomain-net",
            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net",
            "properties": {
              "hostName": "www.someDomain.Net",
              "validationData": null
            }
          }
        ],
        "contentTypesToCompress": [],
        "isCompressionEnabled": false,
        "optimizationType": "DynamicSiteAcceleration",
        "probePath": "/image",
        "geoFilters": [],
        "defaultOriginGroup": {
          "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
        }
      }
    }
  ]
}

Definitions

Name	Description
algorithm	Algorithm to use for URL signing
cacheBehavior	Caching behavior for the requests
CacheConfiguration	Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
CacheExpirationActionParameters	Defines the parameters for the cache expiration action.
CacheKeyQueryStringActionParameters	Defines the parameters for the cache-key query string action.
CacheType	The level at which the content needs to be cached.
ClientPortMatchConditionParameters	Defines the parameters for ClientPort match conditions
ClientPortOperator	Describes operator to be matched
CookiesMatchConditionParameters	Defines the parameters for Cookies match conditions
CookiesOperator	Describes operator to be matched
DeepCreatedCustomDomain	Custom domains created on the CDN endpoint.
DeepCreatedOrigin	The main origin of CDN content which is added when creating a CDN endpoint.
DeepCreatedOriginGroup	The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.
DeliveryPolicy	A policy that specifies the delivery rules to be used for an endpoint.
DeliveryRule	A rule that specifies a set of actions and conditions
DeliveryRuleCacheExpirationAction	Defines the cache expiration action for the delivery rule.
DeliveryRuleCacheKeyQueryStringAction	Defines the cache-key query string action for the delivery rule.
DeliveryRuleClientPortCondition	Defines the ClientPort condition for the delivery rule.
DeliveryRuleCookiesCondition	Defines the Cookies condition for the delivery rule.
DeliveryRuleHostNameCondition	Defines the HostName condition for the delivery rule.
DeliveryRuleHttpVersionCondition	Defines the HttpVersion condition for the delivery rule.
DeliveryRuleIsDeviceCondition	Defines the IsDevice condition for the delivery rule.
DeliveryRulePostArgsCondition	Defines the PostArgs condition for the delivery rule.
DeliveryRuleQueryStringCondition	Defines the QueryString condition for the delivery rule.
DeliveryRuleRemoteAddressCondition	Defines the RemoteAddress condition for the delivery rule.
DeliveryRuleRequestBodyCondition	Defines the RequestBody condition for the delivery rule.
DeliveryRuleRequestHeaderAction	Defines the request header action for the delivery rule.
DeliveryRuleRequestHeaderCondition	Defines the RequestHeader condition for the delivery rule.
DeliveryRuleRequestMethodCondition	Defines the RequestMethod condition for the delivery rule.
DeliveryRuleRequestSchemeCondition	Defines the RequestScheme condition for the delivery rule.
DeliveryRuleRequestUriCondition	Defines the RequestUri condition for the delivery rule.
DeliveryRuleResponseHeaderAction	Defines the response header action for the delivery rule.
DeliveryRuleRouteConfigurationOverrideAction	Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.
DeliveryRuleServerPortCondition	Defines the ServerPort condition for the delivery rule.
DeliveryRuleSocketAddrCondition	Defines the SocketAddress condition for the delivery rule.
DeliveryRuleSslProtocolCondition	Defines the SslProtocol condition for the delivery rule.
DeliveryRuleUrlFileExtensionCondition	Defines the UrlFileExtension condition for the delivery rule.
DeliveryRuleUrlFileNameCondition	Defines the UrlFileName condition for the delivery rule.
DeliveryRuleUrlPathCondition	Defines the UrlPath condition for the delivery rule.
DestinationProtocol	Protocol to use for the redirect. The default value is MatchRequest
Endpoint	CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.
EndpointListResult	Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.
EndpointProvisioningState	Provisioning status of the endpoint.
EndpointResourceState	Resource status of the endpoint.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ForwardingProtocol	Protocol this rule will use when forwarding traffic to backends.
GeoFilter	Rules defining user's geo access within a CDN endpoint.
GeoFilterActions	Action of the geo filter, i.e. allow or block access.
HeaderAction	Action to perform
HeaderActionParameters	Defines the parameters for the request header action.
HealthProbeParameters	The JSON object that contains the properties to send health probes to origin.
HealthProbeRequestType	The type of health probe request that is made.
HostNameMatchConditionParameters	Defines the parameters for HostName match conditions
HostNameOperator	Describes operator to be matched
HttpErrorRangeParameters	The JSON object that represents the range for http status codes
HttpVersionMatchConditionParameters	Defines the parameters for HttpVersion match conditions
HttpVersionOperator	Describes operator to be matched
IdentityType	The type of identity that creates/modifies resources
IsDeviceMatchConditionParameters	Defines the parameters for IsDevice match conditions
IsDeviceMatchValue	The match value for the condition of the delivery rule
IsDeviceOperator	Describes operator to be matched
KeyVaultSigningKeyParameters	Describes the parameters for using a user's KeyVault for URL Signing Key.
KeyVaultSigningKeyParametersType
OptimizationType	Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.
OriginGroupOverride	Defines the parameters for the origin group override configuration.
OriginGroupOverrideAction	Defines the origin group override action for the delivery rule.
OriginGroupOverrideActionParameters	Defines the parameters for the origin group override action.
paramIndicator	Indicates the purpose of the parameter
PostArgsMatchConditionParameters	Defines the parameters for PostArgs match conditions
PostArgsOperator	Describes operator to be matched
PrivateEndpointStatus	The approval status for the connection to the Private Link
ProbeProtocol	Protocol to use for health probe.
queryStringBehavior	Caching behavior for the requests
QueryStringCachingBehavior	Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
QueryStringMatchConditionParameters	Defines the parameters for QueryString match conditions
QueryStringOperator	Describes operator to be matched
RedirectType	The redirect type the rule will use when redirecting traffic.
RemoteAddressMatchConditionParameters	Defines the parameters for RemoteAddress match conditions
RemoteAddressOperator	Describes operator to be matched
RequestBodyMatchConditionParameters	Defines the parameters for RequestBody match conditions
RequestBodyOperator	Describes operator to be matched
RequestHeaderMatchConditionParameters	Defines the parameters for RequestHeader match conditions
RequestHeaderOperator	Describes operator to be matched
RequestMethodMatchConditionParameters	Defines the parameters for RequestMethod match conditions
RequestMethodMatchValue	The match value for the condition of the delivery rule
RequestMethodOperator	Describes operator to be matched
RequestSchemeMatchConditionParameters	Defines the parameters for RequestScheme match conditions
RequestSchemeMatchValue	The match value for the condition of the delivery rule
RequestUriMatchConditionParameters	Defines the parameters for RequestUri match conditions
RequestUriOperator	Describes operator to be matched
ResourceReference	Reference to another resource.
ResponseBasedDetectedErrorTypes	Type of response errors for real user requests for which origin will be deemed unhealthy
ResponseBasedOriginErrorDetectionParameters	The JSON object that contains the properties to determine origin health using real requests/responses.
RouteConfigurationOverrideActionParameters	Defines the parameters for the route configuration override action.
ruleCacheBehavior	Caching behavior for the requests
ruleIsCompressionEnabled	Indicates whether content compression is enabled. 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.
ruleQueryStringCachingBehavior	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.
ServerPortMatchConditionParameters	Defines the parameters for ServerPort match conditions
ServerPortOperator	Describes operator to be matched
SocketAddrMatchConditionParameters	Defines the parameters for SocketAddress match conditions
SocketAddrOperator	Describes operator to be matched
SslProtocol	The protocol of an established TLS connection.
SslProtocolMatchConditionParameters	Defines the parameters for SslProtocol match conditions
SslProtocolOperator	Describes operator to be matched
SystemData	Read only system data
transform	Describes what transforms are applied before matching
UrlFileExtensionMatchConditionParameters	Defines the parameters for UrlFileExtension match conditions
UrlFileExtensionOperator	Describes operator to be matched
UrlFileNameMatchConditionParameters	Defines the parameters for UrlFilename match conditions
UrlFileNameOperator	Describes operator to be matched
UrlPathMatchConditionParameters	Defines the parameters for UrlPath match conditions
UrlPathOperator	Describes operator to be matched
UrlRedirectAction	Defines the url redirect action for the delivery rule.
UrlRedirectActionParameters	Defines the parameters for the url redirect action.
UrlRewriteAction	Defines the url rewrite action for the delivery rule.
UrlRewriteActionParameters	Defines the parameters for the url rewrite action.
UrlSigningAction	Defines the url signing action for the delivery rule.
UrlSigningActionParameters	Defines the parameters for the Url Signing action.
UrlSigningKey	Url signing key
UrlSigningParamIdentifier	Defines how to identify a parameter for a specific purpose e.g. expires
WebApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for the endpoint (if applicable)

algorithm

Algorithm to use for URL signing

Name	Type	Description
SHA256	string

cacheBehavior

Caching behavior for the requests

Name	Type	Description
BypassCache	string
Override	string
SetIfMissing	string

CacheConfiguration

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

Name	Type	Description
cacheBehavior	ruleCacheBehavior	Caching behavior for the requests
cacheDuration	string	The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss
isCompressionEnabled	ruleIsCompressionEnabled	Indicates whether content compression is enabled. 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.
queryParameters	string	query parameters to include or exclude (comma separated).
queryStringCachingBehavior	ruleQueryStringCachingBehavior	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.

CacheExpirationActionParameters

Defines the parameters for the cache expiration action.

Name	Type	Description
cacheBehavior	cacheBehavior	Caching behavior for the requests
cacheDuration	string	The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss
cacheType	CacheType	The level at which the content needs to be cached.
typeName	string: DeliveryRuleCacheExpirationActionParameters

CacheKeyQueryStringActionParameters

Defines the parameters for the cache-key query string action.

Name	Type	Description
queryParameters	string	query parameters to include or exclude (comma separated).
queryStringBehavior	queryStringBehavior	Caching behavior for the requests
typeName	string: DeliveryRuleCacheKeyQueryStringBehaviorActionParameters

CacheType

The level at which the content needs to be cached.

Name	Type	Description
All	string

ClientPortMatchConditionParameters

Defines the parameters for ClientPort match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	ClientPortOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleClientPortConditionParameters

ClientPortOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

CookiesMatchConditionParameters

Defines the parameters for Cookies match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	CookiesOperator		Describes operator to be matched
selector	string		Name of Cookies to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleCookiesConditionParameters

CookiesOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

DeepCreatedCustomDomain

Custom domains created on the CDN endpoint.

Name	Type	Description
name	string	Custom domain name.
properties.hostName	string	The host name of the custom domain. Must be a domain name.
properties.validationData	string	Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.

DeepCreatedOrigin

The main origin of CDN content which is added when creating a CDN endpoint.

Name	Type	Description
name	string	Origin name which must be unique within the endpoint.
properties.enabled	boolean	Origin is enabled for load balancing or not. By default, origin is always enabled.
properties.hostName	string	The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.
properties.httpPort	integer	The value of the HTTP port. Must be between 1 and 65535.
properties.httpsPort	integer	The value of the HTTPS port. Must be between 1 and 65535.
properties.originHostHeader	string	The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
properties.priority	integer	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.
properties.privateEndpointStatus	PrivateEndpointStatus	The approval status for the connection to the Private Link
properties.privateLinkAlias	string	The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
properties.privateLinkApprovalMessage	string	A custom message to be included in the approval request to connect to the Private Link.
properties.privateLinkLocation	string	The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
properties.privateLinkResourceId	string	The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
properties.weight	integer	Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

DeepCreatedOriginGroup

The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.

Name	Type	Description
name	string	Origin group name which must be unique within the endpoint.
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.origins	ResourceReference[]	The source of the content being delivered via CDN within given origin group.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	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.

DeliveryPolicy

A policy that specifies the delivery rules to be used for an endpoint.

Name	Type	Description
description	string	User-friendly description of the policy.
rules	DeliveryRule[]	A list of the delivery rules.

DeliveryRule

A rule that specifies a set of actions and conditions

Name	Type	Description
actions	DeliveryRuleAction[]: DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleRouteConfigurationOverrideAction[] OriginGroupOverrideAction[] UrlRedirectAction[] UrlRewriteAction[] UrlSigningAction[]	A list of actions that are executed when all the conditions of a rule are satisfied.
conditions	DeliveryRuleCondition[]: DeliveryRuleClientPortCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleQueryStringCondition[] DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleSslProtocolCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleUrlPathCondition[]	A list of conditions that must be matched for the actions to be executed
name	string	Name of the rule
order	integer	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.

DeliveryRuleCacheExpirationAction

Defines the cache expiration action for the delivery rule.

Name	Type	Description
name	string: CacheExpiration	The name of the action for the delivery rule.
parameters	CacheExpirationActionParameters	Defines the parameters for the action.

DeliveryRuleCacheKeyQueryStringAction

Defines the cache-key query string action for the delivery rule.

Name	Type	Description
name	string: CacheKeyQueryString	The name of the action for the delivery rule.
parameters	CacheKeyQueryStringActionParameters	Defines the parameters for the action.

DeliveryRuleClientPortCondition

Defines the ClientPort condition for the delivery rule.

Name	Type	Description
name	string: ClientPort	The name of the condition for the delivery rule.
parameters	ClientPortMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleCookiesCondition

Defines the Cookies condition for the delivery rule.

Name	Type	Description
name	string: Cookies	The name of the condition for the delivery rule.
parameters	CookiesMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleHostNameCondition

Defines the HostName condition for the delivery rule.

Name	Type	Description
name	string: HostName	The name of the condition for the delivery rule.
parameters	HostNameMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleHttpVersionCondition

Defines the HttpVersion condition for the delivery rule.

Name	Type	Description
name	string: HttpVersion	The name of the condition for the delivery rule.
parameters	HttpVersionMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleIsDeviceCondition

Defines the IsDevice condition for the delivery rule.

Name	Type	Description
name	string: IsDevice	The name of the condition for the delivery rule.
parameters	IsDeviceMatchConditionParameters	Defines the parameters for the condition.

DeliveryRulePostArgsCondition

Defines the PostArgs condition for the delivery rule.

Name	Type	Description
name	string: PostArgs	The name of the condition for the delivery rule.
parameters	PostArgsMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleQueryStringCondition

Defines the QueryString condition for the delivery rule.

Name	Type	Description
name	string: QueryString	The name of the condition for the delivery rule.
parameters	QueryStringMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleRemoteAddressCondition

Defines the RemoteAddress condition for the delivery rule.

Name	Type	Description
name	string: RemoteAddress	The name of the condition for the delivery rule.
parameters	RemoteAddressMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleRequestBodyCondition

Defines the RequestBody condition for the delivery rule.

Name	Type	Description
name	string: RequestBody	The name of the condition for the delivery rule.
parameters	RequestBodyMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleRequestHeaderAction

Defines the request header action for the delivery rule.

Name	Type	Description
name	string: ModifyRequestHeader	The name of the action for the delivery rule.
parameters	HeaderActionParameters	Defines the parameters for the action.

DeliveryRuleRequestHeaderCondition

Defines the RequestHeader condition for the delivery rule.

Name	Type	Description
name	string: RequestHeader	The name of the condition for the delivery rule.
parameters	RequestHeaderMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleRequestMethodCondition

Defines the RequestMethod condition for the delivery rule.

Name	Type	Description
name	string: RequestMethod	The name of the condition for the delivery rule.
parameters	RequestMethodMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleRequestSchemeCondition

Defines the RequestScheme condition for the delivery rule.

Name	Type	Description
name	string: RequestScheme	The name of the condition for the delivery rule.
parameters	RequestSchemeMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleRequestUriCondition

Defines the RequestUri condition for the delivery rule.

Name	Type	Description
name	string: RequestUri	The name of the condition for the delivery rule.
parameters	RequestUriMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleResponseHeaderAction

Defines the response header action for the delivery rule.

Name	Type	Description
name	string: ModifyResponseHeader	The name of the action for the delivery rule.
parameters	HeaderActionParameters	Defines the parameters for the action.

DeliveryRuleRouteConfigurationOverrideAction

Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.

Name	Type	Description
name	string: RouteConfigurationOverride	The name of the action for the delivery rule.
parameters	RouteConfigurationOverrideActionParameters	Defines the parameters for the action.

DeliveryRuleServerPortCondition

Defines the ServerPort condition for the delivery rule.

Name	Type	Description
name	string: ServerPort	The name of the condition for the delivery rule.
parameters	ServerPortMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleSocketAddrCondition

Defines the SocketAddress condition for the delivery rule.

Name	Type	Description
name	string: SocketAddr	The name of the condition for the delivery rule.
parameters	SocketAddrMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleSslProtocolCondition

Defines the SslProtocol condition for the delivery rule.

Name	Type	Description
name	string: SslProtocol	The name of the condition for the delivery rule.
parameters	SslProtocolMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleUrlFileExtensionCondition

Defines the UrlFileExtension condition for the delivery rule.

Name	Type	Description
name	string: UrlFileExtension	The name of the condition for the delivery rule.
parameters	UrlFileExtensionMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleUrlFileNameCondition

Defines the UrlFileName condition for the delivery rule.

Name	Type	Description
name	string: UrlFileName	The name of the condition for the delivery rule.
parameters	UrlFileNameMatchConditionParameters	Defines the parameters for the condition.

DeliveryRuleUrlPathCondition

Defines the UrlPath condition for the delivery rule.

Name	Type	Description
name	string: UrlPath	The name of the condition for the delivery rule.
parameters	UrlPathMatchConditionParameters	Defines the parameters for the condition.

DestinationProtocol

Protocol to use for the redirect. The default value is MatchRequest

Name	Type	Description
Http	string
Https	string
MatchRequest	string

Endpoint

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.

Name	Type	Default value	Description
id	string		Resource ID.
location	string		Resource location.
name	string		Resource name.
properties.contentTypesToCompress	string[]		List of content types on which compression applies. The value should be a valid MIME type.
properties.customDomains	DeepCreatedCustomDomain[]		The custom domains under the endpoint.
properties.defaultOriginGroup	ResourceReference		A reference to the origin group.
properties.deliveryPolicy	DeliveryPolicy		A policy that specifies the delivery rules to be used for an endpoint.
properties.geoFilters	GeoFilter[]		List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/
properties.hostName	string		The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
properties.isCompressionEnabled	boolean		Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
properties.isHttpAllowed	boolean	True	Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
properties.isHttpsAllowed	boolean	True	Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
properties.optimizationType	OptimizationType		Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.
properties.originGroups	DeepCreatedOriginGroup[]		The origin groups comprising of origins that are used for load balancing the traffic based on availability.
properties.originHostHeader	string		The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
properties.originPath	string		A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
properties.origins	DeepCreatedOrigin[]		The source of the content being delivered via CDN.
properties.probePath	string		Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
properties.provisioningState	EndpointProvisioningState		Provisioning status of the endpoint.
properties.queryStringCachingBehavior	QueryStringCachingBehavior	NotSet	Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
properties.resourceState	EndpointResourceState		Resource status of the endpoint.
properties.urlSigningKeys	UrlSigningKey[]		List of keys used to validate the signed URL hashes.
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink		Defines the Web Application Firewall policy for the endpoint (if applicable)
systemData	SystemData		Read only system data
tags	object		Resource tags.
type	string		Resource type.

EndpointListResult

Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of endpoint objects if there is any.
value	Endpoint[]	List of CDN endpoints within a profile

EndpointProvisioningState

Provisioning status of the endpoint.

Name	Type	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

EndpointResourceState

Resource status of the endpoint.

Name	Type	Description
Creating	string
Deleting	string
Running	string
Starting	string
Stopped	string
Stopping	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ForwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

Name	Type	Description
HttpOnly	string
HttpsOnly	string
MatchRequest	string

GeoFilter

Rules defining user's geo access within a CDN endpoint.

Name	Type	Description
action	GeoFilterActions	Action of the geo filter, i.e. allow or block access.
countryCodes	string[]	Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US.
relativePath	string	Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)

GeoFilterActions

Action of the geo filter, i.e. allow or block access.

Name	Type	Description
Allow	string
Block	string

HeaderAction

Action to perform

Name	Type	Description
Append	string
Delete	string
Overwrite	string

HeaderActionParameters

Defines the parameters for the request header action.

Name	Type	Description
headerAction	HeaderAction	Action to perform
headerName	string	Name of the header to modify
typeName	string: DeliveryRuleHeaderActionParameters
value	string	Value for the specified action

HealthProbeParameters

The JSON object that contains the properties to send health probes to origin.

Name	Type	Description
probeIntervalInSeconds	integer	The number of seconds between health probes.Default is 240sec.
probePath	string	The path relative to the origin that is used to determine the health of the origin.
probeProtocol	ProbeProtocol	Protocol to use for health probe.
probeRequestType	HealthProbeRequestType	The type of health probe request that is made.

HealthProbeRequestType

The type of health probe request that is made.

Name	Type	Description
GET	string
HEAD	string
NotSet	string

HostNameMatchConditionParameters

Defines the parameters for HostName match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	HostNameOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleHostNameConditionParameters

HostNameOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

HttpErrorRangeParameters

The JSON object that represents the range for http status codes

Name	Type	Description
begin	integer	The inclusive start of the http status code range.
end	integer	The inclusive end of the http status code range.

HttpVersionMatchConditionParameters

Defines the parameters for HttpVersion match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	HttpVersionOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleHttpVersionConditionParameters

HttpVersionOperator

Describes operator to be matched

Name	Type	Description
Equal	string

IdentityType

The type of identity that creates/modifies resources

Name	Type	Description
application	string
key	string
managedIdentity	string
user	string

IsDeviceMatchConditionParameters

Defines the parameters for IsDevice match conditions

Name	Type	Default value	Description
matchValues	IsDeviceMatchValue[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	IsDeviceOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleIsDeviceConditionParameters

IsDeviceMatchValue

The match value for the condition of the delivery rule

Name	Type	Description
Desktop	string
Mobile	string

IsDeviceOperator

Describes operator to be matched

Name	Type	Description
Equal	string

KeyVaultSigningKeyParameters

Describes the parameters for using a user's KeyVault for URL Signing Key.

Name	Type	Description
resourceGroupName	string	Resource group of the user's Key Vault containing the secret
secretName	string	The name of secret in Key Vault.
secretVersion	string	The version(GUID) of secret in Key Vault.
subscriptionId	string	Subscription Id of the user's Key Vault containing the secret
typeName	KeyVaultSigningKeyParametersType
vaultName	string	The name of the user's Key Vault containing the secret

KeyVaultSigningKeyParametersType

Name	Type	Description
KeyVaultSigningKeyParameters	string

OptimizationType

Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.

Name	Type	Description
DynamicSiteAcceleration	string
GeneralMediaStreaming	string
GeneralWebDelivery	string
LargeFileDownload	string
VideoOnDemandMediaStreaming	string

OriginGroupOverride

Defines the parameters for the origin group override configuration.

Name	Type	Description
forwardingProtocol	ForwardingProtocol	Protocol this rule will use when forwarding traffic to backends.
originGroup	ResourceReference	defines the OriginGroup that would override the DefaultOriginGroup on route.

OriginGroupOverrideAction

Defines the origin group override action for the delivery rule.

Name	Type	Description
name	string: OriginGroupOverride	The name of the action for the delivery rule.
parameters	OriginGroupOverrideActionParameters	Defines the parameters for the action.

OriginGroupOverrideActionParameters

Defines the parameters for the origin group override action.

Name	Type	Description
originGroup	ResourceReference	defines the OriginGroup that would override the DefaultOriginGroup.
typeName	string: DeliveryRuleOriginGroupOverrideActionParameters

paramIndicator

Indicates the purpose of the parameter

Name	Type	Description
Expires	string
KeyId	string
Signature	string

PostArgsMatchConditionParameters

Defines the parameters for PostArgs match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	PostArgsOperator		Describes operator to be matched
selector	string		Name of PostArg to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRulePostArgsConditionParameters

PostArgsOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

PrivateEndpointStatus

The approval status for the connection to the Private Link

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

ProbeProtocol

Protocol to use for health probe.

Name	Type	Description
Http	string
Https	string
NotSet	string

queryStringBehavior

Caching behavior for the requests

Name	Type	Description
Exclude	string
ExcludeAll	string
Include	string
IncludeAll	string

QueryStringCachingBehavior

Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

Name	Type	Description
BypassCaching	string
IgnoreQueryString	string
NotSet	string
UseQueryString	string

QueryStringMatchConditionParameters

Defines the parameters for QueryString match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	QueryStringOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleQueryStringConditionParameters

QueryStringOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RedirectType

The redirect type the rule will use when redirecting traffic.

Name	Type	Description
Found	string
Moved	string
PermanentRedirect	string
TemporaryRedirect	string

RemoteAddressMatchConditionParameters

Defines the parameters for RemoteAddress match conditions

Name	Type	Default value	Description
matchValues	string[]		Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.
negateCondition	boolean	False	Describes if this is negate condition or not
operator	RemoteAddressOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

Describes operator to be matched

Name	Type	Description
Any	string
GeoMatch	string
IPMatch	string

RequestBodyMatchConditionParameters

Defines the parameters for RequestBody match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	RequestBodyOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleRequestBodyConditionParameters

RequestBodyOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestHeaderMatchConditionParameters

Defines the parameters for RequestHeader match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	RequestHeaderOperator		Describes operator to be matched
selector	string		Name of Header to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestMethodMatchConditionParameters

Defines the parameters for RequestMethod match conditions

Name	Type	Default value	Description
matchValues	RequestMethodMatchValue[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	RequestMethodOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleRequestMethodConditionParameters

RequestMethodMatchValue

The match value for the condition of the delivery rule

Name	Type	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

RequestMethodOperator

Describes operator to be matched

Name	Type	Description
Equal	string

RequestSchemeMatchConditionParameters

Defines the parameters for RequestScheme match conditions

Name	Type	Default value	Description
matchValues	RequestSchemeMatchValue[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	enum: Equal		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleRequestSchemeConditionParameters

RequestSchemeMatchValue

The match value for the condition of the delivery rule

Name	Type	Description
HTTP	string
HTTPS	string

RequestUriMatchConditionParameters

Defines the parameters for RequestUri match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	RequestUriOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleRequestUriConditionParameters

RequestUriOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

ResponseBasedDetectedErrorTypes

Type of response errors for real user requests for which origin will be deemed unhealthy

Name	Type	Description
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

The JSON object that contains the properties to determine origin health using real requests/responses.

Name	Type	Description
httpErrorRanges	HttpErrorRangeParameters[]	The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	Type of response errors for real user requests for which origin will be deemed unhealthy
responseBasedFailoverThresholdPercentage	integer	The percentage of failed requests in the sample where failover should trigger.

RouteConfigurationOverrideActionParameters

Defines the parameters for the route configuration override action.

Name	Type	Description
cacheConfiguration	CacheConfiguration	The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.
originGroupOverride	OriginGroupOverride	A reference to the origin group override configuration. Leave empty to use the default origin group on route.
typeName	string: DeliveryRuleRouteConfigurationOverrideActionParameters

ruleCacheBehavior

Caching behavior for the requests

Name	Type	Description
HonorOrigin	string
OverrideAlways	string
OverrideIfOriginMissing	string

ruleIsCompressionEnabled

Indicates whether content compression is enabled. 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.

Name	Type	Description
Disabled	string
Enabled	string

ruleQueryStringCachingBehavior

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.

Name	Type	Description
IgnoreQueryString	string
IgnoreSpecifiedQueryStrings	string
IncludeSpecifiedQueryStrings	string
UseQueryString	string

ServerPortMatchConditionParameters

Defines the parameters for ServerPort match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	ServerPortOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleServerPortConditionParameters

ServerPortOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

SocketAddrMatchConditionParameters

Defines the parameters for SocketAddress match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	SocketAddrOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

Describes operator to be matched

Name	Type	Description
Any	string
IPMatch	string

SslProtocol

The protocol of an established TLS connection.

Name	Type	Description
TLSv1	string
TLSv1.1	string
TLSv1.2	string

SslProtocolMatchConditionParameters

Defines the parameters for SslProtocol match conditions

Name	Type	Default value	Description
matchValues	SslProtocol[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	SslProtocolOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleSslProtocolConditionParameters

SslProtocolOperator

Describes operator to be matched

Name	Type	Description
Equal	string

SystemData

Read only system data

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC)
createdBy	string	An identifier for the identity that created the resource
createdByType	IdentityType	The type of identity that created the resource
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	An identifier for the identity that last modified the resource
lastModifiedByType	IdentityType	The type of identity that last modified the resource

transform

Describes what transforms are applied before matching

Name	Type	Description
Lowercase	string
RemoveNulls	string
Trim	string
Uppercase	string
UrlDecode	string
UrlEncode	string

UrlFileExtensionMatchConditionParameters

Defines the parameters for UrlFileExtension match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	UrlFileExtensionOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleUrlFileExtensionMatchConditionParameters

UrlFileExtensionOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlFileNameMatchConditionParameters

Defines the parameters for UrlFilename match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	UrlFileNameOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleUrlFilenameConditionParameters

UrlFileNameOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlPathMatchConditionParameters

Defines the parameters for UrlPath match conditions

Name	Type	Default value	Description
matchValues	string[]		The match value for the condition of the delivery rule
negateCondition	boolean	False	Describes if this is negate condition or not
operator	UrlPathOperator		Describes operator to be matched
transforms	transform[]		List of transforms
typeName	string: DeliveryRuleUrlPathMatchConditionParameters

UrlPathOperator

Describes operator to be matched

Name	Type	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string
Wildcard	string

UrlRedirectAction

Defines the url redirect action for the delivery rule.

Name	Type	Description
name	string: UrlRedirect	The name of the action for the delivery rule.
parameters	UrlRedirectActionParameters	Defines the parameters for the action.

UrlRedirectActionParameters

Defines the parameters for the url redirect action.

Name	Type	Description
customFragment	string	Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #.
customHostname	string	Host to redirect. Leave empty to use the incoming host as the destination host.
customPath	string	The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.
customQueryString	string	The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.
destinationProtocol	DestinationProtocol	Protocol to use for the redirect. The default value is MatchRequest
redirectType	RedirectType	The redirect type the rule will use when redirecting traffic.
typeName	string: DeliveryRuleUrlRedirectActionParameters

UrlRewriteAction

Defines the url rewrite action for the delivery rule.

Name	Type	Description
name	string: UrlRewrite	The name of the action for the delivery rule.
parameters	UrlRewriteActionParameters	Defines the parameters for the action.

UrlRewriteActionParameters

Defines the parameters for the url rewrite action.

Name	Type	Description
destination	string	Define the relative URL to which the above requests will be rewritten by.
preserveUnmatchedPath	boolean	Whether to preserve unmatched path. Default value is true.
sourcePattern	string	define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.
typeName	string: DeliveryRuleUrlRewriteActionParameters

UrlSigningAction

Defines the url signing action for the delivery rule.

Name	Type	Description
name	string: UrlSigning	The name of the action for the delivery rule.
parameters	UrlSigningActionParameters	Defines the parameters for the action.

UrlSigningActionParameters

Defines the parameters for the Url Signing action.

Name	Type	Description
algorithm	algorithm	Algorithm to use for URL signing
parameterNameOverride	UrlSigningParamIdentifier[]	Defines which query string parameters in the url to be considered for expires, key id etc.
typeName	string: DeliveryRuleUrlSigningActionParameters

UrlSigningKey

Url signing key

Name	Type	Description
keyId	string	Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
keySourceParameters	KeyVaultSigningKeyParameters	Defines the parameters for using customer key vault for Url Signing Key.

UrlSigningParamIdentifier

Defines how to identify a parameter for a specific purpose e.g. expires

Name	Type	Description
paramIndicator	paramIndicator	Indicates the purpose of the parameter
paramName	string	Parameter name

WebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for the endpoint (if applicable)

Name	Type	Description
id	string	Resource ID.

Share via

Endpoints - List By Profile

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Endpoints_ListByProfile

Sample request

Sample response

Definitions

algorithm

cacheBehavior

CacheConfiguration

CacheExpirationActionParameters

CacheKeyQueryStringActionParameters

CacheType

ClientPortMatchConditionParameters

ClientPortOperator

CookiesMatchConditionParameters

CookiesOperator

DeepCreatedCustomDomain

DeepCreatedOrigin

DeepCreatedOriginGroup

DeliveryPolicy

DeliveryRule

DeliveryRuleCacheExpirationAction

DeliveryRuleCacheKeyQueryStringAction

DeliveryRuleClientPortCondition

DeliveryRuleCookiesCondition

DeliveryRuleHostNameCondition

DeliveryRuleHttpVersionCondition

DeliveryRuleIsDeviceCondition

DeliveryRulePostArgsCondition

DeliveryRuleQueryStringCondition

DeliveryRuleRemoteAddressCondition

DeliveryRuleRequestBodyCondition

DeliveryRuleRequestHeaderAction

DeliveryRuleRequestHeaderCondition

DeliveryRuleRequestMethodCondition

DeliveryRuleRequestSchemeCondition

DeliveryRuleRequestUriCondition

DeliveryRuleResponseHeaderAction

DeliveryRuleRouteConfigurationOverrideAction

DeliveryRuleServerPortCondition

DeliveryRuleSocketAddrCondition

DeliveryRuleSslProtocolCondition

DeliveryRuleUrlFileExtensionCondition

DeliveryRuleUrlFileNameCondition

DeliveryRuleUrlPathCondition

DestinationProtocol

Endpoint

EndpointListResult

EndpointProvisioningState

EndpointResourceState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

GeoFilter

GeoFilterActions

HeaderAction

HeaderActionParameters

HealthProbeParameters

HealthProbeRequestType

HostNameMatchConditionParameters

HostNameOperator

HttpErrorRangeParameters

HttpVersionMatchConditionParameters

HttpVersionOperator

IdentityType

IsDeviceMatchConditionParameters

IsDeviceMatchValue

IsDeviceOperator

KeyVaultSigningKeyParameters

KeyVaultSigningKeyParametersType

OptimizationType

OriginGroupOverride

OriginGroupOverrideAction