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

Rules - Create

Service:

Front Door Service

API Version:

2023-05-01

在指定的规则集中创建新的传递规则。

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

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string	Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。
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 的版本。 当前版本为 2023-05-01。

请求正文

名称	必需	类型	说明
properties.actions	True	DeliveryRuleAction[]: UrlRedirectAction[] UrlSigningAction[] OriginGroupOverrideAction[] UrlRewriteAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRouteConfigurationOverrideAction[]	满足规则的所有条件时执行的操作列表。
properties.order	True	integer	为终结点应用规则的顺序。 可能的值 {0,1,2,3,.........}。 顺序较小的规则将在顺序较大的规则之前应用。 顺序为 0 的规则是一种特殊规则。 它不需要任何条件，并且将始终应用其中列出的操作。
properties.conditions		DeliveryRuleCondition[]: DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleQueryStringCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleUrlPathCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleClientPortCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleSslProtocolCondition[]	要执行的操作必须匹配的条件列表
properties.matchProcessingBehavior		MatchProcessingBehavior	如果此规则是匹配项，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。

响应

名称	类型	说明
200 OK	Rule	确定
201 Created	Rule	Created. 请求已完成，并已创建新的传递规则。
202 Accepted	Rule	已接受。 已接受请求进行处理，操作将以异步方式完成。 Headers location: string
Other Status Codes	AfdErrorResponse	描述操作失败原因的 Azure Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Rules_Create

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1/rules/rule1?api-version=2023-05-01

{
  "properties": {
    "order": 1,
    "conditions": [
      {
        "name": "RequestMethod",
        "parameters": {
          "typeName": "DeliveryRuleRequestMethodConditionParameters",
          "operator": "Equal",
          "matchValues": [
            "GET"
          ],
          "negateCondition": false
        }
      }
    ],
    "actions": [
      {
        "name": "ModifyResponseHeader",
        "parameters": {
          "typeName": "DeliveryRuleHeaderActionParameters",
          "headerAction": "Overwrite",
          "headerName": "X-CDN",
          "value": "MSFT"
        }
      }
    ]
  }
}

Java

import com.azure.resourcemanager.cdn.fluent.models.RuleInner;
import com.azure.resourcemanager.cdn.models.DeliveryRuleRequestMethodCondition;
import com.azure.resourcemanager.cdn.models.DeliveryRuleResponseHeaderAction;
import com.azure.resourcemanager.cdn.models.HeaderAction;
import com.azure.resourcemanager.cdn.models.HeaderActionParameters;
import com.azure.resourcemanager.cdn.models.RequestMethodMatchConditionParameters;
import com.azure.resourcemanager.cdn.models.RequestMethodMatchConditionParametersMatchValuesItem;
import com.azure.resourcemanager.cdn.models.RequestMethodOperator;
import java.util.Arrays;

/** Samples for Rules Create. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Rules_Create.json
     */
    /**
     * Sample code: Rules_Create.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void rulesCreate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getRules().create("RG", "profile1", "ruleSet1", "rule1",
            new RuleInner().withOrder(1)
                .withConditions(Arrays.asList(
                    new DeliveryRuleRequestMethodCondition().withParameters(new RequestMethodMatchConditionParameters()
                        .withOperator(RequestMethodOperator.EQUAL).withNegateCondition(false)
                        .withMatchValues(Arrays.asList(RequestMethodMatchConditionParametersMatchValuesItem.GET)))))
                .withActions(
                    Arrays.asList(new DeliveryRuleResponseHeaderAction().withParameters(new HeaderActionParameters()
                        .withHeaderAction(HeaderAction.OVERWRITE).withHeaderName("X-CDN").withValue("MSFT")))),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

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

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


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

    response = client.rules.begin_create(
        resource_group_name="RG",
        profile_name="profile1",
        rule_set_name="ruleSet1",
        rule_name="rule1",
        rule={
            "properties": {
                "actions": [
                    {
                        "name": "ModifyResponseHeader",
                        "parameters": {
                            "headerAction": "Overwrite",
                            "headerName": "X-CDN",
                            "typeName": "DeliveryRuleHeaderActionParameters",
                            "value": "MSFT",
                        },
                    }
                ],
                "conditions": [
                    {
                        "name": "RequestMethod",
                        "parameters": {
                            "matchValues": ["GET"],
                            "negateCondition": False,
                            "operator": "Equal",
                            "typeName": "DeliveryRuleRequestMethodConditionParameters",
                        },
                    }
                ],
                "order": 1,
            }
        },
    ).result()
    print(response)


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

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

Go

package armcdn_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Rules_Create.json
func ExampleRulesClient_BeginCreate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewRulesClient().BeginCreate(ctx, "RG", "profile1", "ruleSet1", "rule1", armcdn.Rule{
		Properties: &armcdn.RuleProperties{
			Actions: []armcdn.DeliveryRuleActionAutoGeneratedClassification{
				&armcdn.DeliveryRuleResponseHeaderAction{
					Name: to.Ptr(armcdn.DeliveryRuleActionModifyResponseHeader),
					Parameters: &armcdn.HeaderActionParameters{
						HeaderAction: to.Ptr(armcdn.HeaderActionOverwrite),
						HeaderName:   to.Ptr("X-CDN"),
						TypeName:     to.Ptr(armcdn.HeaderActionParametersTypeNameDeliveryRuleHeaderActionParameters),
						Value:        to.Ptr("MSFT"),
					},
				}},
			Conditions: []armcdn.DeliveryRuleConditionClassification{
				&armcdn.DeliveryRuleRequestMethodCondition{
					Name: to.Ptr(armcdn.MatchVariableRequestMethod),
					Parameters: &armcdn.RequestMethodMatchConditionParameters{
						MatchValues: []*armcdn.RequestMethodMatchConditionParametersMatchValuesItem{
							to.Ptr(armcdn.RequestMethodMatchConditionParametersMatchValuesItemGET)},
						NegateCondition: to.Ptr(false),
						Operator:        to.Ptr(armcdn.RequestMethodOperatorEqual),
						TypeName:        to.Ptr(armcdn.RequestMethodMatchConditionParametersTypeNameDeliveryRuleRequestMethodConditionParameters),
					},
				}},
			Order: to.Ptr[int32](1),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Rule = armcdn.Rule{
	// 	Name: to.Ptr("rule1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/rulesets/rules"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1"),
	// 	Properties: &armcdn.RuleProperties{
	// 		DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
	// 		ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
	// 		Actions: []armcdn.DeliveryRuleActionAutoGeneratedClassification{
	// 			&armcdn.DeliveryRuleResponseHeaderAction{
	// 				Name: to.Ptr(armcdn.DeliveryRuleActionModifyResponseHeader),
	// 				Parameters: &armcdn.HeaderActionParameters{
	// 					HeaderAction: to.Ptr(armcdn.HeaderActionOverwrite),
	// 					HeaderName: to.Ptr("X-CDN"),
	// 					TypeName: to.Ptr(armcdn.HeaderActionParametersTypeNameDeliveryRuleHeaderActionParameters),
	// 					Value: to.Ptr("MSFT"),
	// 				},
	// 		}},
	// 		Conditions: []armcdn.DeliveryRuleConditionClassification{
	// 			&armcdn.DeliveryRuleRequestMethodCondition{
	// 				Name: to.Ptr(armcdn.MatchVariableRequestMethod),
	// 				Parameters: &armcdn.RequestMethodMatchConditionParameters{
	// 					MatchValues: []*armcdn.RequestMethodMatchConditionParametersMatchValuesItem{
	// 						to.Ptr(armcdn.RequestMethodMatchConditionParametersMatchValuesItemGET)},
	// 						NegateCondition: to.Ptr(false),
	// 						Operator: to.Ptr(armcdn.RequestMethodOperatorEqual),
	// 						Transforms: []*armcdn.Transform{
	// 						},
	// 						TypeName: to.Ptr(armcdn.RequestMethodMatchConditionParametersTypeNameDeliveryRuleRequestMethodConditionParameters),
	// 					},
	// 			}},
	// 			MatchProcessingBehavior: to.Ptr(armcdn.MatchProcessingBehaviorContinue),
	// 			Order: to.Ptr[int32](1),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Creates a new delivery rule within the specified rule set.
 *
 * @summary Creates a new delivery rule within the specified rule set.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Rules_Create.json
 */
async function rulesCreate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const ruleSetName = "ruleSet1";
  const ruleName = "rule1";
  const rule = {
    actions: [
      {
        name: "ModifyResponseHeader",
        parameters: {
          headerAction: "Overwrite",
          headerName: "X-CDN",
          typeName: "DeliveryRuleHeaderActionParameters",
          value: "MSFT",
        },
      },
    ],
    conditions: [
      {
        name: "RequestMethod",
        parameters: {
          matchValues: ["GET"],
          negateCondition: false,
          operator: "Equal",
          typeName: "DeliveryRuleRequestMethodConditionParameters",
        },
      },
    ],
    order: 1,
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.rules.beginCreateAndWait(
    resourceGroupName,
    profileName,
    ruleSetName,
    ruleName,
    rule
  );
  console.log(result);
}

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

Sample Response

Status code:

200

{
  "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"
        }
      }
    ],
    "matchProcessingBehavior": "Continue",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Status code:

201

{
  "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"
        }
      }
    ],
    "matchProcessingBehavior": "Continue",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2023-05-01

Response Body

{
  "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"
        }
      }
    ],
    "matchProcessingBehavior": "Continue",
    "provisioningState": "Creating",
    "deploymentStatus": "NotStarted"
  }
}

定义

名称	说明
AfdErrorResponse	错误响应
AfdProvisioningState	预配状态
algorithm	用于 URL 签名的算法
cacheBehavior	请求的缓存行为
CacheConfiguration	缓存类型路由的缓存设置。 若要禁用缓存，请不要提供 cacheConfiguration 对象。
CacheExpirationActionParameters	定义缓存过期操作的参数。
CacheKeyQueryStringActionParameters	定义缓存键查询字符串操作的参数。
CacheType	需要缓存内容的级别。
ClientPortMatchConditionParameters	定义 ClientPort 匹配条件的参数
ClientPortOperator	描述要匹配的运算符
CookiesMatchConditionParameters	定义 Cookie 匹配条件的参数
CookiesOperator	描述要匹配的运算符
DeliveryRuleCacheExpirationAction	定义传递规则的缓存过期操作。
DeliveryRuleCacheKeyQueryStringAction	定义传递规则的 cache-key 查询字符串操作。
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 条件。
DeploymentStatus
DestinationProtocol	用于重定向的协议。 默认值为 MatchRequest
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ForwardingProtocol	将流量转发到后端时此规则将使用的协议。
HeaderAction	要执行的操作
HeaderActionParameters	定义请求标头操作的参数。
HostNameMatchConditionParameters	定义 HostName 匹配条件的参数
HostNameOperator	描述要匹配的运算符
HttpVersionMatchConditionParameters	定义 HttpVersion 匹配条件的参数
HttpVersionOperator	描述要匹配的运算符
IdentityType	创建/修改资源的标识类型
IsDeviceMatchConditionParameters	定义 IsDevice 匹配条件的参数
IsDeviceOperator	描述要匹配的运算符
MatchProcessingBehavior	如果此规则是匹配项，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。
MatchValues	传递规则条件的匹配值
OriginGroupOverride	定义源组替代配置的参数。
OriginGroupOverrideAction	定义传递规则的源组替代操作。
OriginGroupOverrideActionParameters	定义源组替代操作的参数。
paramIndicator	指示参数的用途
PostArgsMatchConditionParameters	定义 PostArgs 匹配条件的参数
PostArgsOperator	描述要匹配的运算符
queryStringBehavior	请求的缓存行为
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	请求的缓存行为
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 签名操作的参数。
UrlSigningParamIdentifier	定义如何标识特定用途的参数，例如过期

AfdErrorResponse

错误响应

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

AfdProvisioningState

预配状态

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

algorithm

用于 URL 签名的算法

名称	类型	说明
SHA256	string

cacheBehavior

请求的缓存行为

名称	类型	说明
BypassCache	string
Override	string
SetIfMissing	string

CacheConfiguration

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

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

CacheExpirationActionParameters

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

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

CacheKeyQueryStringActionParameters

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

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

CacheType

需要缓存内容的级别。

名称	类型	说明
All	string

ClientPortMatchConditionParameters

定义 ClientPort 匹配条件的参数

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

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	CookiesOperator		描述要匹配的运算符
selector	string		要匹配的 Cookie 的名称
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleCookiesConditionParameters

CookiesOperator

描述要匹配的运算符

名称	类型	说明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

DeliveryRuleCacheExpirationAction

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

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

DeliveryRuleCacheKeyQueryStringAction

定义传递规则的 cache-key 查询字符串操作。

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

DeliveryRuleClientPortCondition

定义传递规则的 ClientPort 条件。

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

DeliveryRuleCookiesCondition

定义传递规则的 Cookie 条件。

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

DeliveryRuleHostNameCondition

定义传递规则的 HostName 条件。

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

DeliveryRuleHttpVersionCondition

定义传递规则的 HttpVersion 条件。

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

DeliveryRuleIsDeviceCondition

定义传递规则的 IsDevice 条件。

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

DeliveryRulePostArgsCondition

定义传递规则的 PostArgs 条件。

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

DeliveryRuleQueryStringCondition

定义传递规则的 QueryString 条件。

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

DeliveryRuleRemoteAddressCondition

定义传递规则的 RemoteAddress 条件。

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

DeliveryRuleRequestBodyCondition

定义传递规则的 RequestBody 条件。

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

DeliveryRuleRequestHeaderAction

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

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

DeliveryRuleRequestHeaderCondition

定义传递规则的 RequestHeader 条件。

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

DeliveryRuleRequestMethodCondition

定义传递规则的 RequestMethod 条件。

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

DeliveryRuleRequestSchemeCondition

定义传递规则的 RequestScheme 条件。

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

DeliveryRuleRequestUriCondition

定义传递规则的 RequestUri 条件。

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

DeliveryRuleResponseHeaderAction

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

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

DeliveryRuleRouteConfigurationOverrideAction

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

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

DeliveryRuleServerPortCondition

定义传递规则的 ServerPort 条件。

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

DeliveryRuleSocketAddrCondition

定义传递规则的 SocketAddress 条件。

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

DeliveryRuleSslProtocolCondition

定义传递规则的 SslProtocol 条件。

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

DeliveryRuleUrlFileExtensionCondition

定义传递规则的 UrlFileExtension 条件。

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

DeliveryRuleUrlFileNameCondition

定义传递规则的 UrlFileName 条件。

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

DeliveryRuleUrlPathCondition

定义传递规则的 UrlPath 条件。

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

DeploymentStatus

名称	类型	说明
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

DestinationProtocol

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

名称	类型	说明
Http	string
Https	string
MatchRequest	string

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ForwardingProtocol

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

名称	类型	说明
HttpOnly	string
HttpsOnly	string
MatchRequest	string

HeaderAction

要执行的操作

名称	类型	说明
Append	string
Delete	string
Overwrite	string

HeaderActionParameters

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

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

HostNameMatchConditionParameters

定义 HostName 匹配条件的参数

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

HostNameOperator

描述要匹配的运算符

名称	类型	说明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

HttpVersionMatchConditionParameters

定义 HttpVersion 匹配条件的参数

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

HttpVersionOperator

描述要匹配的运算符

名称	类型	说明
Equal	string

IdentityType

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

名称	类型	说明
application	string
key	string
managedIdentity	string
user	string

IsDeviceMatchConditionParameters

定义 IsDevice 匹配条件的参数

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

IsDeviceOperator

描述要匹配的运算符

名称	类型	说明
Equal	string

MatchProcessingBehavior

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

名称	类型	说明
Continue	string
Stop	string

MatchValues

传递规则条件的匹配值

名称	类型	说明
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

OriginGroupOverride

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

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

OriginGroupOverrideAction

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

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

OriginGroupOverrideActionParameters

定义源组替代操作的参数。

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

paramIndicator

指示参数的用途

名称	类型	说明
Expires	string
KeyId	string
Signature	string

PostArgsMatchConditionParameters

定义 PostArgs 匹配条件的参数

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

PostArgsOperator

描述要匹配的运算符

名称	类型	说明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

queryStringBehavior

请求的缓存行为

名称	类型	说明
Exclude	string
ExcludeAll	string
Include	string
IncludeAll	string

QueryStringMatchConditionParameters

定义 QueryString 匹配条件的参数

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

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	RemoteAddressOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

描述要匹配的运算符

名称	类型	说明
Any	string
GeoMatch	string
IPMatch	string

RequestBodyMatchConditionParameters

定义 RequestBody 匹配条件的参数

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

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	RequestHeaderOperator		描述要匹配的运算符
selector	string		要匹配的标头的名称
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

描述要匹配的运算符

名称	类型	说明
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestMethodMatchConditionParameters

定义 RequestMethod 匹配条件的参数

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

RequestMethodOperator

描述要匹配的运算符

名称	类型	说明
Equal	string

RequestSchemeMatchConditionParameters

定义 RequestScheme 匹配条件的参数

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

RequestUriMatchConditionParameters

定义 RequestUri 匹配条件的参数

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

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。

RouteConfigurationOverrideActionParameters

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

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

Rule

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

名称	类型	默认值	说明
id	string		资源 ID。
name	string		资源名称。
properties.actions	DeliveryRuleAction[]: DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleRouteConfigurationOverrideAction[] OriginGroupOverrideAction[] UrlRedirectAction[] UrlRewriteAction[] UrlSigningAction[]		满足规则的所有条件时执行的操作列表。
properties.conditions	DeliveryRuleCondition[]: DeliveryRuleClientPortCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleQueryStringCondition[] DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleSslProtocolCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleUrlPathCondition[]		要执行的操作必须匹配的条件列表
properties.deploymentStatus	DeploymentStatus
properties.matchProcessingBehavior	MatchProcessingBehavior	Continue	如果此规则是匹配项，则规则引擎应继续运行剩余规则或停止。 如果不存在，则默认为“继续”。
properties.order	integer		为终结点应用规则的顺序。 可能的值 {0,1,2,3,.........}。 顺序较小的规则将在顺序较大的规则之前应用。 顺序为 0 的规则是一种特殊规则。 它不需要任何条件，并且将始终应用其中列出的操作。
properties.provisioningState	AfdProvisioningState		预配状态
properties.ruleSetName	string		包含规则的规则集的名称。
systemData	SystemData		只读系统数据
type	string		资源类型。

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	ServerPortOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleServerPortConditionParameters

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	SocketAddrOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

描述要匹配的运算符

名称	类型	说明
Any	string
IPMatch	string

SslProtocol

已建立的 TLS 连接的协议。

名称	类型	说明
TLSv1	string
TLSv1.1	string
TLSv1.2	string

SslProtocolMatchConditionParameters

定义 SslProtocol 匹配条件的参数

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

SslProtocolOperator

描述要匹配的运算符

名称	类型	说明
Equal	string

SystemData

只读系统数据

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC)
createdBy	string	创建资源的标识的标识符
createdByType	IdentityType	创建资源的标识类型
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识的标识符
lastModifiedByType	IdentityType	上次修改资源的标识类型

transform

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

名称	类型	说明
Lowercase	string
RemoveNulls	string
Trim	string
Uppercase	string
UrlDecode	string
UrlEncode	string

UrlFileExtensionMatchConditionParameters

定义 UrlFileExtension 匹配条件的参数

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

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	UrlFileNameOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleUrlFilenameConditionParameters

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	UrlPathOperator		描述要匹配的运算符
transforms	transform[]		转换列表
typeName	enum: DeliveryRuleUrlPathMatchConditionParameters

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: UrlRedirect	传递规则的操作的名称。
parameters	UrlRedirectActionParameters	定义操作的参数。

UrlRedirectActionParameters

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

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

UrlRewriteAction

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

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

UrlRewriteActionParameters

定义 URL 重写操作的参数。

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

UrlSigningAction

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

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

UrlSigningActionParameters

定义 URL 签名操作的参数。

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

UrlSigningParamIdentifier

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

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