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 參數

名稱	位於	必要	類型	Description
endpointName	path	True	string	配置檔下唯一的端點名稱。
profileName	path	True	string	資源群組內唯一的CDN配置檔名稱。
resourceGroupName	path	True	string	Azure 訂用帳戶內的資源組名。 Regex 模式: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure 訂用帳戶識別碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。 目前的版本是 2024-02-01。

要求本文

名稱	類型	Description
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 Apps、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	端點標籤。

回應

名稱	類型	Description
200 OK	Endpoint	正常。 要求已成功。
202 Accepted	Endpoint	已接受且作業會以異步方式完成 標題 location: string
Other Status Codes	ErrorResponse	描述作業失敗原因的CDN錯誤回應

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
    }
  }
}

定義

名稱	Description
algorithm	用於 URL 簽署的演算法
cacheBehavior	要求的快取行為
CacheConfiguration	快取類型路由的快取設定。 若要停用快取，請勿提供 cacheConfiguration 物件。
CacheExpirationActionParameters	定義快取到期動作的參數。
CacheKeyQueryStringActionParameters	定義快取索引鍵查詢字串動作的參數。
CacheType	需要快取內容的層級。
ClientPortMatchConditionParameters	定義 ClientPort 比對條件的參數
ClientPortOperator	描述要比對的運算符
CookiesMatchConditionParameters	定義 Cookie 比對條件的參數
CookiesOperator	描述要比對的運算符
DeepCreatedCustomDomain	在 CDN 端點上建立的自訂網域。
DeepCreatedOrigin	建立CDN端點時新增的CDN內容主要來源。
DeepCreatedOriginGroup	建立 CDN 端點時新增之 CDN 內容的源群組。 流量會根據原始健康情況傳送至來源群組內的來源。
DeliveryPolicy	原則，指定要用於端點的傳遞規則。
DeliveryRule	指定一組動作和條件的規則
DeliveryRuleCacheExpirationAction	定義傳遞規則的快取到期動作。
DeliveryRuleCacheKeyQueryStringAction	定義傳遞規則的快取索引鍵查詢字串動作。
DeliveryRuleClientPortCondition	定義傳遞規則的 ClientPort 條件。
DeliveryRuleCookiesCondition	定義傳遞規則的 Cookie 條件。
DeliveryRuleHostNameCondition	定義傳遞規則的 HostName 條件。
DeliveryRuleHttpVersionCondition	定義傳遞規則的 HttpVersion 條件。
DeliveryRuleIsDeviceCondition	定義傳遞規則的 IsDevice 條件。
DeliveryRulePostArgsCondition	定義傳遞規則的 PostArgs 條件。
DeliveryRuleQueryStringCondition	定義傳遞規則的QueryString條件。
DeliveryRuleRemoteAddressCondition	定義傳遞規則的 RemoteAddress 條件。
DeliveryRuleRequestBodyCondition	定義傳遞規則的 RequestBody 條件。
DeliveryRuleRequestHeaderAction	定義傳遞規則的要求標頭動作。
DeliveryRuleRequestHeaderCondition	定義傳遞規則的 RequestHeader 條件。
DeliveryRuleRequestMethodCondition	定義傳遞規則的 RequestMethod 條件。
DeliveryRuleRequestSchemeCondition	定義傳遞規則的 RequestScheme 條件。
DeliveryRuleRequestUriCondition	定義傳遞規則的 RequestUri 條件。
DeliveryRuleResponseHeaderAction	定義傳遞規則的回應標頭動作。
DeliveryRuleRouteConfigurationOverrideAction	定義傳遞規則的路由組態覆寫動作。 僅適用於 Frontdoor Standard/Premium Profiles。
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	線上至 Private Link 的核准狀態
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 簽署的演算法

名稱	類型	Description
SHA256	string

cacheBehavior

要求的快取行為

名稱	類型	Description
BypassCache	string
Override	string
SetIfMissing	string

CacheConfiguration

快取類型路由的快取設定。 若要停用快取，請勿提供 cacheConfiguration 物件。

名稱	類型	Description
cacheBehavior	ruleCacheBehavior	要求的快取行為
cacheDuration	string	需要快取內容的持續時間。 允許的格式為 [d.]hh：mm：ss
isCompressionEnabled	ruleIsCompressionEnabled	指出是否啟用內容壓縮。 如果啟用壓縮，如果使用者要求壓縮版本，則會將內容當做壓縮。 當要求的內容小於 1 位元組或大於 1 MB 時，將不會在 AzureFrontDoor 上壓縮內容。
queryParameters	string	要包含或排除 (逗號分隔) 的查詢參數。
queryStringCachingBehavior	ruleQueryStringCachingBehavior	定義 Frontdoor 如何快取包含查詢字串的要求。 您可以在快取、忽略特定查詢字串、使用唯一 URL 快取每個要求，或快取特定查詢字串時忽略任何查詢字串。

CacheExpirationActionParameters

定義快取到期動作的參數。

名稱	類型	Description
cacheBehavior	cacheBehavior	要求的快取行為
cacheDuration	string	需要快取內容的持續時間。 允許的格式為 [d.]hh：mm：ss
cacheType	CacheType	需要快取內容的層級。
typeName	enum: DeliveryRuleCacheExpirationActionParameters

CacheKeyQueryStringActionParameters

定義快取索引鍵查詢字串動作的參數。

名稱	類型	Description
queryParameters	string	要包含或排除 (逗號分隔) 的查詢參數。
queryStringBehavior	queryStringBehavior	要求的快取行為
typeName	enum: DeliveryRuleCacheKeyQueryStringBehaviorActionParameters

CacheType

需要快取內容的層級。

名稱	類型	Description
All	string

ClientPortMatchConditionParameters

定義 ClientPort 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	ClientPortOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleClientPortConditionParameters

ClientPortOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

CookiesMatchConditionParameters

定義 Cookie 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	CookiesOperator		描述要比對的運算符
selector	string		要比對的 Cookie 名稱
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleCookiesConditionParameters

CookiesOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

DeepCreatedCustomDomain

在 CDN 端點上建立的自訂網域。

名稱	類型	Description
name	string	自訂功能變數名稱。
properties.hostName	string	自定義網域的主機名。 必須是網域名稱。
properties.validationData	string	由於本機合規性原因，將CDN傳遞給某些區域時，可能需要特殊驗證或數據。 例如，必須有自定義網域的授權號碼，才能在中國傳遞內容。

DeepCreatedOrigin

建立CDN端點時新增的CDN內容主要來源。

名稱	類型	Description
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 Apps、Blob 記憶體和 雲端服務，預設需要此主機標頭值以符合原始主機名。
properties.priority	integer	指定原始來源群組中用於負載平衡的來源優先順序。 如果優先順序較低的來源狀況良好，則不會使用較高的優先順序來進行負載平衡。必須介於 1 到 5 之間。
properties.privateEndpointStatus	PrivateEndpointStatus	線上至 Private Link 的核准狀態
properties.privateLinkAlias	string	Private Link 資源的別名。 填入此選擇性欄位表示此來源為 「私人」
properties.privateLinkApprovalMessage	string	要包含在核准要求中以連線到 Private Link的自定義訊息。
properties.privateLinkLocation	string	Private Link 資源的位置。 只有在填入 『privateLinkResourceId』 時才需要
properties.privateLinkResourceId	string	Private Link 資源的資源標識碼。 填入此選擇性欄位表示此後端為「私人」
properties.weight	integer	指定原始來源群組中用於負載平衡的來源權數。 必須介於 1 到 1000 之間

DeepCreatedOriginGroup

建立 CDN 端點時新增之 CDN 內容的源群組。 流量會根據原始健康情況傳送至來源群組內的來源。

名稱	類型	Description
name	string	端點內必須是唯一的原點組名。
properties.healthProbeSettings	HealthProbeParameters	用於判斷來源健康情況的健全狀態探查設定。
properties.origins	ResourceReference[]	透過指定原始來源群組內 CDN 傳遞的內容來源。
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	JSON 物件，其中包含使用實際要求/回應來判斷原始健康情況的屬性。目前不支援這個屬性。
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	當狀況不良的端點狀況良好或新增新的端點時，以分鐘為單位逐漸將流量轉移至端點。 預設值為 10 分鐘。 目前不支援這個屬性。

DeliveryPolicy

原則，指定要用於端點的傳遞規則。

名稱	類型	Description
description	string	原則的用戶易記描述。
rules	DeliveryRule[]	傳遞規則的清單。

DeliveryRule

指定一組動作和條件的規則

名稱	類型	Description
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

定義傳遞規則的快取到期動作。

名稱	類型	Description
name	string: CacheExpiration	傳遞規則的動作名稱。
parameters	CacheExpirationActionParameters	定義動作的參數。

DeliveryRuleCacheKeyQueryStringAction

定義傳遞規則的快取索引鍵查詢字串動作。

名稱	類型	Description
name	string: CacheKeyQueryString	傳遞規則的動作名稱。
parameters	CacheKeyQueryStringActionParameters	定義動作的參數。

DeliveryRuleClientPortCondition

定義傳遞規則的 ClientPort 條件。

名稱	類型	Description
name	string: ClientPort	傳遞規則的條件名稱。
parameters	ClientPortMatchConditionParameters	定義條件的參數。

DeliveryRuleCookiesCondition

定義傳遞規則的 Cookie 條件。

名稱	類型	Description
name	string: Cookies	傳遞規則的條件名稱。
parameters	CookiesMatchConditionParameters	定義條件的參數。

DeliveryRuleHostNameCondition

定義傳遞規則的 HostName 條件。

名稱	類型	Description
name	string: HostName	傳遞規則的條件名稱。
parameters	HostNameMatchConditionParameters	定義條件的參數。

DeliveryRuleHttpVersionCondition

定義傳遞規則的 HttpVersion 條件。

名稱	類型	Description
name	string: HttpVersion	傳遞規則的條件名稱。
parameters	HttpVersionMatchConditionParameters	定義條件的參數。

DeliveryRuleIsDeviceCondition

定義傳遞規則的 IsDevice 條件。

名稱	類型	Description
name	string: IsDevice	傳遞規則的條件名稱。
parameters	IsDeviceMatchConditionParameters	定義條件的參數。

DeliveryRulePostArgsCondition

定義傳遞規則的 PostArgs 條件。

名稱	類型	Description
name	string: PostArgs	傳遞規則的條件名稱。
parameters	PostArgsMatchConditionParameters	定義條件的參數。

DeliveryRuleQueryStringCondition

定義傳遞規則的QueryString條件。

名稱	類型	Description
name	string: QueryString	傳遞規則的條件名稱。
parameters	QueryStringMatchConditionParameters	定義條件的參數。

DeliveryRuleRemoteAddressCondition

定義傳遞規則的 RemoteAddress 條件。

名稱	類型	Description
name	string: RemoteAddress	傳遞規則的條件名稱。
parameters	RemoteAddressMatchConditionParameters	定義條件的參數。

DeliveryRuleRequestBodyCondition

定義傳遞規則的 RequestBody 條件。

名稱	類型	Description
name	string: RequestBody	傳遞規則的條件名稱。
parameters	RequestBodyMatchConditionParameters	定義條件的參數。

DeliveryRuleRequestHeaderAction

定義傳遞規則的要求標頭動作。

名稱	類型	Description
name	string: ModifyRequestHeader	傳遞規則的動作名稱。
parameters	HeaderActionParameters	定義動作的參數。

DeliveryRuleRequestHeaderCondition

定義傳遞規則的 RequestHeader 條件。

名稱	類型	Description
name	string: RequestHeader	傳遞規則的條件名稱。
parameters	RequestHeaderMatchConditionParameters	定義條件的參數。

DeliveryRuleRequestMethodCondition

定義傳遞規則的 RequestMethod 條件。

名稱	類型	Description
name	string: RequestMethod	傳遞規則的條件名稱。
parameters	RequestMethodMatchConditionParameters	定義條件的參數。

DeliveryRuleRequestSchemeCondition

定義傳遞規則的 RequestScheme 條件。

名稱	類型	Description
name	string: RequestScheme	傳遞規則的條件名稱。
parameters	RequestSchemeMatchConditionParameters	定義條件的參數。

DeliveryRuleRequestUriCondition

定義傳遞規則的 RequestUri 條件。

名稱	類型	Description
name	string: RequestUri	傳遞規則的條件名稱。
parameters	RequestUriMatchConditionParameters	定義條件的參數。

DeliveryRuleResponseHeaderAction

定義傳遞規則的回應標頭動作。

名稱	類型	Description
name	string: ModifyResponseHeader	傳遞規則的動作名稱。
parameters	HeaderActionParameters	定義動作的參數。

DeliveryRuleRouteConfigurationOverrideAction

定義傳遞規則的路由組態覆寫動作。 僅適用於 Frontdoor Standard/Premium Profiles。

名稱	類型	Description
name	string: RouteConfigurationOverride	傳遞規則的動作名稱。
parameters	RouteConfigurationOverrideActionParameters	定義動作的參數。

DeliveryRuleServerPortCondition

定義傳遞規則的 ServerPort 條件。

名稱	類型	Description
name	string: ServerPort	傳遞規則的條件名稱。
parameters	ServerPortMatchConditionParameters	定義條件的參數。

DeliveryRuleSocketAddrCondition

定義傳遞規則的 SocketAddress 條件。

名稱	類型	Description
name	string: SocketAddr	傳遞規則的條件名稱。
parameters	SocketAddrMatchConditionParameters	定義條件的參數。

DeliveryRuleSslProtocolCondition

定義傳遞規則的 SslProtocol 條件。

名稱	類型	Description
name	string: SslProtocol	傳遞規則的條件名稱。
parameters	SslProtocolMatchConditionParameters	定義條件的參數。

DeliveryRuleUrlFileExtensionCondition

定義傳遞規則的 UrlFileExtension 條件。

名稱	類型	Description
name	string: UrlFileExtension	傳遞規則的條件名稱。
parameters	UrlFileExtensionMatchConditionParameters	定義條件的參數。

DeliveryRuleUrlFileNameCondition

定義傳遞規則的 UrlFileName 條件。

名稱	類型	Description
name	string: UrlFileName	傳遞規則的條件名稱。
parameters	UrlFileNameMatchConditionParameters	定義條件的參數。

DeliveryRuleUrlPathCondition

定義傳遞規則的 UrlPath 條件。

名稱	類型	Description
name	string: UrlPath	傳遞規則的條件名稱。
parameters	UrlPathMatchConditionParameters	定義條件的參數。

DestinationProtocol

要用於重新導向的通訊協定。 預設值為 MatchRequest

名稱	類型	Description
Http	string
Https	string
MatchRequest	string

Endpoint

CDN 端點是CDN配置檔內的實體，其中包含設定資訊，例如來源、通訊協定、內容快取和傳遞行為。 CDN 端點會使用 URL 格式 .azureedge.net。

名稱	類型	預設值	Description
id	string		資源識別碼。
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 Apps、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

端點的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

EndpointResourceState

端點的資源狀態。

名稱	類型	Description
Creating	string
Deleting	string
Running	string
Starting	string
Stopped	string
Stopping	string

EndpointUpdateParameters

建立或更新端點所需的屬性。

名稱	類型	預設值	Description
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 Apps、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

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細資料。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ForwardingProtocol

將流量轉送至後端時，此規則將使用的通訊協定。

名稱	類型	Description
HttpOnly	string
HttpsOnly	string
MatchRequest	string

GeoFilter

定義CDN端點內使用者異地存取的規則。

名稱	類型	Description
action	GeoFilterActions	異地篩選的動作，也就是允許或封鎖存取。
countryCodes	string[]	在地理篩選中定義用戶國家或地區存取的兩個字母國家或地區代碼，例如AU、MX、US。
relativePath	string	適用於地理篩選的相對路徑。 (例如 '/mypictures'、'/mypicture/kitty.jpg'等等 )

GeoFilterActions

異地篩選的動作，也就是允許或封鎖存取。

名稱	類型	Description
Allow	string
Block	string

HeaderAction

要執行的動作

名稱	類型	Description
Append	string
Delete	string
Overwrite	string

HeaderActionParameters

定義要求標頭動作的參數。

名稱	類型	Description
headerAction	HeaderAction	要執行的動作
headerName	string	要修改的標頭名稱
typeName	enum: DeliveryRuleHeaderActionParameters
value	string	指定動作的值

HealthProbeParameters

JSON 物件，其中包含將健康情況探查傳送至來源的屬性。

名稱	類型	Description
probeIntervalInSeconds	integer	健康情況探查之間的秒數。預設值為240秒。
probePath	string	相對於來源的路徑，用來判斷原點的健康情況。
probeProtocol	ProbeProtocol	用於健康情況探查的通訊協定。
probeRequestType	HealthProbeRequestType	所提出健康情況探查要求的型別。

HealthProbeRequestType

所提出健康情況探查要求的型別。

名稱	類型	Description
GET	string
HEAD	string
NotSet	string

HostNameMatchConditionParameters

定義 HostName 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	HostNameOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleHostNameConditionParameters

HostNameOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

HttpErrorRangeParameters

表示 HTTP 狀態代碼範圍的 JSON 物件

名稱	類型	Description
begin	integer	HTTP 狀態代碼範圍的內含開始。
end	integer	HTTP 狀態代碼範圍的內含結尾。

HttpVersionMatchConditionParameters

定義 HttpVersion 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	HttpVersionOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleHttpVersionConditionParameters

HttpVersionOperator

描述要比對的運算符

名稱	類型	Description
Equal	string

IdentityType

建立/修改資源的身分識別類型

名稱	類型	Description
application	string
key	string
managedIdentity	string
user	string

IsDeviceMatchConditionParameters

定義 IsDevice 比對條件的參數

名稱	類型	預設值	Description
matchValues	MatchValues[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	IsDeviceOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleIsDeviceConditionParameters

IsDeviceOperator

描述要比對的運算符

名稱	類型	Description
Equal	string

KeyVaultSigningKeyParameters

描述使用使用者 KeyVault 進行 URL 簽署金鑰的參數。

名稱	類型	Description
resourceGroupName	string	包含秘密的使用者 金鑰保存庫 資源群組
secretName	string	金鑰保存庫 中的秘密名稱。
secretVersion	string	金鑰保存庫 中秘密的版本 (GUID) 。
subscriptionId	string	包含秘密的使用者 金鑰保存庫 訂用帳戶標識碼
typeName	enum: KeyVaultSigningKeyParameters
vaultName	string	包含秘密的使用者 金鑰保存庫 名稱

MatchValues

傳遞規則條件的相符值

名稱	類型	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

OptimizationType

指定客戶想要此 CDN 端點優化的情況，例如下載、媒體服務。 透過這項資訊，我們可以套用案例驅動優化。

名稱	類型	Description
DynamicSiteAcceleration	string
GeneralMediaStreaming	string
GeneralWebDelivery	string
LargeFileDownload	string
VideoOnDemandMediaStreaming	string

OriginGroupOverride

定義源群組覆寫組態的參數。

名稱	類型	Description
forwardingProtocol	ForwardingProtocol	將流量轉送至後端時，此規則將使用的通訊協定。
originGroup	ResourceReference	定義會覆寫 Route 上 DefaultOriginGroup 的 OriginGroup。

OriginGroupOverrideAction

定義傳遞規則的原始群組覆寫動作。

名稱	類型	Description
name	string: OriginGroupOverride	傳遞規則的動作名稱。
parameters	OriginGroupOverrideActionParameters	定義動作的參數。

OriginGroupOverrideActionParameters

定義源群組覆寫動作的參數。

名稱	類型	Description
originGroup	ResourceReference	會定義會覆寫 DefaultOriginGroup 的 OriginGroup。
typeName	enum: DeliveryRuleOriginGroupOverrideActionParameters

paramIndicator

指出參數的用途

名稱	類型	Description
Expires	string
KeyId	string
Signature	string

PostArgsMatchConditionParameters

定義 PostArgs 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	PostArgsOperator		描述要比對的運算符
selector	string		要比對的 PostArg 名稱
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRulePostArgsConditionParameters

PostArgsOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

PrivateEndpointStatus

線上至 Private Link 的核准狀態

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

ProbeProtocol

用於健康情況探查的通訊協定。

名稱	類型	Description
Http	string
Https	string
NotSet	string

queryStringBehavior

要求的快取行為

名稱	類型	Description
Exclude	string
ExcludeAll	string
Include	string
IncludeAll	string

QueryStringCachingBehavior

定義CDN如何快取包含查詢字串的要求。 您可以在快取時忽略任何查詢字串、略過快取，以防止包含查詢字串的要求遭到快取，或使用唯一 URL 快取每個要求。

名稱	類型	Description
BypassCaching	string
IgnoreQueryString	string
NotSet	string
UseQueryString	string

QueryStringMatchConditionParameters

定義 QueryString 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	QueryStringOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleQueryStringConditionParameters

QueryStringOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RedirectType

重新導向流量時，規則將使用的重新導向類型。

名稱	類型	Description
Found	string
Moved	string
PermanentRedirect	string
TemporaryRedirect	string

RemoteAddressMatchConditionParameters

定義 RemoteAddress 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		比對要比對的值。 運算子會套用至此處具有 OR 語意的每個值。 如果其中任何一個符合指定運算子的變數，則此比對條件會被視為相符。
negateCondition	boolean	False	描述這是否為否定條件
operator	RemoteAddressOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

描述要比對的運算符

名稱	類型	Description
Any	string
GeoMatch	string
IPMatch	string

RequestBodyMatchConditionParameters

定義 RequestBody 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	RequestBodyOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleRequestBodyConditionParameters

RequestBodyOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestHeaderMatchConditionParameters

定義 RequestHeader 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	RequestHeaderOperator		描述要比對的運算符
selector	string		要比對的標頭名稱
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestMethodMatchConditionParameters

定義 RequestMethod 比對條件的參數

名稱	類型	預設值	Description
matchValues	MatchValues[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	RequestMethodOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleRequestMethodConditionParameters

RequestMethodOperator

描述要比對的運算符

名稱	類型	Description
Equal	string

RequestSchemeMatchConditionParameters

定義 RequestScheme 比對條件的參數

名稱	類型	預設值	Description
matchValues	MatchValues[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	enum: Equal		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleRequestSchemeConditionParameters

RequestUriMatchConditionParameters

定義 RequestUri 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	RequestUriOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleRequestUriConditionParameters

RequestUriOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

ResourceReference

另一個資源的參考。

名稱	類型	Description
id	string	資源識別碼。

ResponseBasedDetectedErrorTypes

實際使用者要求將被視為狀況不良的回應錯誤類型

名稱	類型	Description
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

JSON 物件，其中包含使用實際要求/回應來判斷原始健康情況的屬性。

名稱	類型	Description
httpErrorRanges	HttpErrorRangeParameters[]	視為來源伺服器錯誤且標示為狀況不良的 Http 狀態代碼範圍清單。
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	實際使用者要求將被視為狀況不良的回應錯誤類型
responseBasedFailoverThresholdPercentage	integer	範例中應觸發故障轉移的要求失敗百分比。

RouteConfigurationOverrideActionParameters

定義路由組態覆寫動作的參數。

名稱	類型	Description
cacheConfiguration	CacheConfiguration	與此規則相關聯的快取組態。 若要停用快取，請勿提供 cacheConfiguration 物件。
originGroupOverride	OriginGroupOverride	源群組覆寫組態的參考。 保留空白，以在路由上使用預設原始來源群組。
typeName	enum: DeliveryRuleRouteConfigurationOverrideActionParameters

ruleCacheBehavior

要求的快取行為

名稱	類型	Description
HonorOrigin	string
OverrideAlways	string
OverrideIfOriginMissing	string

ruleIsCompressionEnabled

指出是否啟用內容壓縮。 如果啟用壓縮，如果使用者要求壓縮版本，則會將內容當做壓縮。 當要求的內容小於 1 位元組或大於 1 MB 時，將不會在 AzureFrontDoor 上壓縮內容。

名稱	類型	Description
Disabled	string
Enabled	string

ruleQueryStringCachingBehavior

定義 Frontdoor 如何快取包含查詢字串的要求。 您可以在快取、忽略特定查詢字串、使用唯一 URL 快取每個要求，或快取特定查詢字串時忽略任何查詢字串。

名稱	類型	Description
IgnoreQueryString	string
IgnoreSpecifiedQueryStrings	string
IncludeSpecifiedQueryStrings	string
UseQueryString	string

ServerPortMatchConditionParameters

定義 ServerPort 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	ServerPortOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleServerPortConditionParameters

ServerPortOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

SocketAddrMatchConditionParameters

定義 SocketAddress 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	SocketAddrOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

描述要比對的運算符

名稱	類型	Description
Any	string
IPMatch	string

SslProtocol

已建立 TLS 連線的通訊協定。

名稱	類型	Description
TLSv1	string
TLSv1.1	string
TLSv1.2	string

SslProtocolMatchConditionParameters

定義 SslProtocol 比對條件的參數

名稱	類型	預設值	Description
matchValues	SslProtocol[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	SslProtocolOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleSslProtocolConditionParameters

SslProtocolOperator

描述要比對的運算符

名稱	類型	Description
Equal	string

SystemData

唯讀系統數據

名稱	類型	Description
createdAt	string	資源建立的時間戳 (UTC)
createdBy	string	建立資源的身分識別標識碼
createdByType	IdentityType	建立資源的身分識別類型
lastModifiedAt	string	上次修改的資源時間戳 (UTC)
lastModifiedBy	string	上次修改資源的身分識別標識碼
lastModifiedByType	IdentityType	上次修改資源的身分識別類型

transform

描述比對之前套用的轉換

名稱	類型	Description
Lowercase	string
RemoveNulls	string
Trim	string
Uppercase	string
UrlDecode	string
UrlEncode	string

UrlFileExtensionMatchConditionParameters

定義 UrlFileExtension 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	UrlFileExtensionOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleUrlFileExtensionMatchConditionParameters

UrlFileExtensionOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlFileNameMatchConditionParameters

定義 UrlFilename 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	UrlFileNameOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleUrlFilenameConditionParameters

UrlFileNameOperator

描述要比對的運算符

名稱	類型	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlPathMatchConditionParameters

定義 UrlPath 比對條件的參數

名稱	類型	預設值	Description
matchValues	string[]		傳遞規則條件的相符值
negateCondition	boolean	False	描述這是否為否定條件
operator	UrlPathOperator		描述要比對的運算符
transforms	transform[]		轉換的清單
typeName	enum: DeliveryRuleUrlPathMatchConditionParameters

UrlPathOperator

描述要比對的運算符

名稱	類型	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 重新導向動作。

名稱	類型	Description
name	string: UrlRedirect	傳遞規則的動作名稱。
parameters	UrlRedirectActionParameters	定義動作的參數。

UrlRedirectActionParameters

定義 URL 重新導向動作的參數。

名稱	類型	Description
customFragment	string	要新增至重新導向 URL 的片段。 片段是 #之后 URL 的一部分。 請勿包含 #。
customHostname	string	要重新導向的主機。 保留空白，以使用傳入主機作為目的地主機。
customPath	string	要重新導向的完整路徑。 路徑不能是空的，而且必須以 /開頭。 保留空白，以使用傳入路徑作為目的地路徑。
customQueryString	string	要放在重新導向 URL 中的查詢字串集合。 設定此值會取代任何現有的查詢字串;保留空白以保留傳入查詢字串。 查詢字串必須是 = 格式。 ? 和 & 會自動新增，因此請勿包含它們。
destinationProtocol	DestinationProtocol	用於重新導向的通訊協定。 預設值為 MatchRequest
redirectType	RedirectType	重新導向流量時，規則將使用的重新導向類型。
typeName	enum: DeliveryRuleUrlRedirectActionParameters

UrlRewriteAction

定義傳遞規則的 URL 重寫動作。

名稱	類型	Description
name	string: UrlRewrite	傳遞規則的動作名稱。
parameters	UrlRewriteActionParameters	定義動作的參數。

UrlRewriteActionParameters

定義 URL 重寫動作的參數。

名稱	類型	Description
destination	string	定義將重寫上述要求的相對URL。
preserveUnmatchedPath	boolean	是否要保留不相符的路徑。 預設值為 true。
sourcePattern	string	定義可識別可能重寫之要求類型的要求 URI 模式。 如果 value 為空白，則會比對所有字串。
typeName	enum: DeliveryRuleUrlRewriteActionParameters

UrlSigningAction

定義傳遞規則的 URL 簽署動作。

名稱	類型	Description
name	string: UrlSigning	傳遞規則的動作名稱。
parameters	UrlSigningActionParameters	定義動作的參數。

UrlSigningActionParameters

定義 URL 簽署動作的參數。

名稱	類型	Description
algorithm	algorithm	用於 URL 簽署的演算法
parameterNameOverride	UrlSigningParamIdentifier[]	定義 URL 中要視為到期、金鑰標識碼等的查詢字串參數。
typeName	enum: DeliveryRuleUrlSigningActionParameters

UrlSigningKey

URL 簽署金鑰

名稱	類型	Description
keyId	string	定義客戶定義的金鑰識別碼。此標識碼會存在於傳入要求中，以指出用來形成哈希的索引鍵。
keySourceParameters	KeyVaultSigningKeyParameters	定義參數，以針對 URL 簽署金鑰使用客戶金鑰保存庫。

UrlSigningParamIdentifier

定義如何識別特定用途的參數，例如到期

名稱	類型	Description
paramIndicator	paramIndicator	指出參數的用途
paramName	string	參數名稱

WebApplicationFirewallPolicyLink

如果適用) ，請定義端點 (Web 應用程式防火牆 原則

名稱	類型	Description
id	string	資源識別碼。