AFD Origin Groups - Update

參考

服務:: Front Door Service

API 版本:: 2025-04-15

更新配置檔中的現有原始群組。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}?api-version=2025-04-15

URI 參數

名稱	位於	必要	類型	Description
originGroupName	path	True	string	在配置檔中是唯一的原始群組名稱。
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 pattern: ^[-\w\._]+$	Azure 訂用帳戶內的資源組名。
subscriptionId	path	True	string	Azure 訂用帳戶標識碼。
api-version	query	True	string	要與用戶端要求搭配使用的 API 版本。目前的版本是 2025-04-15。

要求本文

名稱	類型	Description
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.loadBalancingSettings	LoadBalancingSettingsParameters	Load balancing settings for a backend pool
properties.sessionAffinityState	EnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer (int32) minimum: 0 maximum: 50	Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.

回應

名稱	類型	Description
200 OK	AFDOriginGroup	還行
202 Accepted	AFDOriginGroup	接受。要求已接受進行處理，且作業將會以異步方式完成。標題 location: string
Other Status Codes	AfdErrorResponse	描述作業失敗原因的 Azure Front Door 錯誤回應。

名稱

類型

Description

200 OK

AFDOriginGroup

還行

202 Accepted

AFDOriginGroup

接受。要求已接受進行處理，且作業將會以異步方式完成。

標題

location: string

Other Status Codes

AfdErrorResponse

描述作業失敗原因的 Azure Front Door 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

範圍

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

範例

AFDOriginGroups_Update

範例要求

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/origingroup1?api-version=2025-04-15

{
  "properties": {
    "loadBalancingSettings": {
      "sampleSize": 3,
      "successfulSamplesRequired": 3,
      "additionalLatencyInMilliseconds": 1000
    },
    "healthProbeSettings": {
      "probePath": "/path2",
      "probeRequestType": "NotSet",
      "probeProtocol": "NotSet",
      "probeIntervalInSeconds": 10
    },
    "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5
  }
}

範例回覆

狀態碼:: 200

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1",
  "type": "Microsoft.Cdn/profiles/origingroups",
  "name": "origingroup1",
  "properties": {
    "loadBalancingSettings": {
      "sampleSize": 3,
      "successfulSamplesRequired": 3,
      "additionalLatencyInMilliseconds": 1000
    },
    "healthProbeSettings": {
      "probePath": "/path1",
      "probeRequestType": "HEAD",
      "probeProtocol": "Http",
      "probeIntervalInSeconds": 10
    },
    "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5,
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

狀態碼:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-04-15

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1",
  "type": "Microsoft.Cdn/profiles/origingroups",
  "name": "origingroup1",
  "properties": {
    "loadBalancingSettings": {
      "sampleSize": 3,
      "successfulSamplesRequired": 3,
      "additionalLatencyInMilliseconds": 1000
    },
    "healthProbeSettings": {
      "probePath": "/path1",
      "probeRequestType": "HEAD",
      "probeProtocol": "Http",
      "probeIntervalInSeconds": 10
    },
    "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5,
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted"
  }
}

定義

名稱	Description
AfdErrorResponse	錯誤回應
AFDOriginGroup	當無法從 Azure Front Door 提供內容時，會使用由來源組成的 AFDOrigin 群組來進行負載平衡。
AFDOriginGroupUpdateParameters	建立或更新來源群組所需的 AFDOrigin 群組屬性。
AfdProvisioningState	佈建狀態
DeploymentStatus
EnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
HealthProbeParameters	JSON 物件，其中包含將健康情況探查傳送至來源的屬性。
HealthProbeRequestType	The type of health probe request that is made.
IdentityType	建立/修改資源的身分識別類型
LoadBalancingSettingsParameters	Round-Robin 後端集區的負載平衡設定
ProbeProtocol	Protocol to use for health probe.
SystemData	唯讀系統數據

AfdErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

AFDOriginGroup

Object

當無法從 Azure Front Door 提供內容時，會使用由來源組成的 AFDOrigin 群組來進行負載平衡。

名稱	類型	Description
id	string	Resource ID.
name	string	Resource name.
properties.deploymentStatus	DeploymentStatus
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.loadBalancingSettings	LoadBalancingSettingsParameters	Load balancing settings for a backend pool
properties.profileName	string	保存原始群組之配置檔的名稱。
properties.provisioningState	AfdProvisioningState	佈建狀態
properties.sessionAffinityState	EnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer (int32) minimum: 0 maximum: 50	Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
systemData	SystemData	唯讀系統數據
type	string	資源類型。

AFDOriginGroupUpdateParameters

Object

建立或更新來源群組所需的 AFDOrigin 群組屬性。

名稱	類型	Description
properties.healthProbeSettings	HealthProbeParameters	Health probe settings to the origin that is used to determine the health of the origin.
properties.loadBalancingSettings	LoadBalancingSettingsParameters	Load balancing settings for a backend pool
properties.profileName	string	保存原始群組之配置檔的名稱。
properties.sessionAffinityState	EnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer (int32) minimum: 0 maximum: 50	Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.

AfdProvisioningState

列舉型別

佈建狀態

值	Description
Creating
Deleting
Failed
Succeeded
Updating

DeploymentStatus

列舉型別

值	Description
Failed
InProgress
NotStarted
Succeeded

EnabledState

列舉型別

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'

值	Description
Disabled
Enabled

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細數據。

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

HealthProbeParameters

Object

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

名稱	類型	Description
probeIntervalInSeconds	integer (int32) minimum: 1 maximum: 255	The number of seconds between health probes.Default is 240sec.
probePath	string	The path relative to the origin that is used to determine the health of the origin.
probeProtocol	ProbeProtocol	Protocol to use for health probe.
probeRequestType	HealthProbeRequestType	The type of health probe request that is made.

HealthProbeRequestType

列舉型別

The type of health probe request that is made.

值	Description
GET
HEAD
NotSet

IdentityType

列舉型別

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

值	Description
application
key
managedIdentity
user

LoadBalancingSettingsParameters

Object

Round-Robin 後端集區的負載平衡設定

名稱	類型	Description
additionalLatencyInMilliseconds	integer (int32)	The additional latency in milliseconds for probes to fall into the lowest latency bucket
sampleSize	integer (int32)	The number of samples to consider for load balancing decisions
successfulSamplesRequired	integer (int32)	The number of samples within the sample period that must succeed

ProbeProtocol

列舉型別

Protocol to use for health probe.

值	Description
Http
Https
NotSet

SystemData

Object

唯讀系統數據

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

共用方式為

AFD Origin Groups - Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

AFDOriginGroups_Update

範例要求

範例回覆

定義

AfdErrorResponse

AFDOriginGroup

AFDOriginGroupUpdateParameters

AfdProvisioningState

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

HealthProbeParameters

HealthProbeRequestType

IdentityType

LoadBalancingSettingsParameters

ProbeProtocol

SystemData