你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Endpoints - Create
在指定的订阅、资源组和配置文件下,使用指定的终结点名称创建新的 CDN 终结点。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}?api-version=2024-02-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
配置文件下全局唯一的终结点的名称。 |
profile
|
path | True |
string |
资源组中唯一的 CDN 配置文件的名称。 |
resource
|
path | True |
string |
Azure 订阅中资源组的名称。 正则表达式模式: |
subscription
|
path | True |
string |
Azure 订阅 ID。 |
api-version
|
query | True |
string |
要与客户端请求一起使用的 API 的版本。 当前版本为 2024-02-01。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
location | True |
string |
资源位置。 |
properties.origins | True |
通过 CDN 传递的内容的源。 |
|
properties.contentTypesToCompress |
string[] |
应用压缩的内容类型列表。 该值应为有效的 MIME 类型。 |
|
properties.defaultOriginGroup |
对源组的引用。 |
||
properties.deliveryPolicy |
指定要用于终结点的传递规则的策略。 |
||
properties.geoFilters |
定义 CDN 终结点中用户异地访问权限的规则列表。 每个地理筛选器定义对指定路径或内容的访问规则,例如阻止路径 /pictures/ 的 APAC |
||
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 |
指定客户希望此 CDN 终结点优化的方案,例如下载、媒体服务。 借助此信息,CDN 可以应用方案驱动的优化。 |
||
properties.originGroups |
源组,由用于基于可用性对流量进行负载均衡的源组组成。 |
||
properties.originHostHeader |
string |
随每个请求一起发送到源的主机标头值。 仅当终结点使用单个源并且可由源中指定的同一属性重写时,才允许在终结点处使用此属性。如果将此留空,则请求主机名将确定此值。 Azure CDN 源(例如 Web 应用、Blob 存储和云服务)默认要求此主机头值与源主机名匹配。 |
|
properties.originPath |
string |
源上的目录路径,CDN 可用于从中检索内容,例如 contoso.cloudapp.net/originpath。 |
|
properties.probePath |
string |
源上托管的文件的路径,它有助于加速动态内容的交付,并计算 CDN 的最佳路由。 这是相对于源路径的。 仅当使用单个源时,此属性才相关。 |
|
properties.queryStringCachingBehavior |
定义 CDN 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串,绕过缓存以防止缓存包含查询字符串的请求,或者使用唯一 URL 缓存每个请求。 |
||
properties.urlSigningKeys |
用于验证已签名 URL 哈希的密钥列表。 |
||
properties.webApplicationFirewallPolicyLink |
定义终结点 (的Web 应用程序防火墙策略(如果适用) |
||
tags |
object |
资源标记。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 请求已成功。 |
|
201 Created |
Created. 请求已满足,并已创建新的终结点。 |
|
202 Accepted |
接受,操作将以异步方式完成。 标头 location: string |
|
Other Status Codes |
描述操作失败原因的 CDN 错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Endpoints_Create
示例请求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1?api-version=2024-02-01
{
"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
}
}
}
]
}
}
示例响应
{
"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"
}
}
]
}
]
}
}
}
{
"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"
}
}
]
}
]
}
}
}
azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-01
{
"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 签名的算法
名称 | 类型 | 说明 |
---|---|---|
SHA256 |
string |
cacheBehavior
请求的缓存行为
名称 | 类型 | 说明 |
---|---|---|
BypassCache |
string |
|
Override |
string |
|
SetIfMissing |
string |
CacheConfiguration
缓存类型路由的缓存设置。 若要禁用缓存,请不要提供 cacheConfiguration 对象。
名称 | 类型 | 说明 |
---|---|---|
cacheBehavior |
请求的缓存行为 |
|
cacheDuration |
string |
需要缓存内容的持续时间。 允许的格式为 [d.]hh:mm:ss |
isCompressionEnabled |
指示是否启用内容压缩。 如果启用了压缩,当用户请求压缩版本时,内容将作为压缩内容提供。 当请求的内容小于 1 字节或大于 1 MB 时,不会在 AzureFrontDoor 上压缩内容。 |
|
queryParameters |
string |
要包含或排除 (逗号分隔) 的查询参数。 |
queryStringCachingBehavior |
定义 Frontdoor 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串、忽略特定查询字符串、使用唯一 URL 缓存每个请求或缓存特定的查询字符串。 |
CacheExpirationActionParameters
定义缓存过期操作的参数。
名称 | 类型 | 说明 |
---|---|---|
cacheBehavior |
请求的缓存行为 |
|
cacheDuration |
string |
需要缓存内容的持续时间。 允许的格式为 [d.]hh:mm:ss |
cacheType |
需要缓存内容的级别。 |
|
typeName |
enum:
Delivery |
CacheKeyQueryStringActionParameters
定义缓存键查询字符串操作的参数。
名称 | 类型 | 说明 |
---|---|---|
queryParameters |
string |
用于包含或排除 (逗号分隔) 的查询参数。 |
queryStringBehavior |
请求的缓存行为 |
|
typeName |
enum:
Delivery |
CacheType
需要缓存内容的级别。
名称 | 类型 | 说明 |
---|---|---|
All |
string |
ClientPortMatchConditionParameters
定义 ClientPort 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
ClientPortOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
CookiesMatchConditionParameters
定义 Cookie 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
selector |
string |
要匹配的 Cookie 的名称 |
|
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
CookiesOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
DeepCreatedCustomDomain
在 CDN 终结点上创建的自定义域。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
自定义域名。 |
properties.hostName |
string |
自定义域的主机名。 必须是域名。 |
properties.validationData |
string |
由于本地合规性原因,将 CDN 传送到某些区域时,可能需要特殊的验证或数据。 例如,在中国交付内容需要自定义域的 ICP 许可证号。 |
DeepCreatedOrigin
创建 CDN 终结点时添加的 CDN 内容的main源。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
在终结点中必须唯一的源名称。 |
properties.enabled |
boolean |
是否为源启用负载均衡。 默认情况下,源始终处于启用状态。 |
properties.hostName |
string |
源的地址。 它可以是域名、IPv4 地址或 IPv6 地址。 这在终结点中的所有源中应是唯一的。 |
properties.httpPort |
integer |
HTTP 端口的值。 必须介于 1 和 65535 之间。 |
properties.httpsPort |
integer |
HTTPS 端口的值。 必须介于 1 和 65535 之间。 |
properties.originHostHeader |
string |
随每个请求一起发送到源的主机标头值。 如果将此项留空,则请求主机名将确定此值。 Azure CDN 源(例如 Web 应用、Blob 存储和云服务)默认要求此主机头值与源主机名匹配。 |
properties.priority |
integer |
用于负载均衡的给定源组中源的优先级。 如果任何低优先级源正常,则不会使用较高优先级进行负载均衡。必须介于 1 和 5 之间。 |
properties.privateEndpointStatus |
与专用链接连接的审批状态 |
|
properties.privateLinkAlias |
string |
专用链接资源的别名。 填充此可选字段表示此源为“专用” |
properties.privateLinkApprovalMessage |
string |
要包含在审批请求中以连接到专用链接的自定义消息。 |
properties.privateLinkLocation |
string |
专用链接资源的位置。 仅当填充了“privateLinkResourceId”时才需要 |
properties.privateLinkResourceId |
string |
专用链接资源的资源 ID。 填充此可选字段表示此后端为“专用” |
properties.weight |
integer |
给定源组中的源的权重,用于负载均衡。 必须介于 1 和 1000 之间 |
DeepCreatedOriginGroup
创建 CDN 终结点时添加的 CDN 内容的源组。 流量根据源运行状况发送到源组中的源。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
在终结点中必须唯一的源组名称。 |
properties.healthProbeSettings |
用于确定源运行状况的源的运行状况探测设置。 |
|
properties.origins |
通过给定源组中的 CDN 传递的内容的来源。 |
|
properties.responseBasedOriginErrorDetectionSettings |
JSON 对象,该对象包含用于使用实际请求/响应确定源运行状况的属性。当前不支持此属性。 |
|
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes |
integer |
当运行不正常的终结点运行正常或添加新终结点时,逐渐将流量转移到终结点的时间(以分钟为单位)。 默认值为 10 分钟。 当前不支持此属性。 |
DeliveryPolicy
一个策略,指定要用于终结点的传递规则。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
策略的用户友好说明。 |
rules |
传递规则的列表。 |
DeliveryRule
指定一组操作和条件的规则
名称 | 类型 | 说明 |
---|---|---|
actions | DeliveryRuleAction[]: |
满足规则的所有条件时执行的操作列表。 |
conditions |
DeliveryRuleCondition[]:
|
要执行的操作必须匹配的条件列表 |
name |
string |
规则名称 |
order |
integer |
为终结点应用规则的顺序。 可能的值 {0,1,2,3,.........}。 顺序较小的规则将在顺序较大的规则之前应用。 顺序为 0 的规则是一种特殊规则。 它不需要任何条件,并且将始终应用其中列出的操作。 |
DeliveryRuleCacheExpirationAction
定义传递规则的缓存过期操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Cache |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
DeliveryRuleCacheKeyQueryStringAction
定义传递规则的 cache-key 查询字符串操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Cache |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
DeliveryRuleClientPortCondition
定义传递规则的 ClientPort 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Client |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleCookiesCondition
定义传递规则的 Cookie 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Cookies |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleHostNameCondition
定义传递规则的 HostName 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Host |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleHttpVersionCondition
定义传递规则的 HttpVersion 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Http |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleIsDeviceCondition
定义传递规则的 IsDevice 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Is |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRulePostArgsCondition
定义传递规则的 PostArgs 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Post |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleQueryStringCondition
定义传递规则的 QueryString 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Query |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleRemoteAddressCondition
定义传递规则的 RemoteAddress 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Remote |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleRequestBodyCondition
定义传递规则的 RequestBody 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Request |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleRequestHeaderAction
定义传递规则的请求标头操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Modify |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
DeliveryRuleRequestHeaderCondition
定义传递规则的 RequestHeader 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Request |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleRequestMethodCondition
定义传递规则的 RequestMethod 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Request |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleRequestSchemeCondition
定义传递规则的 RequestScheme 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Request |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleRequestUriCondition
定义传递规则的 RequestUri 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Request |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleResponseHeaderAction
定义传递规则的响应标头操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Modify |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
DeliveryRuleRouteConfigurationOverrideAction
定义传递规则的路由配置替代操作。 仅适用于 Frontdoor 标准/高级配置文件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Route |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
DeliveryRuleServerPortCondition
定义传递规则的 ServerPort 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Server |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleSocketAddrCondition
定义传递规则的 SocketAddress 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Socket |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleSslProtocolCondition
定义传递规则的 SslProtocol 条件。
名称 | 类型 | 说明 |
---|---|---|
name | string: |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleUrlFileExtensionCondition
定义传递规则的 UrlFileExtension 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Url |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleUrlFileNameCondition
定义传递规则的 UrlFileName 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Url |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DeliveryRuleUrlPathCondition
定义传递规则的 UrlPath 条件。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Url |
传递规则的条件的名称。 |
parameters |
定义条件的参数。 |
DestinationProtocol
用于重定向的协议。 默认值为 MatchRequest
名称 | 类型 | 说明 |
---|---|---|
Http |
string |
|
Https |
string |
|
MatchRequest |
string |
Endpoint
CDN 终结点是 CDN 配置文件中的实体,其中包含源、协议、内容缓存和传递行为等配置信息。 CDN 终结点使用 URL 格式 .azureedge.net。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源 ID。 |
|
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.contentTypesToCompress |
string[] |
应用压缩的内容类型列表。 该值应为有效的 MIME 类型。 |
|
properties.customDomains |
终结点下的自定义域。 |
||
properties.defaultOriginGroup |
对源组的引用。 |
||
properties.deliveryPolicy |
指定要用于终结点的传递规则的策略。 |
||
properties.geoFilters |
定义 CDN 终结点中用户异地访问权限的规则列表。 每个地理筛选器定义对指定路径或内容的访问规则,例如阻止路径 /pictures/ 的 APAC |
||
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 |
指定客户希望此 CDN 终结点优化的方案,例如下载、媒体服务。 通过此信息,CDN 可以应用方案驱动的优化。 |
||
properties.originGroups |
源组,由源组成,用于根据可用性对流量进行负载均衡。 |
||
properties.originHostHeader |
string |
随每个请求一起发送到源的主机标头值。 仅当终结点使用单个源并且可由源中指定的同一属性重写时,才允许终结点中的此属性。如果将此留空,则请求主机名将确定此值。 Azure CDN 源(例如 Web 应用、Blob 存储和云服务)默认要求此主机头值与源主机名匹配。 |
|
properties.originPath |
string |
CDN 可用于从中检索内容的源上的目录路径,例如 contoso.cloudapp.net/originpath。 |
|
properties.origins |
通过 CDN 传递的内容的源。 |
||
properties.probePath |
string |
源上托管的文件的路径,该路径有助于加速动态内容的传递,并计算 CDN 的最佳路由。 这是相对于源路径的。 仅当使用单个源时,此属性才相关。 |
|
properties.provisioningState |
终结点的预配状态。 |
||
properties.queryStringCachingBehavior | NotSet |
定义 CDN 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串,绕过缓存以防止缓存包含查询字符串的请求,或者使用唯一 URL 缓存每个请求。 |
|
properties.resourceState |
终结点的资源状态。 |
||
properties.urlSigningKeys |
用于验证已签名 URL 哈希的密钥列表。 |
||
properties.webApplicationFirewallPolicyLink |
定义终结点 (的Web 应用程序防火墙策略(如果适用) |
||
systemData |
只读系统数据 |
||
tags |
object |
资源标记。 |
|
type |
string |
资源类型。 |
EndpointProvisioningState
终结点的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
EndpointResourceState
终结点的资源状态。
名称 | 类型 | 说明 |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Running |
string |
|
Starting |
string |
|
Stopped |
string |
|
Stopping |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
ForwardingProtocol
将流量转发到后端时此规则将使用的协议。
名称 | 类型 | 说明 |
---|---|---|
HttpOnly |
string |
|
HttpsOnly |
string |
|
MatchRequest |
string |
GeoFilter
定义 CDN 终结点中用户异地访问的规则。
名称 | 类型 | 说明 |
---|---|---|
action |
地理筛选器的操作,即允许或阻止访问。 |
|
countryCodes |
string[] |
在地理筛选器中定义用户国家或地区访问权限的两个字母国家或地区代码,例如 AU、MX、US。 |
relativePath |
string |
适用于异地筛选器的相对路径。 (例如“/mypictures”、“/mypicture/kitty.jpg”等 ) |
GeoFilterActions
地理筛选器的操作,即允许或阻止访问。
名称 | 类型 | 说明 |
---|---|---|
Allow |
string |
|
Block |
string |
HeaderAction
要执行的操作
名称 | 类型 | 说明 |
---|---|---|
Append |
string |
|
Delete |
string |
|
Overwrite |
string |
HeaderActionParameters
定义请求标头操作的参数。
名称 | 类型 | 说明 |
---|---|---|
headerAction |
要执行的操作 |
|
headerName |
string |
要修改的标头的名称 |
typeName |
enum:
Delivery |
|
value |
string |
指定操作的值 |
HealthProbeParameters
包含将运行状况探测发送到源的属性的 JSON 对象。
名称 | 类型 | 说明 |
---|---|---|
probeIntervalInSeconds |
integer |
运行状况探测之间的秒数。默认值为 240 秒。 |
probePath |
string |
源的相对路径,用于确定源的运行状况。 |
probeProtocol |
用于运行状况探测的协议。 |
|
probeRequestType |
发出的运行状况探测请求的类型。 |
HealthProbeRequestType
发出的运行状况探测请求的类型。
名称 | 类型 | 说明 |
---|---|---|
GET |
string |
|
HEAD |
string |
|
NotSet |
string |
HostNameMatchConditionParameters
定义 HostName 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
HostNameOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
HttpErrorRangeParameters
表示 http 状态代码范围的 JSON 对象
名称 | 类型 | 说明 |
---|---|---|
begin |
integer |
http 状态代码范围的非独占开头。 |
end |
integer |
http 状态代码范围的非独占端。 |
HttpVersionMatchConditionParameters
定义 HttpVersion 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
HttpVersionOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Equal |
string |
IdentityType
创建/修改资源的标识类型
名称 | 类型 | 说明 |
---|---|---|
application |
string |
|
key |
string |
|
managedIdentity |
string |
|
user |
string |
IsDeviceMatchConditionParameters
定义 IsDevice 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
传递规则条件的匹配值 |
||
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
IsDeviceOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Equal |
string |
KeyVaultSigningKeyParameters
介绍将用户的 KeyVault 用于 URL 签名密钥的参数。
名称 | 类型 | 说明 |
---|---|---|
resourceGroupName |
string |
包含机密的用户密钥保管库的资源组 |
secretName |
string |
密钥保管库中的机密名称。 |
secretVersion |
string |
密钥保管库中机密的版本 (GUID) 。 |
subscriptionId |
string |
包含机密的用户密钥保管库的订阅 ID |
typeName | enum: | |
vaultName |
string |
包含机密的用户密钥保管库的名称 |
MatchValues
传递规则条件的匹配值
名称 | 类型 | 说明 |
---|---|---|
DELETE |
string |
|
GET |
string |
|
HEAD |
string |
|
OPTIONS |
string |
|
POST |
string |
|
PUT |
string |
|
TRACE |
string |
OptimizationType
指定客户希望此 CDN 终结点优化的方案,例如下载、媒体服务。 利用此信息,我们可以应用方案驱动的优化。
名称 | 类型 | 说明 |
---|---|---|
DynamicSiteAcceleration |
string |
|
GeneralMediaStreaming |
string |
|
GeneralWebDelivery |
string |
|
LargeFileDownload |
string |
|
VideoOnDemandMediaStreaming |
string |
OriginGroupOverride
定义源组替代配置的参数。
名称 | 类型 | 说明 |
---|---|---|
forwardingProtocol |
将流量转发到后端时此规则将使用的协议。 |
|
originGroup |
定义将替代路由上的 DefaultOriginGroup 的 OriginGroup。 |
OriginGroupOverrideAction
定义传递规则的源组替代操作。
名称 | 类型 | 说明 |
---|---|---|
name | string: |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
OriginGroupOverrideActionParameters
定义源组替代操作的参数。
名称 | 类型 | 说明 |
---|---|---|
originGroup |
定义将替代 DefaultOriginGroup 的 OriginGroup。 |
|
typeName |
enum:
Delivery |
paramIndicator
指示参数的用途
名称 | 类型 | 说明 |
---|---|---|
Expires |
string |
|
KeyId |
string |
|
Signature |
string |
PostArgsMatchConditionParameters
定义 PostArgs 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
selector |
string |
要匹配的 PostArg 的名称 |
|
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
PostArgsOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
PrivateEndpointStatus
与专用链接连接的审批状态
名称 | 类型 | 说明 |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
|
Timeout |
string |
ProbeProtocol
用于运行状况探测的协议。
名称 | 类型 | 说明 |
---|---|---|
Http |
string |
|
Https |
string |
|
NotSet |
string |
queryStringBehavior
请求的缓存行为
名称 | 类型 | 说明 |
---|---|---|
Exclude |
string |
|
ExcludeAll |
string |
|
Include |
string |
|
IncludeAll |
string |
QueryStringCachingBehavior
定义 CDN 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串,绕过缓存以防止缓存包含查询字符串的请求,或者使用唯一 URL 缓存每个请求。
名称 | 类型 | 说明 |
---|---|---|
BypassCaching |
string |
|
IgnoreQueryString |
string |
|
NotSet |
string |
|
UseQueryString |
string |
QueryStringMatchConditionParameters
定义 QueryString 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
QueryStringOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
RedirectType
重定向流量时规则将使用的重定向类型。
名称 | 类型 | 说明 |
---|---|---|
Found |
string |
|
Moved |
string |
|
PermanentRedirect |
string |
|
TemporaryRedirect |
string |
RemoteAddressMatchConditionParameters
定义 RemoteAddress 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
匹配要匹配的值。 运算符将应用于此处具有 OR 语义的每个值。 如果其中任何一个匹配变量与给定运算符匹配,则此匹配条件被视为匹配。 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
RemoteAddressOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
GeoMatch |
string |
|
IPMatch |
string |
RequestBodyMatchConditionParameters
定义 RequestBody 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
RequestBodyOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
RequestHeaderMatchConditionParameters
定义 RequestHeader 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
selector |
string |
要匹配的标头的名称 |
|
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
RequestHeaderOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
RequestMethodMatchConditionParameters
定义 RequestMethod 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
传递规则条件的匹配值 |
||
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
RequestMethodOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Equal |
string |
RequestSchemeMatchConditionParameters
定义 RequestScheme 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
传递规则条件的匹配值 |
||
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
enum:
Equal |
描述要匹配的运算符 |
|
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
RequestUriMatchConditionParameters
定义 RequestUri 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
RequestUriOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
ResourceReference
对另一个资源的引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
ResponseBasedDetectedErrorTypes
将被视为不正常的真实用户请求的响应错误类型
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
TcpAndHttpErrors |
string |
|
TcpErrorsOnly |
string |
ResponseBasedOriginErrorDetectionParameters
JSON 对象,该对象包含用于使用实际请求/响应确定源运行状况的属性。
名称 | 类型 | 说明 |
---|---|---|
httpErrorRanges |
被视为源服务器错误且标记为不正常的 Http 状态代码范围列表。 |
|
responseBasedDetectedErrorTypes |
将被视为不正常的真实用户请求的响应错误类型 |
|
responseBasedFailoverThresholdPercentage |
integer |
示例中应触发故障转移的失败请求的百分比。 |
RouteConfigurationOverrideActionParameters
定义路由配置替代操作的参数。
名称 | 类型 | 说明 |
---|---|---|
cacheConfiguration |
与此规则关联的缓存配置。 若要禁用缓存,请不要提供 cacheConfiguration 对象。 |
|
originGroupOverride |
对源组的引用将替代配置。 保留为空,以在路由上使用默认源组。 |
|
typeName |
enum:
Delivery |
ruleCacheBehavior
请求的缓存行为
名称 | 类型 | 说明 |
---|---|---|
HonorOrigin |
string |
|
OverrideAlways |
string |
|
OverrideIfOriginMissing |
string |
ruleIsCompressionEnabled
指示是否启用内容压缩。 如果启用了压缩,当用户请求压缩版本时,内容将作为压缩内容提供。 当请求的内容小于 1 字节或大于 1 MB 时,不会在 AzureFrontDoor 上压缩内容。
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ruleQueryStringCachingBehavior
定义 Frontdoor 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串、忽略特定查询字符串、使用唯一 URL 缓存每个请求或缓存特定的查询字符串。
名称 | 类型 | 说明 |
---|---|---|
IgnoreQueryString |
string |
|
IgnoreSpecifiedQueryStrings |
string |
|
IncludeSpecifiedQueryStrings |
string |
|
UseQueryString |
string |
ServerPortMatchConditionParameters
定义 ServerPort 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
ServerPortOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
SocketAddrMatchConditionParameters
定义 SocketAddress 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
SocketAddrOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
IPMatch |
string |
SslProtocol
已建立的 TLS 连接的协议。
名称 | 类型 | 说明 |
---|---|---|
TLSv1 |
string |
|
TLSv1.1 |
string |
|
TLSv1.2 |
string |
SslProtocolMatchConditionParameters
定义 SslProtocol 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
传递规则条件的匹配值 |
||
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
SslProtocolOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Equal |
string |
SystemData
只读系统数据
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源的创建时间戳 (UTC) |
createdBy |
string |
创建资源的标识的标识符 |
createdByType |
创建资源的标识类型 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识的标识符 |
lastModifiedByType |
上次修改资源的标识类型 |
transform
描述在匹配之前应用了哪些转换
名称 | 类型 | 说明 |
---|---|---|
Lowercase |
string |
|
RemoveNulls |
string |
|
Trim |
string |
|
Uppercase |
string |
|
UrlDecode |
string |
|
UrlEncode |
string |
UrlFileExtensionMatchConditionParameters
定义 UrlFileExtension 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
UrlFileExtensionOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
UrlFileNameMatchConditionParameters
定义 UrlFilename 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
UrlFileNameOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
UrlPathMatchConditionParameters
定义 UrlPath 匹配条件的参数
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
matchValues |
string[] |
传递规则条件的匹配值 |
|
negateCondition |
boolean |
False |
描述这是否为否定条件 |
operator |
描述要匹配的运算符 |
||
transforms |
转换列表 |
||
typeName |
enum:
Delivery |
UrlPathOperator
描述要匹配的运算符
名称 | 类型 | 说明 |
---|---|---|
Any |
string |
|
BeginsWith |
string |
|
Contains |
string |
|
EndsWith |
string |
|
Equal |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
|
RegEx |
string |
|
Wildcard |
string |
UrlRedirectAction
定义传递规则的 URL 重定向操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Url |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
UrlRedirectActionParameters
定义 URL 重定向操作的参数。
名称 | 类型 | 说明 |
---|---|---|
customFragment |
string |
要添加到重定向 URL 的片段。 片段是 #之后的 URL 的一部分。 不要包含 #。 |
customHostname |
string |
要重定向的主机。 留空以使用传入主机作为目标主机。 |
customPath |
string |
要重定向的完整路径。 路径不能为空,并且必须以 /开头。 保留为空,以使用传入路径作为目标路径。 |
customQueryString |
string |
要放置在重定向 URL 中的查询字符串集。 设置此值将替换任何现有的查询字符串;保留空以保留传入的查询字符串。 查询字符串必须采用 = 格式。 ? 和 & 将自动添加,因此请勿包含它们。 |
destinationProtocol |
用于重定向的协议。 默认值为 MatchRequest |
|
redirectType |
规则在重定向流量时将使用的重定向类型。 |
|
typeName |
enum:
Delivery |
UrlRewriteAction
定义传递规则的 URL 重写操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Url |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
UrlRewriteActionParameters
定义 URL 重写操作的参数。
名称 | 类型 | 说明 |
---|---|---|
destination |
string |
定义上述请求将重写到的相对 URL。 |
preserveUnmatchedPath |
boolean |
是否保留不匹配的路径。 默认值为 true。 |
sourcePattern |
string |
定义一个请求 URI 模式,该模式标识可能重写的请求类型。 如果值为空,则匹配所有字符串。 |
typeName |
enum:
Delivery |
UrlSigningAction
定义传递规则的 URL 签名操作。
名称 | 类型 | 说明 |
---|---|---|
name |
string:
Url |
传递规则的操作的名称。 |
parameters |
定义操作的参数。 |
UrlSigningActionParameters
定义 URL 签名操作的参数。
名称 | 类型 | 说明 |
---|---|---|
algorithm |
用于 URL 签名的算法 |
|
parameterNameOverride |
定义 URL 中要考虑过期、密钥 ID 等的查询字符串参数。 |
|
typeName |
enum:
Delivery |
UrlSigningKey
URL 签名密钥
名称 | 类型 | 说明 |
---|---|---|
keyId |
string |
定义客户定义的密钥 ID。此 ID 将存在于传入请求中,以指示用于构成哈希的密钥。 |
keySourceParameters |
定义用于将客户密钥保管库用于 URL 签名密钥的参数。 |
UrlSigningParamIdentifier
定义如何标识特定用途的参数,例如过期
名称 | 类型 | 说明 |
---|---|---|
paramIndicator |
指示参数的用途 |
|
paramName |
string |
参数名称 |
WebApplicationFirewallPolicyLink
定义终结点 (的Web 应用程序防火墙策略(如果适用))
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |