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

Rules - Update

更新规则集中的现有传递规则。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}?api-version=2021-06-01

URI 参数

Name In Required Type Description
profileName
path True
  • string

Azure Front Door Standard 或 Azure Front Door 高级版 配置文件的名称,该配置文件在资源组中是唯一的。

resourceGroupName
path True
  • string

Azure 订阅中的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+$

ruleName
path True
  • string

终结点中唯一的传递规则的名称。

ruleSetName
path True
  • string

配置文件下的规则集的名称。

subscriptionId
path True
  • string

Azure 订阅 ID。

api-version
query True
  • string

要用于客户端请求的 API 的版本。 当前版本为 2021-06-01。

请求正文

Name Type Description
properties.actions DeliveryRuleAction[]:

满足规则的所有条件时执行的操作列表。

properties.conditions DeliveryRuleCondition[]:

必须匹配要执行的操作的条件列表

properties.matchProcessingBehavior

如果此规则是匹配规则,规则引擎应继续运行剩余的规则或停止。 如果不存在,则默认为“继续”。

properties.order
  • integer

规则应用于终结点的顺序。 可能的值 {0,1,2,3,.........}。 在具有较大顺序的规则之前,将应用具有较低顺序的规则。 具有顺序 0 的规则是一个特殊规则。 它不需要任何条件,并且它中列出的操作将始终应用。

响应

Name Type Description
200 OK

OK

202 Accepted

已接受

Other Status Codes

CDN错误响应,描述操作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Rules_Update

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1/rules/rule1?api-version=2021-06-01
{
  "properties": {
    "order": 1,
    "actions": [
      {
        "name": "ModifyResponseHeader",
        "parameters": {
          "typeName": "DeliveryRuleHeaderActionParameters",
          "headerAction": "Overwrite",
          "headerName": "X-CDN",
          "value": "MSFT"
        }
      }
    ]
  }
}

Sample Response

{
  "name": "rule1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1/rules/rule1",
  "type": "Microsoft.Cdn/profiles/ruleSets/rules",
  "properties": {
    "order": 1,
    "conditions": [
      {
        "name": "RequestMethod",
        "parameters": {
          "typeName": "DeliveryRuleRequestMethodConditionParameters",
          "operator": "Equal",
          "matchValues": [
            "GET"
          ],
          "negateCondition": false,
          "transforms": []
        }
      }
    ],
    "actions": [
      {
        "name": "ModifyResponseHeader",
        "parameters": {
          "typeName": "DeliveryRuleHeaderActionParameters",
          "headerAction": "Overwrite",
          "headerName": "X-CDN",
          "value": "MSFT"
        }
      }
    ]
  }
}
azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2021-06-01
{
  "name": "rule1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1/rules/rule1",
  "type": "Microsoft.Cdn/profiles/ruleSets/rules",
  "properties": {
    "order": 1,
    "conditions": [
      {
        "name": "RequestMethod",
        "parameters": {
          "typeName": "DeliveryRuleRequestMethodConditionParameters",
          "operator": "Equal",
          "matchValues": [
            "GET"
          ],
          "negateCondition": false,
          "transforms": []
        }
      }
    ],
    "actions": [
      {
        "name": "ModifyResponseHeader",
        "parameters": {
          "typeName": "DeliveryRuleHeaderActionParameters",
          "headerAction": "Overwrite",
          "headerName": "X-CDN",
          "value": "MSFT"
        }
      }
    ]
  }
}

定义

AfdErrorResponse

错误响应

AfdProvisioningState

预配状态

algorithm

用于 URL 签名的算法

cacheBehavior

请求的Caching行为

CacheConfiguration

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

CacheExpirationActionParameters

定义缓存过期操作的参数。

CacheKeyQueryStringActionParameters

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

CacheType

需要缓存内容的级别。

ClientPortMatchConditionParameters

定义 ClientPort 匹配条件的参数

ClientPortOperator

描述要匹配的运算符

CookiesMatchConditionParameters

定义 Cookie 匹配条件的参数

CookiesOperator

描述要匹配的运算符

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 Standard/高级版 配置文件。

DeliveryRuleServerPortCondition

定义传递规则的 ServerPort 条件。

DeliveryRuleSocketAddrCondition

定义传递规则的 SocketAddress 条件。

DeliveryRuleSslProtocolCondition

定义传递规则的 SslProtocol 条件。

DeliveryRuleUrlFileExtensionCondition

定义传递规则的 UrlFileExtension 条件。

DeliveryRuleUrlFileNameCondition

定义传递规则的 UrlFileName 条件。

DeliveryRuleUrlPathCondition

定义传递规则的 UrlPath 条件。

DeploymentStatus
DestinationProtocol

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ForwardingProtocol

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

HeaderAction

要执行的操作

HeaderActionParameters

定义请求标头操作的参数。

HostNameMatchConditionParameters

定义 HostName 匹配条件的参数

HostNameOperator

描述要匹配的运算符

HttpVersionMatchConditionParameters

定义 HttpVersion 匹配条件的参数

HttpVersionOperator

描述要匹配的运算符

IdentityType

创建/修改资源的标识类型

IsDeviceMatchConditionParameters

定义 IsDevice 匹配条件的参数

IsDeviceOperator

描述要匹配的运算符

MatchProcessingBehavior

如果此规则是匹配规则,则规则引擎应继续运行剩余的规则或停止。 如果不存在,则默认为“继续”。

OriginGroupOverride

定义源组替代配置的参数。

OriginGroupOverrideAction

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

OriginGroupOverrideActionParameters

定义源组重写操作的参数。

paramIndicator

指示参数的用途

PostArgsMatchConditionParameters

定义 PostArgs 匹配条件的参数

PostArgsOperator

描述要匹配的运算符

queryStringBehavior

请求的Caching行为

QueryStringMatchConditionParameters

定义 QueryString 匹配条件的参数

QueryStringOperator

描述要匹配的运算符

RedirectType

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

RemoteAddressMatchConditionParameters

定义 RemoteAddress 匹配条件的参数

RemoteAddressOperator

描述要匹配的运算符

RequestBodyMatchConditionParameters

定义 RequestBody 匹配条件的参数

RequestBodyOperator

描述要匹配的运算符

RequestHeaderMatchConditionParameters

定义 RequestHeader 匹配条件的参数

RequestHeaderOperator

描述要匹配的运算符

RequestMethodMatchConditionParameters

定义 RequestMethod 匹配条件的参数

RequestMethodOperator

描述要匹配的运算符

RequestSchemeMatchConditionParameters

定义 RequestScheme 匹配条件的参数

RequestUriMatchConditionParameters

定义 RequestUri 匹配条件的参数

RequestUriOperator

描述要匹配的运算符

ResourceReference

对另一个资源的引用。

RouteConfigurationOverrideActionParameters

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

Rule

友好规则名称映射到任何规则或机密相关信息。

ruleCacheBehavior

请求的Caching行为

ruleIsCompressionEnabled

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

ruleQueryStringCachingBehavior

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

RuleUpdateParameters

域创建或更新所需的域 JSON 对象。

ServerPortMatchConditionParameters

定义 ServerPort 匹配条件的参数

ServerPortOperator

描述要匹配的运算符

SocketAddrMatchConditionParameters

定义 SocketAddress 匹配条件的参数

SocketAddrOperator

描述要匹配的运算符

SslProtocolMatchConditionParameters

定义 SslProtocol 匹配条件的参数

SslProtocolOperator

描述要匹配的运算符

SystemData

只读系统数据

UrlFileExtensionMatchConditionParameters

定义 UrlFileExtension 匹配条件的参数

UrlFileExtensionOperator

描述要匹配的运算符

UrlFileNameMatchConditionParameters

定义 UrlFilename 匹配条件的参数

UrlFileNameOperator

描述要匹配的运算符

UrlPathMatchConditionParameters

定义 UrlPath 匹配条件的参数

UrlPathOperator

描述要匹配的运算符

UrlRedirectAction

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

UrlRedirectActionParameters

定义 URL 重定向操作的参数。

UrlRewriteAction

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

UrlRewriteActionParameters

定义 URL 重写操作的参数。

UrlSigningAction

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

UrlSigningActionParameters

定义 URL 签名操作的参数。

UrlSigningParamIdentifier

定义如何确定特定用途的参数,例如过期

AfdErrorResponse

错误响应

Name Type Description
error

错误对象。

AfdProvisioningState

预配状态

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

algorithm

用于 URL 签名的算法

Name Type Description
SHA256
  • string

cacheBehavior

请求的Caching行为

Name Type Description
BypassCache
  • string
Override
  • string
SetIfMissing
  • string

CacheConfiguration

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

Name Type Description
cacheBehavior

请求的Caching行为

cacheDuration
  • string

需要缓存内容的持续时间。 允许的格式为 [d.]hh:mm:ss

isCompressionEnabled

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

queryParameters
  • string

要包含或排除 (逗号分隔) 的查询参数。

queryStringCachingBehavior

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

CacheExpirationActionParameters

定义缓存过期操作的参数。

Name Type Description
cacheBehavior

请求的Caching行为

cacheDuration
  • string

需要缓存内容的持续时间。 允许的格式为 [d.]hh:mm:ss

cacheType

需要缓存内容的级别。

typeName enum:
  • DeliveryRuleCacheExpirationActionParameters

CacheKeyQueryStringActionParameters

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

Name Type Description
queryParameters
  • string

要包含或排除 (逗号分隔) 的查询参数。

queryStringBehavior

请求的Caching行为

typeName enum:
  • DeliveryRuleCacheKeyQueryStringBehaviorActionParameters

CacheType

需要缓存内容的级别。

Name Type Description
All
  • string

ClientPortMatchConditionParameters

定义 ClientPort 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleClientPortConditionParameters

ClientPortOperator

描述要匹配的运算符

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

CookiesMatchConditionParameters

定义 Cookie 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

selector
  • string

要匹配的 Cookie 的名称

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleCookiesConditionParameters

CookiesOperator

描述要匹配的运算符

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

DeliveryRuleCacheExpirationAction

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

Name Type Description
name string:
  • CacheExpiration

传递规则的操作的名称。

parameters

定义操作的参数。

DeliveryRuleCacheKeyQueryStringAction

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

Name Type Description
name string:
  • CacheKeyQueryString

传递规则的操作的名称。

parameters

定义操作的参数。

DeliveryRuleClientPortCondition

定义传递规则的 ClientPort 条件。

Name Type Description
name string:
  • ClientPort

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleCookiesCondition

定义传递规则的 Cookie 条件。

Name Type Description
name string:
  • Cookies

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleHostNameCondition

定义传递规则的 HostName 条件。

Name Type Description
name string:
  • HostName

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleHttpVersionCondition

定义传递规则的 HttpVersion 条件。

Name Type Description
name string:
  • HttpVersion

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleIsDeviceCondition

定义传递规则的 IsDevice 条件。

Name Type Description
name string:
  • IsDevice

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRulePostArgsCondition

定义传递规则的 PostArgs 条件。

Name Type Description
name string:
  • PostArgs

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleQueryStringCondition

定义传递规则的 QueryString 条件。

Name Type Description
name string:
  • QueryString

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleRemoteAddressCondition

定义传递规则的 RemoteAddress 条件。

Name Type Description
name string:
  • RemoteAddress

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleRequestBodyCondition

定义传递规则的 RequestBody 条件。

Name Type Description
name string:
  • RequestBody

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleRequestHeaderAction

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

Name Type Description
name string:
  • ModifyRequestHeader

传递规则的操作的名称。

parameters

定义操作的参数。

DeliveryRuleRequestHeaderCondition

定义传递规则的 RequestHeader 条件。

Name Type Description
name string:
  • RequestHeader

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleRequestMethodCondition

定义传递规则的 RequestMethod 条件。

Name Type Description
name string:
  • RequestMethod

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleRequestSchemeCondition

定义传递规则的 RequestScheme 条件。

Name Type Description
name string:
  • RequestScheme

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleRequestUriCondition

定义传递规则的 RequestUri 条件。

Name Type Description
name string:
  • RequestUri

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleResponseHeaderAction

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

Name Type Description
name string:
  • ModifyResponseHeader

传递规则的操作的名称。

parameters

定义操作的参数。

DeliveryRuleRouteConfigurationOverrideAction

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

Name Type Description
name string:
  • RouteConfigurationOverride

传递规则的操作的名称。

parameters

定义操作的参数。

DeliveryRuleServerPortCondition

定义传递规则的 ServerPort 条件。

Name Type Description
name string:
  • ServerPort

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleSocketAddrCondition

定义传递规则的 SocketAddress 条件。

Name Type Description
name string:
  • SocketAddr

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleSslProtocolCondition

定义传递规则的 SslProtocol 条件。

Name Type Description
name string:
  • SslProtocol

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleUrlFileExtensionCondition

定义传递规则的 UrlFileExtension 条件。

Name Type Description
name string:
  • UrlFileExtension

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleUrlFileNameCondition

定义传递规则的 UrlFileName 条件。

Name Type Description
name string:
  • UrlFileName

传递规则的条件的名称。

parameters

定义条件的参数。

DeliveryRuleUrlPathCondition

定义传递规则的 UrlPath 条件。

Name Type Description
name string:
  • UrlPath

传递规则的条件的名称。

parameters

定义条件的参数。

DeploymentStatus

Name Type Description
Failed
  • string
InProgress
  • string
NotStarted
  • string
Succeeded
  • string

DestinationProtocol

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

Name Type Description
Http
  • string
Https
  • string
MatchRequest
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ForwardingProtocol

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

Name Type Description
HttpOnly
  • string
HttpsOnly
  • string
MatchRequest
  • string

HeaderAction

要执行的操作

Name Type Description
Append
  • string
Delete
  • string
Overwrite
  • string

HeaderActionParameters

定义请求标头操作的参数。

Name Type Description
headerAction

要执行的操作

headerName
  • string

要修改的标头的名称

typeName enum:
  • DeliveryRuleHeaderActionParameters
value
  • string

指定操作的值

HostNameMatchConditionParameters

定义 HostName 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleHostNameConditionParameters

HostNameOperator

描述要匹配的运算符

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

HttpVersionMatchConditionParameters

定义 HttpVersion 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleHttpVersionConditionParameters

HttpVersionOperator

描述要匹配的运算符

Name Type Description
Equal
  • string

IdentityType

创建/修改资源的标识类型

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

IsDeviceMatchConditionParameters

定义 IsDevice 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleIsDeviceConditionParameters

IsDeviceOperator

描述要匹配的运算符

Name Type Description
Equal
  • string

MatchProcessingBehavior

如果此规则是匹配规则,则规则引擎应继续运行剩余的规则或停止。 如果不存在,则默认为“继续”。

Name Type Description
Continue
  • string
Stop
  • string

OriginGroupOverride

定义源组替代配置的参数。

Name Type Description
forwardingProtocol

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

originGroup

定义将在路由上替代 DefaultOriginGroup 的 OriginGroup。

OriginGroupOverrideAction

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

Name Type Description
name string:

传递规则的操作的名称。

parameters

定义操作的参数。

OriginGroupOverrideActionParameters

定义源组重写操作的参数。

Name Type Description
originGroup

定义将替代 DefaultOriginGroup 的 OriginGroup。

typeName enum:
  • DeliveryRuleOriginGroupOverrideActionParameters

paramIndicator

指示参数的用途

Name Type Description
Expires
  • string
KeyId
  • string
Signature
  • string

PostArgsMatchConditionParameters

定义 PostArgs 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

selector
  • string

要匹配的 PostArg 的名称

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRulePostArgsConditionParameters

PostArgsOperator

描述要匹配的运算符

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

queryStringBehavior

请求的Caching行为

Name Type Description
Exclude
  • string
ExcludeAll
  • string
Include
  • string
IncludeAll
  • string

QueryStringMatchConditionParameters

定义 QueryString 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleQueryStringConditionParameters

QueryStringOperator

描述要匹配的运算符

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

RedirectType

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

Name Type Description
Found
  • string
Moved
  • string
PermanentRedirect
  • string
TemporaryRedirect
  • string

RemoteAddressMatchConditionParameters

定义 RemoteAddress 匹配条件的参数

Name Type Description
matchValues
  • string[]

匹配要匹配的值。 运算符将应用于此处具有 OR 语义的每个值。 如果其中任何一个匹配变量与给定运算符匹配,则此匹配条件被视为匹配项。

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

描述要匹配的运算符

Name Type Description
Any
  • string
GeoMatch
  • string
IPMatch
  • string

RequestBodyMatchConditionParameters

定义 RequestBody 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleRequestBodyConditionParameters

RequestBodyOperator

描述要匹配的运算符

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

RequestHeaderMatchConditionParameters

定义 RequestHeader 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

selector
  • string

要匹配的标头的名称

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

描述要匹配的运算符

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

RequestMethodMatchConditionParameters

定义 RequestMethod 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleRequestMethodConditionParameters

RequestMethodOperator

描述要匹配的运算符

Name Type Description
Equal
  • string

RequestSchemeMatchConditionParameters

定义 RequestScheme 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator enum:
  • Equal

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleRequestSchemeConditionParameters

RequestUriMatchConditionParameters

定义 RequestUri 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleRequestUriConditionParameters

RequestUriOperator

描述要匹配的运算符

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

ResourceReference

对另一个资源的引用。

Name Type Description
id
  • string

资源 ID。

RouteConfigurationOverrideActionParameters

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

Name Type Description
cacheConfiguration

与此规则关联的缓存配置。 若要禁用缓存,请不要提供 cacheConfiguration 对象。

originGroupOverride

对源组替代配置的引用。 保留空以在路由上使用默认源组。

typeName enum:
  • DeliveryRuleRouteConfigurationOverrideActionParameters

Rule

友好规则名称映射到任何规则或机密相关信息。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.actions DeliveryRuleAction[]:

满足规则的所有条件时执行的操作列表。

properties.conditions DeliveryRuleCondition[]:

必须为要执行的操作匹配的条件列表

properties.deploymentStatus
properties.matchProcessingBehavior

如果此规则是匹配规则,则规则引擎应继续运行剩余的规则或停止。 如果不存在,则默认为“继续”。

properties.order
  • integer

为终结点应用规则的顺序。 可能的值 {0,1,2,3,.........}。 在具有更大顺序的规则之前,将应用具有较低顺序的规则。 具有顺序 0 的规则是一个特殊规则。 它不需要它中列出的任何条件和操作将始终应用。

properties.provisioningState

预配状态

properties.ruleSetName
  • string

包含规则的规则集的名称。

systemData

只读系统数据

type
  • string

资源类型。

ruleCacheBehavior

请求的Caching行为

Name Type Description
HonorOrigin
  • string
OverrideAlways
  • string
OverrideIfOriginMissing
  • string

ruleIsCompressionEnabled

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

Name Type Description
Disabled
  • string
Enabled
  • string

ruleQueryStringCachingBehavior

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

Name Type Description
IgnoreQueryString
  • string
IgnoreSpecifiedQueryStrings
  • string
IncludeSpecifiedQueryStrings
  • string
UseQueryString
  • string

RuleUpdateParameters

域创建或更新所需的域 JSON 对象。

Name Type Description
properties.actions DeliveryRuleAction[]:

满足规则的所有条件时执行的操作列表。

properties.conditions DeliveryRuleCondition[]:

必须为要执行的操作匹配的条件列表

properties.matchProcessingBehavior

如果此规则是匹配规则,则规则引擎应继续运行剩余的规则或停止。 如果不存在,则默认为“继续”。

properties.order
  • integer

为终结点应用规则的顺序。 可能的值 {0,1,2,3,.........}。 在具有更大顺序的规则之前,将应用具有较低顺序的规则。 具有顺序 0 的规则是一个特殊规则。 它不需要它中列出的任何条件和操作将始终应用。

properties.ruleSetName
  • string

包含规则的规则集的名称。

ServerPortMatchConditionParameters

定义 ServerPort 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleServerPortConditionParameters

ServerPortOperator

描述要匹配的运算符

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

SocketAddrMatchConditionParameters

定义 SocketAddress 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

描述要匹配的运算符

Name Type Description
Any
  • string
IPMatch
  • string

SslProtocolMatchConditionParameters

定义 SslProtocol 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleSslProtocolConditionParameters

SslProtocolOperator

描述要匹配的运算符

Name Type Description
Equal
  • string

SystemData

只读系统数据

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC)

createdBy
  • string

创建资源的标识的标识符

createdByType

创建资源的标识的类型

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识的标识符

lastModifiedByType

上次修改资源的标识的类型

UrlFileExtensionMatchConditionParameters

定义 UrlFileExtension 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleUrlFileExtensionMatchConditionParameters

UrlFileExtensionOperator

描述要匹配的运算符

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

UrlFileNameMatchConditionParameters

定义 UrlFilename 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleUrlFilenameConditionParameters

UrlFileNameOperator

描述要匹配的运算符

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

UrlPathMatchConditionParameters

定义 UrlPath 匹配条件的参数

Name Type Description
matchValues
  • string[]

传递规则条件的匹配值

negateCondition
  • boolean

描述这是否为否定条件

operator

描述要匹配的运算符

transforms
  • string[]

转换列表

typeName enum:
  • DeliveryRuleUrlPathMatchConditionParameters

UrlPathOperator

描述要匹配的运算符

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

UrlRedirectAction

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

Name Type Description
name string:
  • UrlRedirect

传递规则的操作的名称。

parameters

定义操作的参数。

UrlRedirectActionParameters

定义 URL 重定向操作的参数。

Name Type Description
customFragment
  • string

要添加到重定向 URL 的片段。 片段是 #之后的 URL 的一部分。 请勿包含 #。

customHostname
  • string

要重定向的主机。 将传入主机保留为空,以将传入主机用作目标主机。

customPath
  • string

要重定向的完整路径。 路径不能为空,并且必须以 /开头。 将传入路径保留为空,以将传入路径用作目标路径。

customQueryString
  • string

要放置在重定向 URL 中的查询字符串集。 设置此值将替换任何现有查询字符串;保留空以保留传入的查询字符串。 查询字符串必须采用 = 格式。 ? 并且 & 将自动添加,因此不要包含它们。

destinationProtocol

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

redirectType

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

typeName enum:
  • DeliveryRuleUrlRedirectActionParameters

UrlRewriteAction

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

Name Type Description
name string:
  • UrlRewrite

传递规则的操作的名称。

parameters

定义操作的参数。

UrlRewriteActionParameters

定义 URL 重写操作的参数。

Name Type Description
destination
  • string

定义上述请求将重写到的相对 URL。

preserveUnmatchedPath
  • boolean

是否保留不匹配的路径。 默认值为 true。

sourcePattern
  • string

定义一个请求 URI 模式,该模式标识可能重写的请求的类型。 如果值为空,则匹配所有字符串。

typeName enum:
  • DeliveryRuleUrlRewriteActionParameters

UrlSigningAction

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

Name Type Description
name string:
  • UrlSigning

传递规则的操作的名称。

parameters

定义操作的参数。

UrlSigningActionParameters

定义 URL 签名操作的参数。

Name Type Description
algorithm

用于 URL 签名的算法

parameterNameOverride

定义要考虑用于过期、密钥 ID 等的 URL 中的查询字符串参数。

typeName enum:
  • DeliveryRuleUrlSigningActionParameters

UrlSigningParamIdentifier

定义如何确定特定用途的参数,例如过期

Name Type Description
paramIndicator

指示参数的用途

paramName
  • string

参数名称