Rules - Get

服務:: Front Door Service

API 版本:: 2025-04-15

取得規則集中的現有傳遞規則。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}?api-version=2025-04-15

URI 參數

名稱	位於	必要	類型	Description
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Azure Front Door Standard 或 Azure Front Door Premium 的名稱，在資源群組中是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
ruleName	path	True	string	端點內唯一的傳遞規則名稱。
ruleSetName	path	True	string	配置檔底下的規則集名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	Rule	還行
Other Status Codes	ErrorResponse	描述作業失敗原因的 Azure Front Door 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Rules_Get

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1/rules/rule1?api-version=2025-04-15

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/2025-04-15/examples/Rules_Get.json
// this example is just showing the usage of "FrontDoorRules_Get" 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 FrontDoorRuleResource created on azure
// for more information of creating FrontDoorRuleResource, please refer to the document of FrontDoorRuleResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string ruleSetName = "ruleSet1";
string ruleName = "rule1";
ResourceIdentifier frontDoorRuleResourceId = FrontDoorRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, ruleSetName, ruleName);
FrontDoorRuleResource frontDoorRule = client.GetFrontDoorRuleResource(frontDoorRuleResourceId);

// invoke the operation
FrontDoorRuleResource result = await frontDoorRule.GetAsync();

// 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
FrontDoorRuleData 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": "rule1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1",
  "type": "Microsoft.Cdn/profiles/rulesets/rules",
  "properties": {
    "order": 1,
    "conditions": [
      {
        "name": "RequestMethod",
        "parameters": {
          "typeName": "DeliveryRuleRequestMethodConditionParameters",
          "operator": "Equal",
          "matchValues": [
            "GET"
          ],
          "negateCondition": false,
          "transforms": []
        }
      }
    ],
    "actions": [
      {
        "name": "ModifyResponseHeader",
        "parameters": {
          "typeName": "DeliveryRuleHeaderActionParameters",
          "headerAction": "Overwrite",
          "headerName": "X-CDN",
          "value": "MSFT"
        }
      }
    ],
    "matchProcessingBehavior": "Continue",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

定義

名稱	Description
AfdProvisioningState	佈建狀態
algorithm	用於 URL 簽署的演算法
cacheBehavior	要求的快取行為
CacheConfiguration	快取類型路由的快取設定。若要停用快取，請勿提供 cacheConfiguration 物件。
CacheExpirationActionParameters	定義快取到期動作的參數。
CacheKeyQueryStringActionParameters	定義快取索引鍵查詢字串動作的參數。
CacheType	內容需要快取的層級。
ClientPortMatchConditionParameters	定義 ClientPort 比對條件的參數
ClientPortOperator	描述要比對的運算符
CookiesMatchConditionParameters	定義 Cookie 比對條件的參數
CookiesOperator	描述要比對的運算符
createdByType	建立資源的身分識別類型。
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 配置檔。
DeliveryRuleServerPortCondition	定義傳遞規則的 ServerPort 條件。
DeliveryRuleSocketAddrCondition	定義傳遞規則的 SocketAddress 條件。
DeliveryRuleSslProtocolCondition	定義傳遞規則的 SslProtocol 條件。
DeliveryRuleUrlFileExtensionCondition	定義傳遞規則的 UrlFileExtension 條件。
DeliveryRuleUrlFileNameCondition	定義傳遞規則的 UrlFileName 條件。
DeliveryRuleUrlPathCondition	定義傳遞規則的 UrlPath 條件。
DeploymentStatus
DestinationProtocol	要用於重新導向的通訊協定。預設值為 MatchRequest
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ForwardingProtocol	將流量轉送至後端時，會使用此規則的通訊協定。
HeaderAction	要執行的動作
HeaderActionParameters	定義要求標頭動作的參數。
HostNameMatchConditionParameters	定義 HostName 比對條件的參數
HostNameOperator	描述要比對的運算符
HttpVersionMatchConditionParameters	定義 HttpVersion 比對條件的參數
HttpVersionOperator	描述要比對的運算符
IsDeviceMatchConditionParameters	定義 IsDevice 比對條件的參數
IsDeviceMatchValue	傳遞規則條件的比對值
IsDeviceOperator	描述要比對的運算符
MatchProcessingBehavior	如果此規則相符，規則引擎應該繼續執行其餘規則或停止。如果不存在，則預設為 [繼續]。
OriginGroupOverride	定義源群組覆寫組態的參數。
OriginGroupOverrideAction	定義傳遞規則的源群組覆寫動作。
OriginGroupOverrideActionParameters	定義源群組覆寫動作的參數。
paramIndicator	指出參數的用途
PostArgsMatchConditionParameters	定義 PostArgs 比對條件的參數
PostArgsOperator	描述要比對的運算符
queryStringBehavior	要求的快取行為
QueryStringMatchConditionParameters	定義 QueryString 比對條件的參數
QueryStringOperator	描述要比對的運算符
RedirectType	重新導向類型，規則會在重新導向流量時使用。
RemoteAddressMatchConditionParameters	定義 RemoteAddress 比對條件的參數
RemoteAddressOperator	描述要比對的運算符
RequestBodyMatchConditionParameters	定義 RequestBody 比對條件的參數
RequestBodyOperator	描述要比對的運算符
RequestHeaderMatchConditionParameters	定義 RequestHeader 比對條件的參數
RequestHeaderOperator	描述要比對的運算符
RequestMethodMatchConditionParameters	定義 RequestMethod 比對條件的參數
RequestMethodMatchValue	傳遞規則條件的比對值
RequestMethodOperator	描述要比對的運算符
RequestSchemeMatchConditionParameters	定義 RequestScheme 比對條件的參數
RequestSchemeMatchValue	傳遞規則條件的比對值
RequestUriMatchConditionParameters	定義 RequestUri 比對條件的參數
RequestUriOperator	描述要比對的運算符
ResourceReference	另一個資源的參考。
RouteConfigurationOverrideActionParameters	定義路由組態覆寫動作的參數。
Rule	易記規則名稱對應至任何規則或秘密相關信息。
ruleCacheBehavior	要求的快取行為
ruleIsCompressionEnabled	指出是否啟用內容壓縮。如果啟用壓縮，如果使用者要求壓縮版本，內容將會做為壓縮。當要求的內容小於 1 位元組或大於 1 MB 時，將不會在 AzureFrontDoor 上壓縮內容。
ruleQueryStringCachingBehavior	定義 Frontdoor 如何快取包含查詢字串的要求。您可以在快取、忽略特定查詢字串、使用唯一 URL 快取每個要求，或快取特定查詢字串時忽略任何查詢字串。
ServerPortMatchConditionParameters	定義 ServerPort 比對條件的參數
ServerPortOperator	描述要比對的運算符
SocketAddrMatchConditionParameters	定義 SocketAddress 比對條件的參數
SocketAddrOperator	描述要比對的運算符
SslProtocol	所建立 TLS 連線的通訊協定。
SslProtocolMatchConditionParameters	定義 SslProtocol 比對條件的參數
SslProtocolOperator	描述要比對的運算符
systemData	與建立和上次修改資源相關的元數據。
transform	描述比對之前套用的轉換
UrlFileExtensionMatchConditionParameters	定義 UrlFileExtension 比對條件的參數
UrlFileExtensionOperator	描述要比對的運算符
UrlFileNameMatchConditionParameters	定義 UrlFilename 比對條件的參數
UrlFileNameOperator	描述要比對的運算符
UrlPathMatchConditionParameters	定義 UrlPath 比對條件的參數
UrlPathOperator	描述要比對的運算符
UrlRedirectAction	定義傳遞規則的 URL 重新導向動作。
UrlRedirectActionParameters	定義 URL 重新導向動作的參數。
UrlRewriteAction	定義傳遞規則的 URL 重寫動作。
UrlRewriteActionParameters	定義 URL 重寫動作的參數。
UrlSigningAction	定義傳遞規則的 URL 簽署動作。
UrlSigningActionParameters	定義 URL 簽署動作的參數。
UrlSigningParamIdentifier	定義如何識別特定用途的參數，例如到期

AfdProvisioningState

列舉型別

佈建狀態

值	Description
Creating
Deleting
Failed
Succeeded
Updating

algorithm

列舉型別

用於 URL 簽署的演算法

值	Description
SHA256

cacheBehavior

列舉型別

要求的快取行為

值	Description
BypassCache
Override
SetIfMissing

CacheConfiguration

Object

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

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

CacheExpirationActionParameters

Object

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

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

CacheKeyQueryStringActionParameters

Object

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

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

CacheType

列舉型別

內容需要快取的層級。

值	Description
All

ClientPortMatchConditionParameters

Object

定義 ClientPort 比對條件的參數

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

ClientPortOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

CookiesMatchConditionParameters

Object

定義 Cookie 比對條件的參數

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

CookiesOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

DeliveryRuleCacheExpirationAction

Object

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

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

DeliveryRuleCacheKeyQueryStringAction

Object

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

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

DeliveryRuleClientPortCondition

Object

定義傳遞規則的 ClientPort 條件。

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

DeliveryRuleCookiesCondition

Object

定義傳遞規則的 Cookie 條件。

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

DeliveryRuleHostNameCondition

Object

定義傳遞規則的 HostName 條件。

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

DeliveryRuleHttpVersionCondition

Object

定義傳遞規則的 HttpVersion 條件。

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

DeliveryRuleIsDeviceCondition

Object

定義傳遞規則的 IsDevice 條件。

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

DeliveryRulePostArgsCondition

Object

定義傳遞規則的 PostArgs 條件。

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

DeliveryRuleQueryStringCondition

Object

定義傳遞規則的QueryString條件。

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

DeliveryRuleRemoteAddressCondition

Object

定義傳遞規則的 RemoteAddress 條件。

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

DeliveryRuleRequestBodyCondition

Object

定義傳遞規則的 RequestBody 條件。

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

DeliveryRuleRequestHeaderAction

Object

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

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

DeliveryRuleRequestHeaderCondition

Object

定義傳遞規則的 RequestHeader 條件。

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

DeliveryRuleRequestMethodCondition

Object

定義傳遞規則的 RequestMethod 條件。

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

DeliveryRuleRequestSchemeCondition

Object

定義傳遞規則的 RequestScheme 條件。

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

DeliveryRuleRequestUriCondition

Object

定義傳遞規則的 RequestUri 條件。

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

DeliveryRuleResponseHeaderAction

Object

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

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

DeliveryRuleRouteConfigurationOverrideAction

Object

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

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

DeliveryRuleServerPortCondition

Object

定義傳遞規則的 ServerPort 條件。

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

DeliveryRuleSocketAddrCondition

Object

定義傳遞規則的 SocketAddress 條件。

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

DeliveryRuleSslProtocolCondition

Object

定義傳遞規則的 SslProtocol 條件。

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

DeliveryRuleUrlFileExtensionCondition

Object

定義傳遞規則的 UrlFileExtension 條件。

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

DeliveryRuleUrlFileNameCondition

Object

定義傳遞規則的 UrlFileName 條件。

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

DeliveryRuleUrlPathCondition

Object

定義傳遞規則的 UrlPath 條件。

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

DeploymentStatus

列舉型別

值	Description
Failed
InProgress
NotStarted
Succeeded

DestinationProtocol

列舉型別

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

值	Description
Http
Https
MatchRequest

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細數據。

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

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ForwardingProtocol

列舉型別

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

值	Description
HttpOnly
HttpsOnly
MatchRequest

HeaderAction

列舉型別

要執行的動作

值	Description
Append
Delete
Overwrite

HeaderActionParameters

Object

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

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

HostNameMatchConditionParameters

Object

定義 HostName 比對條件的參數

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

HostNameOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

HttpVersionMatchConditionParameters

Object

定義 HttpVersion 比對條件的參數

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

HttpVersionOperator

列舉型別

描述要比對的運算符

值	Description
Equal

IsDeviceMatchConditionParameters

Object

定義 IsDevice 比對條件的參數

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

IsDeviceMatchValue

列舉型別

傳遞規則條件的比對值

值	Description
Desktop
Mobile

IsDeviceOperator

列舉型別

描述要比對的運算符

值	Description
Equal

MatchProcessingBehavior

列舉型別

如果此規則相符，規則引擎應該繼續執行其餘規則或停止。如果不存在，則預設為 [繼續]。

值	Description
Continue
Stop

OriginGroupOverride

Object

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

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

OriginGroupOverrideAction

Object

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

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

OriginGroupOverrideActionParameters

Object

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

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

paramIndicator

列舉型別

指出參數的用途

值	Description
Expires
KeyId
Signature

PostArgsMatchConditionParameters

Object

定義 PostArgs 比對條件的參數

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

PostArgsOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

queryStringBehavior

列舉型別

要求的快取行為

值	Description
Exclude
ExcludeAll
Include
IncludeAll

QueryStringMatchConditionParameters

Object

定義 QueryString 比對條件的參數

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

QueryStringOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

RedirectType

列舉型別

重新導向類型，規則會在重新導向流量時使用。

值	Description
Found
Moved
PermanentRedirect
TemporaryRedirect

RemoteAddressMatchConditionParameters

Object

定義 RemoteAddress 比對條件的參數

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

RemoteAddressOperator

列舉型別

描述要比對的運算符

值	Description
Any
GeoMatch
IPMatch

RequestBodyMatchConditionParameters

Object

定義 RequestBody 比對條件的參數

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

RequestBodyOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

RequestHeaderMatchConditionParameters

Object

定義 RequestHeader 比對條件的參數

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

RequestHeaderOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

RequestMethodMatchConditionParameters

Object

定義 RequestMethod 比對條件的參數

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

RequestMethodMatchValue

列舉型別

傳遞規則條件的比對值

值	Description
DELETE
GET
HEAD
OPTIONS
POST
PUT
TRACE

RequestMethodOperator

列舉型別

描述要比對的運算符

值	Description
Equal

RequestSchemeMatchConditionParameters

Object

定義 RequestScheme 比對條件的參數

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

RequestSchemeMatchValue

列舉型別

傳遞規則條件的比對值

值	Description
HTTP
HTTPS

RequestUriMatchConditionParameters

Object

定義 RequestUri 比對條件的參數

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

RequestUriOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

ResourceReference

Object

另一個資源的參考。

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

RouteConfigurationOverrideActionParameters

Object

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

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

Rule

Object

易記規則名稱對應至任何規則或秘密相關信息。

名稱	類型	預設值	Description
id	string (arm-id)		資源的完整資源標識碼。例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string		資源的名稱
properties.actions	DeliveryRuleAction[]: DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleRouteConfigurationOverrideAction[] OriginGroupOverrideAction[] UrlRedirectAction[] UrlRewriteAction[] UrlSigningAction[]		符合規則所有條件時所執行的動作清單。
properties.conditions	DeliveryRuleCondition[]: DeliveryRuleClientPortCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleQueryStringCondition[] DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleSslProtocolCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleUrlPathCondition[]		必須比對要執行之動作的條件清單
properties.deploymentStatus	DeploymentStatus
properties.matchProcessingBehavior	MatchProcessingBehavior	Continue	如果此規則相符，規則引擎應該繼續執行其餘規則或停止。如果不存在，則預設為 [繼續]。
properties.order	integer (int32)		為端點套用規則的順序。可能的值 {0,1,2,3,.........}。具有較低順序的規則將會套用在具有較大順序的規則之前。具有順序 0 的規則是特殊規則。它不需要任何條件，而且一律會套用其中所列的動作。
properties.provisioningState	AfdProvisioningState		佈建狀態
properties.ruleSetName	string		包含規則的規則集名稱。
systemData	systemData		包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type	string		資源的類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ruleCacheBehavior

列舉型別

要求的快取行為

值	Description
HonorOrigin
OverrideAlways
OverrideIfOriginMissing

ruleIsCompressionEnabled

列舉型別

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

值	Description
Disabled
Enabled

ruleQueryStringCachingBehavior

列舉型別

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

值	Description
IgnoreQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings
UseQueryString

ServerPortMatchConditionParameters

Object

定義 ServerPort 比對條件的參數

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

ServerPortOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

SocketAddrMatchConditionParameters

Object

定義 SocketAddress 比對條件的參數

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

SocketAddrOperator

列舉型別

描述要比對的運算符

值	Description
Any
IPMatch

SslProtocol

列舉型別

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

值	Description
TLSv1
TLSv1.1
TLSv1.2

SslProtocolMatchConditionParameters

Object

定義 SslProtocol 比對條件的參數

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

SslProtocolOperator

列舉型別

描述要比對的運算符

值	Description
Equal

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

transform

列舉型別

描述比對之前套用的轉換

值	Description
Lowercase
RemoveNulls
Trim
Uppercase
UrlDecode
UrlEncode

UrlFileExtensionMatchConditionParameters

Object

定義 UrlFileExtension 比對條件的參數

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

UrlFileExtensionOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

UrlFileNameMatchConditionParameters

Object

定義 UrlFilename 比對條件的參數

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

UrlFileNameOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx

UrlPathMatchConditionParameters

Object

定義 UrlPath 比對條件的參數

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

UrlPathOperator

列舉型別

描述要比對的運算符

值	Description
Any
BeginsWith
Contains
EndsWith
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual
RegEx
Wildcard

UrlRedirectAction

Object

定義傳遞規則的 URL 重新導向動作。

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

UrlRedirectActionParameters

Object

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

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

UrlRewriteAction

Object

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

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

UrlRewriteActionParameters

Object

定義 URL 重寫動作的參數。

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

UrlSigningAction

Object

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

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

UrlSigningActionParameters

Object

定義 URL 簽署動作的參數。

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

UrlSigningParamIdentifier

Object

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

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

共用方式為

Rules - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

Rules_Get

範例要求

範例回覆

定義

AfdProvisioningState

algorithm

cacheBehavior

CacheConfiguration

CacheExpirationActionParameters

CacheKeyQueryStringActionParameters

CacheType

ClientPortMatchConditionParameters

ClientPortOperator

CookiesMatchConditionParameters

CookiesOperator

createdByType

DeliveryRuleCacheExpirationAction

DeliveryRuleCacheKeyQueryStringAction

DeliveryRuleClientPortCondition

DeliveryRuleCookiesCondition

DeliveryRuleHostNameCondition

DeliveryRuleHttpVersionCondition

DeliveryRuleIsDeviceCondition

DeliveryRulePostArgsCondition

DeliveryRuleQueryStringCondition

DeliveryRuleRemoteAddressCondition

DeliveryRuleRequestBodyCondition

DeliveryRuleRequestHeaderAction

DeliveryRuleRequestHeaderCondition

DeliveryRuleRequestMethodCondition

DeliveryRuleRequestSchemeCondition

DeliveryRuleRequestUriCondition

DeliveryRuleResponseHeaderAction

DeliveryRuleRouteConfigurationOverrideAction

DeliveryRuleServerPortCondition

DeliveryRuleSocketAddrCondition

DeliveryRuleSslProtocolCondition

DeliveryRuleUrlFileExtensionCondition

DeliveryRuleUrlFileNameCondition

DeliveryRuleUrlPathCondition

DeploymentStatus

DestinationProtocol

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

HeaderAction

HeaderActionParameters

HostNameMatchConditionParameters

HostNameOperator

HttpVersionMatchConditionParameters

HttpVersionOperator

IsDeviceMatchConditionParameters

IsDeviceMatchValue

IsDeviceOperator

MatchProcessingBehavior

OriginGroupOverride

OriginGroupOverrideAction

OriginGroupOverrideActionParameters

paramIndicator

PostArgsMatchConditionParameters

PostArgsOperator

queryStringBehavior

QueryStringMatchConditionParameters

QueryStringOperator

RedirectType

RemoteAddressMatchConditionParameters

RemoteAddressOperator

RequestBodyMatchConditionParameters

RequestBodyOperator

RequestHeaderMatchConditionParameters

RequestHeaderOperator