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

Endpoints - Update

服务:

CDN

API 版本:

2024-02-01

在指定的订阅、资源组和配置文件下，汇报具有指定终结点名称的现有 CDN 终结点。 创建终结点后，只能更新标记。 若要更新源，请使用更新源操作。 若要更新源组，请使用更新源组操作。 若要更新自定义域，请使用更新Custom Domain操作。

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

URI 参数

名称	在	必需	类型	说明
endpointName	path	True	string	配置文件下全局唯一的终结点的名称。
profileName	path	True	string	资源组中唯一的 CDN 配置文件的名称。
resourceGroupName	path	True	string	Azure 订阅中资源组的名称。 正则表达式模式: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。 当前版本为 2024-02-01。

请求正文

名称	类型	说明
properties.contentTypesToCompress	string[]	应用压缩的内容类型列表。 该值应为有效的 MIME 类型。
properties.defaultOriginGroup	ResourceReference	对源组的引用。
properties.deliveryPolicy	DeliveryPolicy	指定要用于终结点的传递规则的策略。
properties.geoFilters	GeoFilter[]	定义 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	OptimizationType	指定客户希望此 CDN 终结点优化的方案，例如下载、媒体服务。 借助此信息，CDN 可以应用方案驱动的优化。
properties.originHostHeader	string	随每个请求一起发送到源的主机标头值。 仅当终结点使用单个源并且可由源中指定的同一属性重写时，才允许在终结点处使用此属性。如果将此留空，则请求主机名将确定此值。 Azure CDN 源（例如 Web 应用、Blob 存储和云服务）默认要求此主机头值与源主机名匹配。
properties.originPath	string	源上的目录路径，CDN 可用于从中检索内容，例如 contoso.cloudapp.net/originpath。
properties.probePath	string	源上托管的文件的路径，它有助于加速动态内容的交付，并计算 CDN 的最佳路由。 这是相对于源路径的。 仅当使用单个源时，此属性才相关。
properties.queryStringCachingBehavior	QueryStringCachingBehavior	定义 CDN 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串，绕过缓存以防止缓存包含查询字符串的请求，或者使用唯一 URL 缓存每个请求。
properties.urlSigningKeys	UrlSigningKey[]	用于验证已签名 URL 哈希的密钥列表。
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink	定义终结点 (的Web 应用程序防火墙策略（如果适用)
tags	object	终结点标记。

响应

名称	类型	说明
200 OK	Endpoint	没问题。 请求已成功。
202 Accepted	Endpoint	接受，操作将以异步方式完成 标头 location: string
Other Status Codes	ErrorResponse	描述操作失败原因的 CDN 错误响应

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Endpoints_Update

示例请求

HTTP

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

{
  "tags": {
    "additionalProperties": "Tag1"
  }
}

Java

import com.azure.resourcemanager.cdn.models.EndpointUpdateParameters;
import java.util.HashMap;
import java.util.Map;

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

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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 typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.cdn import CdnManagementClient

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

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


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

    response = client.endpoints.begin_update(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
        endpoint_update_properties={"tags": {"additionalProperties": "Tag1"}},
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Update.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/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Update.json
func ExampleEndpointsClient_BeginUpdate() {
	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.NewEndpointsClient().BeginUpdate(ctx, "RG", "profile1", "endpoint1", armcdn.EndpointUpdateParameters{
		Tags: map[string]*string{
			"additionalProperties": to.Ptr("Tag1"),
		},
	}, 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.Endpoint = armcdn.Endpoint{
	// 	Name: to.Ptr("endpoint1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1"),
	// 	Location: to.Ptr("WestCentralUs"),
	// 	Tags: map[string]*string{
	// 		"additionalProperties": to.Ptr("Tag1"),
	// 	},
	// 	Properties: &armcdn.EndpointProperties{
	// 		ContentTypesToCompress: []*string{
	// 		},
	// 		DefaultOriginGroup: &armcdn.ResourceReference{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"),
	// 		},
	// 		GeoFilters: []*armcdn.GeoFilter{
	// 		},
	// 		IsCompressionEnabled: to.Ptr(false),
	// 		IsHTTPAllowed: to.Ptr(true),
	// 		IsHTTPSAllowed: to.Ptr(true),
	// 		QueryStringCachingBehavior: to.Ptr(armcdn.QueryStringCachingBehaviorIgnoreQueryString),
	// 		HostName: to.Ptr("endpoint1.azureedge.net"),
	// 		OriginGroups: []*armcdn.DeepCreatedOriginGroup{
	// 			{
	// 				Name: to.Ptr("originGroup1"),
	// 				Properties: &armcdn.DeepCreatedOriginGroupProperties{
	// 					HealthProbeSettings: &armcdn.HealthProbeParameters{
	// 						ProbeIntervalInSeconds: to.Ptr[int32](120),
	// 						ProbePath: to.Ptr("/health.aspx"),
	// 						ProbeProtocol: to.Ptr(armcdn.ProbeProtocolHTTP),
	// 						ProbeRequestType: to.Ptr(armcdn.HealthProbeRequestTypeGET),
	// 					},
	// 					Origins: []*armcdn.ResourceReference{
	// 						{
	// 							ID: to.Ptr("/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"),
	// 					}},
	// 				},
	// 		}},
	// 		Origins: []*armcdn.DeepCreatedOrigin{
	// 			{
	// 				Name: to.Ptr("www-bing-com"),
	// 				Properties: &armcdn.DeepCreatedOriginProperties{
	// 					Enabled: to.Ptr(true),
	// 					HostName: to.Ptr("www.bing.com"),
	// 					HTTPPort: to.Ptr[int32](80),
	// 					HTTPSPort: to.Ptr[int32](443),
	// 					OriginHostHeader: to.Ptr("www.someDomain2.net"),
	// 					Priority: to.Ptr[int32](2),
	// 					Weight: to.Ptr[int32](50),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armcdn.EndpointProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.EndpointResourceStateCreating),
	// 	},
	// }
}

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 Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.
 *
 * @summary Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Update.json
 */
async function endpointsUpdate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const endpointUpdateProperties = {
    tags: { additionalProperties: "Tag1" },
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.endpoints.beginUpdateAndWait(
    resourceGroupName,
    profileName,
    endpointName,
    endpointUpdateProperties,
  );
  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

dotnet

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

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

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

// this example assumes you already have this CdnEndpointResource created on azure
// for more information of creating CdnEndpointResource, please refer to the document of CdnEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier cdnEndpointResourceId = CdnEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
CdnEndpointResource cdnEndpoint = client.GetCdnEndpointResource(cdnEndpointResourceId);

// invoke the operation
CdnEndpointPatch patch = new CdnEndpointPatch()
{
    Tags =
    {
    ["additionalProperties"] = "Tag1",
    },
};
ArmOperation<CdnEndpointResource> lro = await cdnEndpoint.UpdateAsync(WaitUntil.Completed, patch);
CdnEndpointResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CdnEndpointData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:

200

{
  "name": "endpoint1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "additionalProperties": "Tag1"
  },
  "location": "WestCentralUs",
  "properties": {
    "hostName": "endpoint1.azureedge.net",
    "originHostHeader": null,
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "IgnoreQueryString",
    "originPath": null,
    "origins": [
      {
        "name": "www-bing-com",
        "properties": {
          "hostName": "www.bing.com",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain2.net",
          "priority": 2,
          "weight": 50,
          "enabled": true
        }
      }
    ],
    "originGroups": [
      {
        "name": "originGroup1",
        "properties": {
          "healthProbeSettings": {
            "probePath": "/health.aspx",
            "probeRequestType": "GET",
            "probeProtocol": "Http",
            "probeIntervalInSeconds": 120
          },
          "origins": [
            {
              "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
            }
          ]
        }
      }
    ],
    "defaultOriginGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
    },
    "contentTypesToCompress": [],
    "isCompressionEnabled": false,
    "optimizationType": null,
    "probePath": null,
    "geoFilters": []
  }
}

状态代码:

202

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

{
  "name": "endpoint1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "additionalProperties": "Tag1"
  },
  "location": "WestCentralUs",
  "properties": {
    "hostName": "endpoint1.azureedge.net",
    "originHostHeader": null,
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "IgnoreQueryString",
    "originPath": null,
    "origins": [
      {
        "name": "www-bing-com",
        "properties": {
          "hostName": "www.bing.com",
          "httpPort": 80,
          "httpsPort": 443,
          "originHostHeader": "www.someDomain2.net",
          "priority": 2,
          "weight": 50,
          "enabled": true
        }
      }
    ],
    "originGroups": [
      {
        "name": "originGroup1",
        "properties": {
          "healthProbeSettings": {
            "probePath": "/health.aspx",
            "probeRequestType": "GET",
            "probeProtocol": "Http",
            "probeIntervalInSeconds": 120
          },
          "origins": [
            {
              "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com"
            }
          ]
        }
      }
    ],
    "contentTypesToCompress": [],
    "isCompressionEnabled": false,
    "optimizationType": null,
    "probePath": null,
    "geoFilters": [],
    "defaultOriginGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"
    }
  }
}

定义

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

algorithm

用于 URL 签名的算法

名称	类型	说明
SHA256	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

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	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	HealthProbeParameters	用于确定源运行状况的源的运行状况探测设置。
properties.origins	ResourceReference[]	通过给定源组中的 CDN 传递的内容的来源。
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	JSON 对象，该对象包含用于使用实际请求/响应确定源运行状况的属性。当前不支持此属性。
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	当运行不正常的终结点运行正常或添加新终结点时，逐渐将流量转移到终结点的时间（以分钟为单位）。 默认值为 10 分钟。 当前不支持此属性。

DeliveryPolicy

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

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

DeliveryRule

指定一组操作和条件的规则

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

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	定义条件的参数。

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	DeepCreatedCustomDomain[]		终结点下的自定义域。
properties.defaultOriginGroup	ResourceReference		对源组的引用。
properties.deliveryPolicy	DeliveryPolicy		一个策略，指定要用于终结点的传递规则。
properties.geoFilters	GeoFilter[]		定义用户在 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	OptimizationType		指定客户希望此 CDN 终结点优化的方案，例如下载、媒体服务。 通过此信息，CDN 可以应用方案驱动的优化。
properties.originGroups	DeepCreatedOriginGroup[]		源组，由源组成，用于根据可用性对流量进行负载均衡。
properties.originHostHeader	string		随每个请求一起发送到源的主机标头值。 仅当终结点使用单个源并且可由源中指定的同一属性重写时，才允许终结点中的此属性。如果将此留空，则请求主机名将确定此值。 Azure CDN 源（例如 Web 应用、Blob 存储和云服务）默认要求此主机头值与源主机名匹配。
properties.originPath	string		CDN 可用于从中检索内容的源上的目录路径，例如 contoso.cloudapp.net/originpath。
properties.origins	DeepCreatedOrigin[]		通过 CDN 传递的内容的源。
properties.probePath	string		源上托管的文件的路径，该路径有助于加速动态内容的传递，并计算 CDN 的最佳路由。 这是相对于源路径的。 仅当使用单个源时，此属性才相关。
properties.provisioningState	EndpointProvisioningState		终结点的预配状态。
properties.queryStringCachingBehavior	QueryStringCachingBehavior	NotSet	定义 CDN 如何缓存包含查询字符串的请求。 可以在缓存时忽略任何查询字符串，绕过缓存以防止缓存包含查询字符串的请求，或者使用唯一 URL 缓存每个请求。
properties.resourceState	EndpointResourceState		终结点的资源状态。
properties.urlSigningKeys	UrlSigningKey[]		用于验证已签名 URL 哈希的密钥列表。
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink		定义终结点 (的Web 应用程序防火墙策略（如果适用）)
systemData	SystemData		只读系统数据
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

EndpointUpdateParameters

创建或更新终结点所需的属性。

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

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

ForwardingProtocol

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

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

GeoFilter

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

名称	类型	说明
action	GeoFilterActions	地理筛选器的操作，即允许或阻止访问。
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	HeaderAction	要执行的操作
headerName	string	要修改的标头的名称
typeName	enum: DeliveryRuleHeaderActionParameters
value	string	指定操作的值

HealthProbeParameters

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

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

HealthProbeRequestType

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

名称	类型	说明
GET	string
HEAD	string
NotSet	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

HttpErrorRangeParameters

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

名称	类型	说明
begin	integer	http 状态代码范围的非独占开头。
end	integer	http 状态代码范围的非独占端。

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

KeyVaultSigningKeyParameters

介绍将用户的 KeyVault 用于 URL 签名密钥的参数。

名称	类型	说明
resourceGroupName	string	包含机密的用户密钥保管库的资源组
secretName	string	密钥保管库中的机密名称。
secretVersion	string	密钥保管库中机密的版本 (GUID) 。
subscriptionId	string	包含机密的用户密钥保管库的订阅 ID
typeName	enum: KeyVaultSigningKeyParameters
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	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

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	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。

ResponseBasedDetectedErrorTypes

将被视为不正常的真实用户请求的响应错误类型

名称	类型	说明
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

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

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

RouteConfigurationOverrideActionParameters

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

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

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

UrlSigningKey

URL 签名密钥

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

UrlSigningParamIdentifier

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

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

WebApplicationFirewallPolicyLink

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

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