你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Endpoints - Create

服务:: CDN

API 版本:: 2025-04-15

在指定的订阅、资源组和配置文件下创建具有指定终结点名称的新 CDN 终结点。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}?api-version=2025-04-15

URI 参数

名称	在	必需	类型	说明
endpointName	path	True	string	全局唯一的配置文件下的终结点的名称。
profileName	path	True	string	资源组中唯一的 CDN 配置文件的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
properties.origins	True	DeepCreatedOrigin[]	通过 CDN 传递的内容源。
properties.contentTypesToCompress		string[]	要对其应用压缩的内容类型的列表。该值应为有效的 MIME 类型。
properties.defaultOriginGroup		ResourceReference	对源组的引用。
properties.deliveryPolicy		DeliveryPolicy	一个策略，指定要用于终结点的传递规则。
properties.geoFilters		GeoFilter[]	定义 CDN 终结点中用户异地访问的规则列表。每个地理筛选器定义对指定路径或内容的访问规则，例如阻止路径 /pictures/
properties.isCompressionEnabled		boolean	指示是否在 CDN 上启用内容压缩。默认值为 false。如果启用了压缩，则如果用户请求压缩版本，内容将作为压缩。当请求的内容小于 1 字节或大于 1 MB 时，不会在 CDN 上压缩内容。
properties.isHttpAllowed		boolean	指示是否允许终结点上的 HTTP 流量。默认值为 true。必须至少允许一个协议（HTTP 或 HTTPS）。
properties.isHttpsAllowed		boolean	指示是否允许终结点上的 HTTPS 流量。默认值为 true。必须至少允许一个协议（HTTP 或 HTTPS）。
properties.optimizationType		OptimizationType	指定客户希望此 CDN 终结点针对哪些方案进行优化，例如下载媒体服务。利用此信息，CDN 可以应用方案驱动的优化。
properties.originGroups		DeepCreatedOriginGroup[]	源组由用于基于可用性对流量进行负载均衡的源组。
properties.originHostHeader		string	随每个请求发送到源的主机标头值。仅当终结点使用单一源并且可由源中指定的同一属性重写时，才允许终结点中的此属性。如果将此保留为空，则请求主机名将确定此值。默认情况下，Azure CDN 源（例如 Web 应用、Blob 存储和云服务）要求此主机标头值与源主机名匹配。
properties.originPath		string	CDN 可用于从中检索内容的源上的目录路径，例如 contoso.cloudapp.net/originpath。
properties.probePath		string	源上托管的文件的路径，有助于加速动态内容的交付，并计算 CDN 的最佳路由。这与源路径相对。此属性仅在使用单个源时相关。
properties.queryStringCachingBehavior		QueryStringCachingBehavior	定义 CDN 如何缓存包含查询字符串的请求。缓存时，可以忽略任何查询字符串，绕过缓存，以防止包含查询字符串的请求被缓存，或缓存每个请求的唯一 URL。
properties.urlSigningKeys		UrlSigningKey[]	用于验证已签名 URL 哈希的密钥列表。
properties.webApplicationFirewallPolicyLink		WebApplicationFirewallPolicyLink	定义终结点的 Web 应用程序防火墙策略（如果适用）
tags		object	资源标记。

响应

名称	类型	说明
200 OK	Endpoint	还行。请求已成功。
201 Created	Endpoint	创建。请求已完成，并创建了一个新终结点。
202 Accepted	Endpoint	接受且操作将以异步方式完成。标头 location: string
Other Status Codes	ErrorResponse	描述作失败的原因的 CDN 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Endpoints_Create

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1?api-version=2025-04-15

{
  "location": "WestUs",
  "tags": {
    "key1": "value1"
  },
  "properties": {
    "originHostHeader": "www.bing.com",
    "originPath": "/photos",
    "contentTypesToCompress": [
      "text/html",
      "application/octet-stream"
    ],
    "isCompressionEnabled": true,
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "BypassCaching",
    "defaultOriginGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
    },
    "deliveryPolicy": {
      "description": "Test description for a policy.",
      "rules": [
        {
          "name": "rule1",
          "order": 1,
          "conditions": [
            {
              "name": "RemoteAddress",
              "parameters": {
                "operator": "IPMatch",
                "negateCondition": true,
                "matchValues": [
                  "192.168.1.0/24",
                  "10.0.0.0/24"
                ],
                "typeName": "DeliveryRuleRemoteAddressConditionParameters"
              }
            }
          ],
          "actions": [
            {
              "name": "CacheExpiration",
              "parameters": {
                "cacheBehavior": "Override",
                "cacheDuration": "10:10:09",
                "typeName": "DeliveryRuleCacheExpirationActionParameters",
                "cacheType": "All"
              }
            },
            {
              "name": "ModifyResponseHeader",
              "parameters": {
                "headerAction": "Overwrite",
                "headerName": "Access-Control-Allow-Origin",
                "value": "*",
                "typeName": "DeliveryRuleHeaderActionParameters"
              }
            },
            {
              "name": "ModifyRequestHeader",
              "parameters": {
                "headerAction": "Overwrite",
                "headerName": "Accept-Encoding",
                "value": "gzip",
                "typeName": "DeliveryRuleHeaderActionParameters"
              }
            }
          ]
        }
      ]
    },
    "origins": [
      {
        "name": "origin1",
        "properties": {
          "hostName": "www.someDomain1.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain1.net",
          "priority": 1,
          "weight": 50,
          "enabled": true
        }
      },
      {
        "name": "origin2",
        "properties": {
          "hostName": "www.someDomain2.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain2.net",
          "priority": 2,
          "weight": 50,
          "enabled": true
        }
      }
    ],
    "originGroups": [
      {
        "name": "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/origin1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
            }
          ],
          "responseBasedOriginErrorDetectionSettings": {
            "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
            "responseBasedFailoverThresholdPercentage": 10
          }
        }
      }
    ]
  }
}

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/2025-04-15/examples/Endpoints_Create.json
// this example is just showing the usage of "CdnEndpoints_Create" 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
string endpointName = "endpoint1";
CdnEndpointData data = new CdnEndpointData(default);
ArmOperation<CdnEndpointResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, endpointName, data);
CdnEndpointResource result = lro.Value;

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:: 200

{
  "name": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint4899.azureedge-test.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "BypassCaching",
    "originPath": "/photos",
    "defaultOriginGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
    },
    "origins": [
      {
        "name": "origin1",
        "properties": {
          "hostName": "www.someDomain1.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain1.net",
          "priority": 1,
          "weight": 50,
          "enabled": true
        }
      },
      {
        "name": "origin2",
        "properties": {
          "hostName": "www.someDomain2.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain2.net",
          "priority": 2,
          "weight": 50,
          "enabled": true
        }
      }
    ],
    "originGroups": [
      {
        "name": "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/origin1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
            }
          ],
          "responseBasedOriginErrorDetectionSettings": {
            "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
            "responseBasedFailoverThresholdPercentage": 10
          }
        }
      }
    ],
    "contentTypesToCompress": [
      "text/html",
      "application/octet-stream"
    ],
    "isCompressionEnabled": true,
    "optimizationType": null,
    "probePath": null,
    "geoFilters": [],
    "deliveryPolicy": {
      "description": "Test description for a policy.",
      "rules": [
        {
          "name": "rule1",
          "order": 1,
          "conditions": [
            {
              "name": "RemoteAddress",
              "parameters": {
                "typeName": "DeliveryRuleRemoteAddressConditionParameters",
                "operator": "IPMatch",
                "negateCondition": true,
                "matchValues": [
                  "192.168.1.0/24",
                  "10.0.0.0/24"
                ],
                "transforms": []
              }
            }
          ],
          "actions": [
            {
              "name": "CacheExpiration",
              "parameters": {
                "typeName": "DeliveryRuleCacheExpirationActionParameters",
                "cacheBehavior": "Override",
                "cacheDuration": "10:10:09",
                "cacheType": "All"
              }
            },
            {
              "name": "ModifyResponseHeader",
              "parameters": {
                "typeName": "DeliveryRuleHeaderActionParameters",
                "headerAction": "Overwrite",
                "headerName": "Access-Control-Allow-Origin",
                "value": "*"
              }
            },
            {
              "name": "ModifyRequestHeader",
              "parameters": {
                "typeName": "DeliveryRuleHeaderActionParameters",
                "headerAction": "Overwrite",
                "headerName": "Accept-Encoding",
                "value": "gzip"
              }
            }
          ]
        }
      ]
    }
  }
}

状态代码:: 201

{
  "name": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint4899.azureedge-test.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "BypassCaching",
    "originPath": "/photos",
    "defaultOriginGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
    },
    "origins": [
      {
        "name": "origin1",
        "properties": {
          "hostName": "www.someDomain1.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain1.net",
          "priority": 1,
          "weight": 50,
          "enabled": true
        }
      },
      {
        "name": "origin2",
        "properties": {
          "hostName": "www.someDomain2.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain2.net",
          "priority": 2,
          "weight": 50,
          "enabled": true
        }
      }
    ],
    "originGroups": [
      {
        "name": "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/origin1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
            }
          ],
          "responseBasedOriginErrorDetectionSettings": {
            "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
            "responseBasedFailoverThresholdPercentage": 10
          }
        }
      }
    ],
    "contentTypesToCompress": [
      "text/html",
      "application/octet-stream"
    ],
    "isCompressionEnabled": true,
    "optimizationType": null,
    "probePath": null,
    "geoFilters": [],
    "deliveryPolicy": {
      "description": "Test description for a policy.",
      "rules": [
        {
          "name": "rule1",
          "order": 1,
          "conditions": [
            {
              "name": "RemoteAddress",
              "parameters": {
                "typeName": "DeliveryRuleRemoteAddressConditionParameters",
                "operator": "IPMatch",
                "negateCondition": true,
                "matchValues": [
                  "192.168.1.0/24",
                  "10.0.0.0/24"
                ],
                "transforms": []
              }
            }
          ],
          "actions": [
            {
              "name": "CacheExpiration",
              "parameters": {
                "typeName": "DeliveryRuleCacheExpirationActionParameters",
                "cacheBehavior": "Override",
                "cacheDuration": "10:10:09",
                "cacheType": "All"
              }
            },
            {
              "name": "ModifyResponseHeader",
              "parameters": {
                "typeName": "DeliveryRuleHeaderActionParameters",
                "headerAction": "Overwrite",
                "headerName": "Access-Control-Allow-Origin",
                "value": "*"
              }
            },
            {
              "name": "ModifyRequestHeader",
              "parameters": {
                "typeName": "DeliveryRuleHeaderActionParameters",
                "headerAction": "Overwrite",
                "headerName": "Accept-Encoding",
                "value": "gzip"
              }
            }
          ]
        }
      ]
    }
  }
}

状态代码:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-04-15

{
  "name": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint4899.azureedge-test.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "BypassCaching",
    "originPath": "/photos",
    "defaultOriginGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
    },
    "origins": [
      {
        "name": "origin1",
        "properties": {
          "hostName": "www.someDomain1.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain1.net",
          "priority": 1,
          "weight": 50,
          "enabled": true
        }
      },
      {
        "name": "origin2",
        "properties": {
          "hostName": "www.someDomain2.net",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain2.net",
          "priority": 2,
          "weight": 50,
          "enabled": true
        }
      }
    ],
    "originGroups": [
      {
        "name": "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/origin1"
            },
            {
              "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2"
            }
          ],
          "responseBasedOriginErrorDetectionSettings": {
            "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
            "responseBasedFailoverThresholdPercentage": 10
          }
        }
      }
    ],
    "contentTypesToCompress": [
      "text/html",
      "application/octet-stream"
    ],
    "isCompressionEnabled": true,
    "optimizationType": null,
    "probePath": null,
    "geoFilters": [],
    "deliveryPolicy": {
      "description": "Test description for a policy.",
      "rules": [
        {
          "name": "rule1",
          "order": 1,
          "conditions": [
            {
              "name": "RemoteAddress",
              "parameters": {
                "typeName": "DeliveryRuleRemoteAddressConditionParameters",
                "operator": "IPMatch",
                "negateCondition": true,
                "matchValues": [
                  "192.168.1.0/24",
                  "10.0.0.0/24"
                ],
                "transforms": []
              }
            }
          ],
          "actions": [
            {
              "name": "CacheExpiration",
              "parameters": {
                "typeName": "DeliveryRuleCacheExpirationActionParameters",
                "cacheBehavior": "Override",
                "cacheDuration": "10:10:09",
                "cacheType": "All"
              }
            },
            {
              "name": "ModifyResponseHeader",
              "parameters": {
                "typeName": "DeliveryRuleHeaderActionParameters",
                "headerAction": "Overwrite",
                "headerName": "Access-Control-Allow-Origin",
                "value": "*"
              }
            },
            {
              "name": "ModifyRequestHeader",
              "parameters": {
                "typeName": "DeliveryRuleHeaderActionParameters",
                "headerAction": "Overwrite",
                "headerName": "Accept-Encoding",
                "value": "gzip"
              }
            }
          ]
        }
      ]
    }
  }
}

定义

名称	说明
algorithm	用于 URL 签名的算法
cacheBehavior	请求的缓存行为
CacheConfiguration	缓存类型路由的缓存设置。若要禁用缓存，请不要提供 cacheConfiguration 对象。
CacheExpirationActionParameters	定义缓存过期作的参数。
CacheKeyQueryStringActionParameters	定义缓存键查询字符串作的参数。
CacheType	需要缓存内容的级别。
ClientPortMatchConditionParameters	定义 ClientPort 匹配条件的参数
ClientPortOperator	描述要匹配的运算符
CookiesMatchConditionParameters	定义 Cookie 匹配条件的参数
CookiesOperator	描述要匹配的运算符
createdByType	创建资源的标识的类型。
DeepCreatedCustomDomain	在 CDN 终结点上创建的自定义域。
DeepCreatedOrigin	创建 CDN 终结点时添加的 CDN 内容的主要来源。
DeepCreatedOriginGroup	创建 CDN 终结点时添加的 CDN 内容的源组。流量根据源运行状况发送到源组中的源。
DeliveryPolicy	一个策略，指定要用于终结点的传递规则。
DeliveryRule	指定一组作和条件的规则
DeliveryRuleCacheExpirationAction	定义传递规则的缓存过期作。
DeliveryRuleCacheKeyQueryStringAction	定义传递规则的缓存键查询字符串作。
DeliveryRuleClientPortCondition	定义传递规则的 ClientPort 条件。
DeliveryRuleCookiesCondition	定义传递规则的 Cookie 条件。
DeliveryRuleHostNameCondition	定义传递规则的 HostName 条件。
DeliveryRuleHttpVersionCondition	定义传递规则的 HttpVersion 条件。
DeliveryRuleIsDeviceCondition	定义传递规则的 IsDevice 条件。
DeliveryRulePostArgsCondition	定义传递规则的 PostArgs 条件。
DeliveryRuleQueryStringCondition	定义传递规则的 QueryString 条件。
DeliveryRuleRemoteAddressCondition	定义传递规则的 RemoteAddress 条件。
DeliveryRuleRequestBodyCondition	定义传递规则的 RequestBody 条件。
DeliveryRuleRequestHeaderAction	定义传递规则的请求标头作。
DeliveryRuleRequestHeaderCondition	定义传递规则的 RequestHeader 条件。
DeliveryRuleRequestMethodCondition	定义传递规则的 RequestMethod 条件。
DeliveryRuleRequestSchemeCondition	定义传递规则的 RequestScheme 条件。
DeliveryRuleRequestUriCondition	定义传递规则的 RequestUri 条件。
DeliveryRuleResponseHeaderAction	定义传递规则的响应标头作。
DeliveryRuleRouteConfigurationOverrideAction	定义传递规则的路由配置替代作。仅适用于 Frontdoor 标准/高级配置文件。
DeliveryRuleServerPortCondition	定义传递规则的 ServerPort 条件。
DeliveryRuleSocketAddrCondition	定义传递规则的 SocketAddress 条件。
DeliveryRuleSslProtocolCondition	定义传递规则的 SslProtocol 条件。
DeliveryRuleUrlFileExtensionCondition	定义传递规则的 UrlFileExtension 条件。
DeliveryRuleUrlFileNameCondition	定义传递规则的 UrlFileName 条件。
DeliveryRuleUrlPathCondition	定义传递规则的 UrlPath 条件。
DestinationProtocol	要用于重定向的协议。默认值为 MatchRequest
Endpoint	CDN 终结点是 CDN 配置文件中的实体，其中包含配置信息，例如源、协议、内容缓存和传递行为。 CDN 终结点使用 URL 格式 .azureedge.net。
EndpointProvisioningState	终结点的预配状态。
EndpointResourceState	终结点的资源状态。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ForwardingProtocol	将流量转发到后端时，此规则将使用协议。
GeoFilter	定义 CDN 终结点中用户异地访问的规则。
GeoFilterActions	地理筛选器的作，即允许或阻止访问。
HeaderAction	要执行的操作
HeaderActionParameters	定义请求标头作的参数。
HealthProbeParameters	包含将运行状况探测发送到源的属性的 JSON 对象。
HealthProbeRequestType	发出的运行状况探测请求的类型。
HostNameMatchConditionParameters	定义 HostName 匹配条件的参数
HostNameOperator	描述要匹配的运算符
HttpErrorRangeParameters	表示 http 状态代码范围的 JSON 对象
HttpVersionMatchConditionParameters	定义 HttpVersion 匹配条件的参数
HttpVersionOperator	描述要匹配的运算符
IsDeviceMatchConditionParameters	定义 IsDevice 匹配条件的参数
IsDeviceMatchValue	传递规则条件的匹配值
IsDeviceOperator	描述要匹配的运算符
KeyVaultSigningKeyParameters	描述使用用户的 KeyVault 进行 URL 签名密钥的参数。
KeyVaultSigningKeyParametersType
OptimizationType	指定客户希望此 CDN 终结点优化的方案，例如下载媒体服务。利用此信息，我们可以应用方案驱动的优化。
OriginGroupOverride	定义源组重写配置的参数。
OriginGroupOverrideAction	定义传递规则的源组替代作。
OriginGroupOverrideActionParameters	定义源组重写作的参数。
paramIndicator	指示参数的用途
PostArgsMatchConditionParameters	定义 PostArgs 匹配条件的参数
PostArgsOperator	描述要匹配的运算符
PrivateEndpointStatus	连接到专用链接的审批状态
ProbeProtocol	用于运行状况探测的协议。
queryStringBehavior	请求的缓存行为
QueryStringCachingBehavior	定义 CDN 如何缓存包含查询字符串的请求。缓存时，可以忽略任何查询字符串，绕过缓存，以防止包含查询字符串的请求被缓存，或缓存每个请求的唯一 URL。
QueryStringMatchConditionParameters	定义 QueryString 匹配条件的参数
QueryStringOperator	描述要匹配的运算符
RedirectType	重定向流量时规则将使用的重定向类型。
RemoteAddressMatchConditionParameters	定义 RemoteAddress 匹配条件的参数
RemoteAddressOperator	描述要匹配的运算符
RequestBodyMatchConditionParameters	定义 RequestBody 匹配条件的参数
RequestBodyOperator	描述要匹配的运算符
RequestHeaderMatchConditionParameters	定义 RequestHeader 匹配条件的参数
RequestHeaderOperator	描述要匹配的运算符
RequestMethodMatchConditionParameters	定义 RequestMethod 匹配条件的参数
RequestMethodMatchValue	传递规则条件的匹配值
RequestMethodOperator	描述要匹配的运算符
RequestSchemeMatchConditionParameters	定义 RequestScheme 匹配条件的参数
RequestSchemeMatchValue	传递规则条件的匹配值
RequestUriMatchConditionParameters	定义 RequestUri 匹配条件的参数
RequestUriOperator	描述要匹配的运算符
ResourceReference	对另一个资源的引用。
ResponseBasedDetectedErrorTypes	实际用户请求的响应错误类型，其中源被视为不正常
ResponseBasedOriginErrorDetectionParameters	包含用于使用实际请求/响应确定源运行状况的属性的 JSON 对象。
RouteConfigurationOverrideActionParameters	定义路由配置替代作的参数。
ruleCacheBehavior	请求的缓存行为
ruleIsCompressionEnabled	指示是否启用内容压缩。如果启用了压缩，则如果用户请求压缩版本，内容将作为压缩。当请求的内容小于 1 字节或大于 1 MB 时，不会在 AzureFrontDoor 上压缩内容。
ruleQueryStringCachingBehavior	定义 Frontdoor 如何缓存包含查询字符串的请求。缓存、忽略特定查询字符串、使用唯一 URL 缓存每个请求或缓存特定查询字符串时，可以忽略任何查询字符串。
ServerPortMatchConditionParameters	定义 ServerPort 匹配条件的参数
ServerPortOperator	描述要匹配的运算符
SocketAddrMatchConditionParameters	定义 SocketAddress 匹配条件的参数
SocketAddrOperator	描述要匹配的运算符
SslProtocol	已建立的 TLS 连接的协议。
SslProtocolMatchConditionParameters	定义 SslProtocol 匹配条件的参数
SslProtocolOperator	描述要匹配的运算符
systemData	与创建和上次修改资源相关的元数据。
transform	描述在匹配之前应用了哪些转换
UrlFileExtensionMatchConditionParameters	定义 UrlFileExtension 匹配条件的参数
UrlFileExtensionOperator	描述要匹配的运算符
UrlFileNameMatchConditionParameters	定义 UrlFilename 匹配条件的参数
UrlFileNameOperator	描述要匹配的运算符
UrlPathMatchConditionParameters	定义 UrlPath 匹配条件的参数
UrlPathOperator	描述要匹配的运算符
UrlRedirectAction	定义传递规则的 URL 重定向作。
UrlRedirectActionParameters	定义 URL 重定向作的参数。
UrlRewriteAction	定义传递规则的 URL 重写作。
UrlRewriteActionParameters	定义 URL 重写作的参数。
UrlSigningAction	定义传递规则的 URL 签名作。
UrlSigningActionParameters	定义 URL 签名作的参数。
UrlSigningKey	URL 签名密钥
UrlSigningParamIdentifier	定义如何标识特定用途的参数，例如过期
WebApplicationFirewallPolicyLink	定义终结点的 Web 应用程序防火墙策略（如果适用）

algorithm

枚举

用于 URL 签名的算法

值	说明
SHA256

cacheBehavior

枚举

请求的缓存行为

值	说明
BypassCache
Override
SetIfMissing

CacheConfiguration

Object

缓存类型路由的缓存设置。若要禁用缓存，请不要提供 cacheConfiguration 对象。

名称	类型	说明
cacheBehavior	ruleCacheBehavior	请求的缓存行为
cacheDuration	string	需要缓存内容的持续时间。允许的格式为 [d.]hh：mm：ss
isCompressionEnabled	ruleIsCompressionEnabled	指示是否启用内容压缩。如果启用了压缩，则如果用户请求压缩版本，内容将作为压缩。当请求的内容小于 1 字节或大于 1 MB 时，不会在 AzureFrontDoor 上压缩内容。
queryParameters	string	要包含或排除的查询参数（逗号分隔）。
queryStringCachingBehavior	ruleQueryStringCachingBehavior	定义 Frontdoor 如何缓存包含查询字符串的请求。缓存、忽略特定查询字符串、使用唯一 URL 缓存每个请求或缓存特定查询字符串时，可以忽略任何查询字符串。

CacheExpirationActionParameters

Object

定义缓存过期作的参数。

名称	类型	说明
cacheBehavior	cacheBehavior	请求的缓存行为
cacheDuration	string	需要缓存内容的持续时间。允许的格式为 [d.]hh：mm：ss
cacheType	CacheType	需要缓存内容的级别。
typeName	string: DeliveryRuleCacheExpirationActionParameters

CacheKeyQueryStringActionParameters

Object

定义缓存键查询字符串作的参数。

名称	类型	说明
queryParameters	string	要包含或排除的查询参数（逗号分隔）。
queryStringBehavior	queryStringBehavior	请求的缓存行为
typeName	string: DeliveryRuleCacheKeyQueryStringBehaviorActionParameters

CacheType

枚举

需要缓存内容的级别。

值	说明
All

ClientPortMatchConditionParameters

Object

定义 ClientPort 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	ClientPortOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleClientPortConditionParameters

ClientPortOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

CookiesMatchConditionParameters

Object

定义 Cookie 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	CookiesOperator		描述要匹配的运算符
selector	string		要匹配的 Cookie 的名称
transforms	transform[]		转换列表
typeName	string: DeliveryRuleCookiesConditionParameters

CookiesOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DeepCreatedCustomDomain

Object

在 CDN 终结点上创建的自定义域。

名称	类型	说明
name	string	自定义域名。
properties.hostName	string	自定义域的主机名。必须是域名。
properties.validationData	string	由于本地符合性原因，将 CDN 传送到某些区域时，可能需要特殊验证或数据。例如，需要自定义域的 ICP 许可证号才能在中国交付内容。

DeepCreatedOrigin

Object

创建 CDN 终结点时添加的 CDN 内容的主要来源。

名称	类型	说明
name	string	终结点中必须唯一的源名称。
properties.enabled	boolean	为负载均衡启用源。默认情况下，始终启用源。
properties.hostName	string	源的地址。它可以是域名、IPv4 地址或 IPv6 地址。这应该在终结点中的所有源中是唯一的。
properties.httpPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	HTTP 端口的值。必须介于 1 到 65535 之间。
properties.httpsPort	integer (int32) minimum: 1 maximum: 65535 exclusiveMinimum: False exclusiveMaximum: False	HTTPS 端口的值。必须介于 1 到 65535 之间。
properties.originHostHeader	string	随每个请求发送到源的主机标头值。如果将此保留为空，则请求主机名将确定此值。默认情况下，Azure CDN 源（例如 Web 应用、Blob 存储和云服务）要求此主机标头值与源主机名匹配。
properties.priority	integer (int32) minimum: 1 maximum: 5	给定源组中用于负载均衡的源优先级。如果优先级较低的源正常，则不会使用更高的优先级进行负载均衡。必须介于 1 和 5 之间。
properties.privateEndpointStatus	PrivateEndpointStatus	连接到专用链接的审批状态
properties.privateLinkAlias	string	专用链接资源的别名。填充此可选字段表示此源为“Private”
properties.privateLinkApprovalMessage	string	要包含在审批请求中以连接到专用链接的自定义消息。
properties.privateLinkLocation	string	专用链接资源的位置。仅当填充了“privateLinkResourceId”时才是必需的
properties.privateLinkResourceId	string	专用链接资源的资源 ID。填充此可选字段表示此后端为“专用”
properties.weight	integer (int32) minimum: 1 maximum: 1000	给定源组中用于负载均衡的源的权重。必须介于 1 到 1000 之间

DeepCreatedOriginGroup

Object

创建 CDN 终结点时添加的 CDN 内容的源组。流量根据源运行状况发送到源组中的源。

名称	类型	说明
name	string	终结点中必须唯一的源组名称。
properties.healthProbeSettings	HealthProbeParameters	用于确定源运行状况的源的运行状况探测设置。
properties.origins	ResourceReference[]	通过给定源组中的 CDN 传递的内容的源。
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	包含用于使用实际请求/响应确定源运行状况的属性的 JSON 对象。目前不支持此属性。
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer (int32) minimum: 0 maximum: 50	当运行不正常的终结点或添加新终结点时，将流量逐渐转移到终结点的时间（以分钟为单位）。默认值为 10 分钟。目前不支持此属性。

DeliveryPolicy

Object

一个策略，指定要用于终结点的传递规则。

名称	类型	说明
description	string	策略的用户友好说明。
rules	DeliveryRule[]	传递规则的列表。

DeliveryRule

Object

指定一组作和条件的规则

名称	类型	说明
actions	DeliveryRuleAction[]: DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleRouteConfigurationOverrideAction[] OriginGroupOverrideAction[] UrlRedirectAction[] UrlRewriteAction[] UrlSigningAction[]	满足规则的所有条件时执行的作列表。
conditions	DeliveryRuleCondition[]: DeliveryRuleClientPortCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleQueryStringCondition[] DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleSslProtocolCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleUrlPathCondition[]	必须为要执行的作匹配的条件列表
name	string	规则的名称
order	integer (int32)	为终结点应用规则的顺序。可能的值 {0,1,2,3,.........}。具有较低顺序的规则将在具有较大顺序的规则之前应用。具有顺序 0 的规则是一个特殊规则。它不需要任何条件，并且它中列出的作将始终应用。

DeliveryRuleCacheExpirationAction

Object

定义传递规则的缓存过期作。

名称	类型	说明
name	string: CacheExpiration	传递规则的作的名称。
parameters	CacheExpirationActionParameters	定义作的参数。

DeliveryRuleCacheKeyQueryStringAction

Object

定义传递规则的缓存键查询字符串作。

名称	类型	说明
name	string: CacheKeyQueryString	传递规则的作的名称。
parameters	CacheKeyQueryStringActionParameters	定义作的参数。

DeliveryRuleClientPortCondition

Object

定义传递规则的 ClientPort 条件。

名称	类型	说明
name	string: ClientPort	传递规则的条件的名称。
parameters	ClientPortMatchConditionParameters	定义条件的参数。

DeliveryRuleCookiesCondition

Object

定义传递规则的 Cookie 条件。

名称	类型	说明
name	string: Cookies	传递规则的条件的名称。
parameters	CookiesMatchConditionParameters	定义条件的参数。

DeliveryRuleHostNameCondition

Object

定义传递规则的 HostName 条件。

名称	类型	说明
name	string: HostName	传递规则的条件的名称。
parameters	HostNameMatchConditionParameters	定义条件的参数。

DeliveryRuleHttpVersionCondition

Object

定义传递规则的 HttpVersion 条件。

名称	类型	说明
name	string: HttpVersion	传递规则的条件的名称。
parameters	HttpVersionMatchConditionParameters	定义条件的参数。

DeliveryRuleIsDeviceCondition

Object

定义传递规则的 IsDevice 条件。

名称	类型	说明
name	string: IsDevice	传递规则的条件的名称。
parameters	IsDeviceMatchConditionParameters	定义条件的参数。

DeliveryRulePostArgsCondition

Object

定义传递规则的 PostArgs 条件。

名称	类型	说明
name	string: PostArgs	传递规则的条件的名称。
parameters	PostArgsMatchConditionParameters	定义条件的参数。

DeliveryRuleQueryStringCondition

Object

定义传递规则的 QueryString 条件。

名称	类型	说明
name	string: QueryString	传递规则的条件的名称。
parameters	QueryStringMatchConditionParameters	定义条件的参数。

DeliveryRuleRemoteAddressCondition

Object

定义传递规则的 RemoteAddress 条件。

名称	类型	说明
name	string: RemoteAddress	传递规则的条件的名称。
parameters	RemoteAddressMatchConditionParameters	定义条件的参数。

DeliveryRuleRequestBodyCondition

Object

定义传递规则的 RequestBody 条件。

名称	类型	说明
name	string: RequestBody	传递规则的条件的名称。
parameters	RequestBodyMatchConditionParameters	定义条件的参数。

DeliveryRuleRequestHeaderAction

Object

定义传递规则的请求标头作。

名称	类型	说明
name	string: ModifyRequestHeader	传递规则的作的名称。
parameters	HeaderActionParameters	定义作的参数。

DeliveryRuleRequestHeaderCondition

Object

定义传递规则的 RequestHeader 条件。

名称	类型	说明
name	string: RequestHeader	传递规则的条件的名称。
parameters	RequestHeaderMatchConditionParameters	定义条件的参数。

DeliveryRuleRequestMethodCondition

Object

定义传递规则的 RequestMethod 条件。

名称	类型	说明
name	string: RequestMethod	传递规则的条件的名称。
parameters	RequestMethodMatchConditionParameters	定义条件的参数。

DeliveryRuleRequestSchemeCondition

Object

定义传递规则的 RequestScheme 条件。

名称	类型	说明
name	string: RequestScheme	传递规则的条件的名称。
parameters	RequestSchemeMatchConditionParameters	定义条件的参数。

DeliveryRuleRequestUriCondition

Object

定义传递规则的 RequestUri 条件。

名称	类型	说明
name	string: RequestUri	传递规则的条件的名称。
parameters	RequestUriMatchConditionParameters	定义条件的参数。

DeliveryRuleResponseHeaderAction

Object

定义传递规则的响应标头作。

名称	类型	说明
name	string: ModifyResponseHeader	传递规则的作的名称。
parameters	HeaderActionParameters	定义作的参数。

DeliveryRuleRouteConfigurationOverrideAction

Object

定义传递规则的路由配置替代作。仅适用于 Frontdoor 标准/高级配置文件。

名称	类型	说明
name	string: RouteConfigurationOverride	传递规则的作的名称。
parameters	RouteConfigurationOverrideActionParameters	定义作的参数。

DeliveryRuleServerPortCondition

Object

定义传递规则的 ServerPort 条件。

名称	类型	说明
name	string: ServerPort	传递规则的条件的名称。
parameters	ServerPortMatchConditionParameters	定义条件的参数。

DeliveryRuleSocketAddrCondition

Object

定义传递规则的 SocketAddress 条件。

名称	类型	说明
name	string: SocketAddr	传递规则的条件的名称。
parameters	SocketAddrMatchConditionParameters	定义条件的参数。

DeliveryRuleSslProtocolCondition

Object

定义传递规则的 SslProtocol 条件。

名称	类型	说明
name	string: SslProtocol	传递规则的条件的名称。
parameters	SslProtocolMatchConditionParameters	定义条件的参数。

DeliveryRuleUrlFileExtensionCondition

Object

定义传递规则的 UrlFileExtension 条件。

名称	类型	说明
name	string: UrlFileExtension	传递规则的条件的名称。
parameters	UrlFileExtensionMatchConditionParameters	定义条件的参数。

DeliveryRuleUrlFileNameCondition

Object

定义传递规则的 UrlFileName 条件。

名称	类型	说明
name	string: UrlFileName	传递规则的条件的名称。
parameters	UrlFileNameMatchConditionParameters	定义条件的参数。

DeliveryRuleUrlPathCondition

Object

定义传递规则的 UrlPath 条件。

名称	类型	说明
name	string: UrlPath	传递规则的条件的名称。
parameters	UrlPathMatchConditionParameters	定义条件的参数。

DestinationProtocol

枚举

要用于重定向的协议。默认值为 MatchRequest

值	说明
Http
Https
MatchRequest

Endpoint

Object

CDN 终结点是 CDN 配置文件中的实体，其中包含配置信息，例如源、协议、内容缓存和传递行为。 CDN 终结点使用 URL 格式 .azureedge.net。

名称	类型	默认值	说明
id	string (arm-id)		资源的完全限定资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string		资源所在的地理位置
name	string		资源的名称
properties.contentTypesToCompress	string[]		要对其应用压缩的内容类型的列表。该值应为有效的 MIME 类型。
properties.customDomains	DeepCreatedCustomDomain[]		终结点下的自定义域。
properties.defaultOriginGroup	ResourceReference		对源组的引用。
properties.deliveryPolicy	DeliveryPolicy		一个策略，指定要用于终结点的传递规则。
properties.geoFilters	GeoFilter[]		定义 CDN 终结点中用户异地访问的规则列表。每个地理筛选器定义对指定路径或内容的访问规则，例如阻止路径 /pictures/
properties.hostName	string		结构化为 {endpointName} 的终结点的主机名。{DNSZone}，例如 contoso.azureedge.net
properties.isCompressionEnabled	boolean		指示是否在 CDN 上启用内容压缩。默认值为 false。如果启用了压缩，则如果用户请求压缩版本，内容将作为压缩。当请求的内容小于 1 字节或大于 1 MB 时，不会在 CDN 上压缩内容。
properties.isHttpAllowed	boolean	True	指示是否允许终结点上的 HTTP 流量。默认值为 true。必须至少允许一个协议（HTTP 或 HTTPS）。
properties.isHttpsAllowed	boolean	True	指示是否允许终结点上的 HTTPS 流量。默认值为 true。必须至少允许一个协议（HTTP 或 HTTPS）。
properties.optimizationType	OptimizationType		指定客户希望此 CDN 终结点针对哪些方案进行优化，例如下载媒体服务。利用此信息，CDN 可以应用方案驱动的优化。
properties.originGroups	DeepCreatedOriginGroup[]		源组由用于基于可用性对流量进行负载均衡的源组。
properties.originHostHeader	string		随每个请求发送到源的主机标头值。仅当终结点使用单一源并且可由源中指定的同一属性重写时，才允许终结点中的此属性。如果将此保留为空，则请求主机名将确定此值。默认情况下，Azure CDN 源（例如 Web 应用、Blob 存储和云服务）要求此主机标头值与源主机名匹配。
properties.originPath	string		CDN 可用于从中检索内容的源上的目录路径，例如 contoso.cloudapp.net/originpath。
properties.origins	DeepCreatedOrigin[]		通过 CDN 传递的内容源。
properties.probePath	string		源上托管的文件的路径，有助于加速动态内容的交付，并计算 CDN 的最佳路由。这与源路径相对。此属性仅在使用单个源时相关。
properties.provisioningState	EndpointProvisioningState		终结点的预配状态。
properties.queryStringCachingBehavior	QueryStringCachingBehavior	NotSet	定义 CDN 如何缓存包含查询字符串的请求。缓存时，可以忽略任何查询字符串，绕过缓存，以防止包含查询字符串的请求被缓存，或缓存每个请求的唯一 URL。
properties.resourceState	EndpointResourceState		终结点的资源状态。
properties.urlSigningKeys	UrlSigningKey[]		用于验证已签名 URL 哈希的密钥列表。
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink		定义终结点的 Web 应用程序防火墙策略（如果适用）
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源标记。
type	string		资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

EndpointProvisioningState

枚举

终结点的预配状态。

值	说明
Creating
Deleting
Failed
Succeeded
Updating

EndpointResourceState

枚举

终结点的资源状态。

值	说明
Creating
Deleting
Running
Starting
Stopped
Stopping

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ForwardingProtocol

枚举

将流量转发到后端时，此规则将使用协议。

值	说明
HttpOnly
HttpsOnly
MatchRequest

GeoFilter

Object

定义 CDN 终结点中用户异地访问的规则。

名称	类型	说明
action	GeoFilterActions	地理筛选器的作，即允许或阻止访问。
countryCodes	string[]	在地理筛选器（例如 AU、MX、US）中定义用户国家或地区访问权限的两个字母国家或地区代码。
relativePath	string	适用于地理筛选器的相对路径。（例如“/mypictures”、“/mypicture/kitty.jpg”等）

GeoFilterActions

枚举

地理筛选器的作，即允许或阻止访问。

值	说明
Allow
Block

HeaderAction

枚举

要执行的操作

值	说明
Append
Delete
Overwrite

HeaderActionParameters

Object

定义请求标头作的参数。

名称	类型	说明
headerAction	HeaderAction	要执行的操作
headerName	string	要修改的标头的名称
typeName	string: DeliveryRuleHeaderActionParameters
value	string	指定作的值

HealthProbeParameters

Object

包含将运行状况探测发送到源的属性的 JSON 对象。

名称	类型	说明
probeIntervalInSeconds	integer (int32) minimum: 1 maximum: 255	运行状况探测之间的秒数。默认值为 240sec。
probePath	string	相对于用于确定源运行状况的源的路径。
probeProtocol	ProbeProtocol	用于运行状况探测的协议。
probeRequestType	HealthProbeRequestType	发出的运行状况探测请求的类型。

HealthProbeRequestType

枚举

发出的运行状况探测请求的类型。

值	说明
GET
HEAD
NotSet

HostNameMatchConditionParameters

Object

定义 HostName 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	HostNameOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleHostNameConditionParameters

HostNameOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

HttpErrorRangeParameters

Object

表示 http 状态代码范围的 JSON 对象

名称	类型	说明
begin	integer (int32) minimum: 100 maximum: 999	http 状态代码范围的非独占开头。
end	integer (int32) minimum: 100 maximum: 999	http 状态代码范围的非独占结束。

HttpVersionMatchConditionParameters

Object

定义 HttpVersion 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	HttpVersionOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleHttpVersionConditionParameters

HttpVersionOperator

枚举

描述要匹配的运算符

值	说明
Equal

IsDeviceMatchConditionParameters

Object

定义 IsDevice 匹配条件的参数

名称	类型	默认值	说明
matchValues	IsDeviceMatchValue[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	IsDeviceOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleIsDeviceConditionParameters

IsDeviceMatchValue

枚举

传递规则条件的匹配值

值	说明
Desktop
Mobile

IsDeviceOperator

枚举

描述要匹配的运算符

值	说明
Equal

KeyVaultSigningKeyParameters

Object

描述使用用户的 KeyVault 进行 URL 签名密钥的参数。

名称	类型	说明
resourceGroupName	string	包含机密的用户 Key Vault 的资源组
secretName	string	Key Vault 中的机密名称。
secretVersion	string	Key Vault 中机密的版本（GUID）。
subscriptionId	string	包含机密的用户 Key Vault 的订阅 ID
typeName	KeyVaultSigningKeyParametersType
vaultName	string	包含机密的用户 Key Vault 的名称

KeyVaultSigningKeyParametersType

枚举

值	说明
KeyVaultSigningKeyParameters

OptimizationType

枚举

指定客户希望此 CDN 终结点优化的方案，例如下载媒体服务。利用此信息，我们可以应用方案驱动的优化。

值	说明
DynamicSiteAcceleration
GeneralMediaStreaming
GeneralWebDelivery
LargeFileDownload
VideoOnDemandMediaStreaming

OriginGroupOverride

Object

定义源组重写配置的参数。

名称	类型	说明
forwardingProtocol	ForwardingProtocol	将流量转发到后端时，此规则将使用协议。
originGroup	ResourceReference	定义将在路由上重写 DefaultOriginGroup 的 OriginGroup。

OriginGroupOverrideAction

Object

定义传递规则的源组替代作。

名称	类型	说明
name	string: OriginGroupOverride	传递规则的作的名称。
parameters	OriginGroupOverrideActionParameters	定义作的参数。

OriginGroupOverrideActionParameters

Object

定义源组重写作的参数。

名称	类型	说明
originGroup	ResourceReference	定义将替代 DefaultOriginGroup 的 OriginGroup。
typeName	string: DeliveryRuleOriginGroupOverrideActionParameters

paramIndicator

枚举

指示参数的用途

值	说明
Expires
KeyId
Signature

PostArgsMatchConditionParameters

Object

定义 PostArgs 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	PostArgsOperator		描述要匹配的运算符
selector	string		要匹配的 PostArg 的名称
transforms	transform[]		转换列表
typeName	string: DeliveryRulePostArgsConditionParameters

PostArgsOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

PrivateEndpointStatus

枚举

连接到专用链接的审批状态

值	说明
Approved
Disconnected
Pending
Rejected
Timeout

ProbeProtocol

枚举

用于运行状况探测的协议。

值	说明
Http
Https
NotSet

queryStringBehavior

枚举

请求的缓存行为

值	说明
Exclude
ExcludeAll
Include
IncludeAll

QueryStringCachingBehavior

枚举

定义 CDN 如何缓存包含查询字符串的请求。缓存时，可以忽略任何查询字符串，绕过缓存，以防止包含查询字符串的请求被缓存，或缓存每个请求的唯一 URL。

值	说明
BypassCaching
IgnoreQueryString
NotSet
UseQueryString

QueryStringMatchConditionParameters

Object

定义 QueryString 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	QueryStringOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleQueryStringConditionParameters

QueryStringOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

RedirectType

枚举

重定向流量时规则将使用的重定向类型。

值	说明
Found
Moved
PermanentRedirect
TemporaryRedirect

RemoteAddressMatchConditionParameters

Object

定义 RemoteAddress 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		匹配要匹配的值。运算符将应用于此处具有 OR 语义的每个值。如果其中任何一个匹配变量与给定运算符匹配，则此匹配条件被视为匹配。
negateCondition	boolean	False	描述这是否为否定条件
operator	RemoteAddressOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

枚举

描述要匹配的运算符

值	说明
Any
GeoMatch
IPMatch

RequestBodyMatchConditionParameters

Object

定义 RequestBody 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	RequestBodyOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleRequestBodyConditionParameters

RequestBodyOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

RequestHeaderMatchConditionParameters

Object

定义 RequestHeader 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	RequestHeaderOperator		描述要匹配的运算符
selector	string		要匹配的标头的名称
transforms	transform[]		转换列表
typeName	string: DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

RequestMethodMatchConditionParameters

Object

定义 RequestMethod 匹配条件的参数

名称	类型	默认值	说明
matchValues	RequestMethodMatchValue[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	RequestMethodOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleRequestMethodConditionParameters

RequestMethodMatchValue

枚举

传递规则条件的匹配值

值	说明
DELETE
GET
HEAD
OPTIONS
POST
PUT
TRACE

RequestMethodOperator

枚举

描述要匹配的运算符

值	说明
Equal

RequestSchemeMatchConditionParameters

Object

定义 RequestScheme 匹配条件的参数

名称	类型	默认值	说明
matchValues	RequestSchemeMatchValue[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	enum: Equal		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleRequestSchemeConditionParameters

RequestSchemeMatchValue

枚举

传递规则条件的匹配值

值	说明
HTTP
HTTPS

RequestUriMatchConditionParameters

Object

定义 RequestUri 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	RequestUriOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleRequestUriConditionParameters

RequestUriOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

ResourceReference

Object

对另一个资源的引用。

名称	类型	说明
id	string	资源 ID。

ResponseBasedDetectedErrorTypes

枚举

实际用户请求的响应错误类型，其中源被视为不正常

值	说明
None
TcpAndHttpErrors
TcpErrorsOnly

ResponseBasedOriginErrorDetectionParameters

Object

包含用于使用实际请求/响应确定源运行状况的属性的 JSON 对象。

名称	类型	说明
httpErrorRanges	HttpErrorRangeParameters[]	被视为源服务器错误的 Http 状态代码范围列表，并且标记为不正常。
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	实际用户请求的响应错误类型，其中源被视为不正常
responseBasedFailoverThresholdPercentage	integer (int32) minimum: 0 maximum: 100	故障转移应触发的示例中失败请求的百分比。

RouteConfigurationOverrideActionParameters

Object

定义路由配置替代作的参数。

名称	类型	说明
cacheConfiguration	CacheConfiguration	与此规则关联的缓存配置。若要禁用缓存，请不要提供 cacheConfiguration 对象。
originGroupOverride	OriginGroupOverride	对源组替代配置的引用。保留为空，以在路由上使用默认源组。
typeName	string: DeliveryRuleRouteConfigurationOverrideActionParameters

ruleCacheBehavior

枚举

请求的缓存行为

值	说明
HonorOrigin
OverrideAlways
OverrideIfOriginMissing

ruleIsCompressionEnabled

枚举

指示是否启用内容压缩。如果启用了压缩，则如果用户请求压缩版本，内容将作为压缩。当请求的内容小于 1 字节或大于 1 MB 时，不会在 AzureFrontDoor 上压缩内容。

值	说明
Disabled
Enabled

ruleQueryStringCachingBehavior

枚举

定义 Frontdoor 如何缓存包含查询字符串的请求。缓存、忽略特定查询字符串、使用唯一 URL 缓存每个请求或缓存特定查询字符串时，可以忽略任何查询字符串。

值	说明
IgnoreQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings
UseQueryString

ServerPortMatchConditionParameters

Object

定义 ServerPort 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	ServerPortOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleServerPortConditionParameters

ServerPortOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

SocketAddrMatchConditionParameters

Object

定义 SocketAddress 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	SocketAddrOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

枚举

描述要匹配的运算符

值	说明
Any
IPMatch

SslProtocol

枚举

已建立的 TLS 连接的协议。

值	说明
TLSv1
TLSv1.1
TLSv1.2

SslProtocolMatchConditionParameters

Object

定义 SslProtocol 匹配条件的参数

名称	类型	默认值	说明
matchValues	SslProtocol[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	SslProtocolOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleSslProtocolConditionParameters

SslProtocolOperator

枚举

描述要匹配的运算符

值	说明
Equal

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

transform

枚举

描述在匹配之前应用了哪些转换

值	说明
Lowercase
RemoveNulls
Trim
Uppercase
UrlDecode
UrlEncode

UrlFileExtensionMatchConditionParameters

Object

定义 UrlFileExtension 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	UrlFileExtensionOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleUrlFileExtensionMatchConditionParameters

UrlFileExtensionOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

UrlFileNameMatchConditionParameters

Object

定义 UrlFilename 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	UrlFileNameOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleUrlFilenameConditionParameters

UrlFileNameOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

UrlPathMatchConditionParameters

Object

定义 UrlPath 匹配条件的参数

名称	类型	默认值	说明
matchValues	string[]		传递规则条件的匹配值
negateCondition	boolean	False	描述这是否为否定条件
operator	UrlPathOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	string: DeliveryRuleUrlPathMatchConditionParameters

UrlPathOperator

枚举

描述要匹配的运算符

值	说明
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx
Wildcard

UrlRedirectAction

Object

定义传递规则的 URL 重定向作。

名称	类型	说明
name	string: UrlRedirect	传递规则的作的名称。
parameters	UrlRedirectActionParameters	定义作的参数。

UrlRedirectActionParameters

Object

定义 URL 重定向作的参数。

名称	类型	说明
customFragment	string	要添加到重定向 URL 的片段。片段是 #之后 URL 的一部分。请勿包含 #。
customHostname	string	要重定向的主机。将传入主机保留为空，以将传入主机用作目标主机。
customPath	string	要重定向的完整路径。路径不能为空，必须以 /开头。将传入路径保留为空，以用作目标路径。
customQueryString	string	要放置在重定向 URL 中的查询字符串集。设置此值将替换任何现有查询字符串;保留空以保留传入的查询字符串。查询字符串必须采用 = 格式。 ? 和 & 将自动添加，因此不要包含它们。
destinationProtocol	DestinationProtocol	要用于重定向的协议。默认值为 MatchRequest
redirectType	RedirectType	重定向流量时规则将使用的重定向类型。
typeName	string: DeliveryRuleUrlRedirectActionParameters

UrlRewriteAction

Object

定义传递规则的 URL 重写作。

名称	类型	说明
name	string: UrlRewrite	传递规则的作的名称。
parameters	UrlRewriteActionParameters	定义作的参数。

UrlRewriteActionParameters

Object

定义 URL 重写作的参数。

名称	类型	说明
destination	string	定义上述请求将重写的相对 URL。
preserveUnmatchedPath	boolean	是否保留不匹配的路径。默认值为 true。
sourcePattern	string	定义一个请求 URI 模式，该模式标识可能重写的请求类型。如果值为空，则匹配所有字符串。
typeName	string: DeliveryRuleUrlRewriteActionParameters

UrlSigningAction

Object

定义传递规则的 URL 签名作。

名称	类型	说明
name	string: UrlSigning	传递规则的作的名称。
parameters	UrlSigningActionParameters	定义作的参数。

UrlSigningActionParameters

Object

定义 URL 签名作的参数。

名称	类型	说明
algorithm	algorithm	用于 URL 签名的算法
parameterNameOverride	UrlSigningParamIdentifier[]	定义要考虑用于过期、密钥 ID 等的 URL 中的查询字符串参数。
typeName	string: DeliveryRuleUrlSigningActionParameters

UrlSigningKey

Object

URL 签名密钥

名称	类型	说明
keyId	string	定义客户定义的密钥 ID。传入请求中将存在此 ID，以指示用于形成哈希的键。
keySourceParameters	KeyVaultSigningKeyParameters	定义用于 Url 签名密钥的客户密钥保管库的参数。

UrlSigningParamIdentifier

Object

定义如何标识特定用途的参数，例如过期

名称	类型	说明
paramIndicator	paramIndicator	指示参数的用途
paramName	string	参数名称

WebApplicationFirewallPolicyLink

Object

定义终结点的 Web 应用程序防火墙策略（如果适用）

名称	类型	说明
id	string	资源 ID。

通过

Endpoints - Create

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Endpoints_Create

示例请求

示例响应

定义

algorithm

cacheBehavior

CacheConfiguration

CacheExpirationActionParameters

CacheKeyQueryStringActionParameters

CacheType

ClientPortMatchConditionParameters

ClientPortOperator

CookiesMatchConditionParameters

CookiesOperator

createdByType

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

EndpointProvisioningState

EndpointResourceState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

GeoFilter

GeoFilterActions

HeaderAction

HeaderActionParameters

HealthProbeParameters

HealthProbeRequestType

HostNameMatchConditionParameters

HostNameOperator

HttpErrorRangeParameters

HttpVersionMatchConditionParameters

HttpVersionOperator

IsDeviceMatchConditionParameters

IsDeviceMatchValue

IsDeviceOperator

KeyVaultSigningKeyParameters

KeyVaultSigningKeyParametersType

OptimizationType

OriginGroupOverride

OriginGroupOverrideAction