共用方式為

AFD Origin Groups - Get

服務:
Front Door Service
API 版本:
2025-04-15

取得配置檔中的現有原始群組。

GET 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

資源群組的名稱。 名稱不區分大小寫。
subscriptionId
 path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version
 query True

string

minLength: 1

要用於這項作業的 API 版本。

回應

名稱 類型 Description
200 OK

AFDOriginGroup

還行
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 模擬您的用戶帳戶

範例

AFDOriginGroups_Get

範例要求

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

範例回覆

狀態碼:
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"
  }
}

定義

名稱 Description
AFDOriginGroup

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

佈建狀態
createdByType

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

是否要啟用此規則的使用。 允許的值為 'Enabled' 或 'Disabled'
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
HealthProbeParameters

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

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

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

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

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

AFDOriginGroup

Object

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

名稱 類型 Description
id

string (arm-id)

資源的完整資源標識碼。 例如 “/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name

string

資源的名稱
properties.deploymentStatus

DeploymentStatus

properties.healthProbeSettings

HealthProbeParameters

用於判斷來源健康情況的健全狀況探查設定。
properties.loadBalancingSettings

LoadBalancingSettingsParameters

後端集區的負載平衡設定
properties.profileName

string

保存原始群組之配置檔的名稱。
properties.provisioningState

AfdProvisioningState

佈建狀態
properties.sessionAffinityState

EnabledState

是否要允許此主機上的會話親和性。 有效的選項為 'Enabled' 或 'Disabled'
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes

integer (int32)

minimum: 0
maximum: 50

當狀況不良的端點狀況良好或新增新的端點時，以分鐘為單位逐漸將流量轉移到端點的時間。 預設值為 10 分鐘。 目前不支援這個屬性。
systemData

systemData

包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。
type

string

資源的類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

AfdProvisioningState

列舉型別

佈建狀態

值 Description
Creating
Deleting
Failed
Succeeded
Updating

createdByType

列舉型別

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

值 Description
Application
Key
ManagedIdentity
User

DeploymentStatus

列舉型別
值 Description
Failed
InProgress
NotStarted
Succeeded

EnabledState

列舉型別

是否要啟用此規則的使用。 允許的值為 'Enabled' 或 'Disabled'

值 Description
Disabled
Enabled

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

HealthProbeParameters

Object

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

名稱 類型 Description
probeIntervalInSeconds

integer (int32)

minimum: 1
maximum: 255

健康情況探查之間的秒數。預設值為240秒。
probePath

string

相對於用來判斷來源健康情況的來源路徑。
probeProtocol

ProbeProtocol

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

HealthProbeRequestType

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

HealthProbeRequestType

列舉型別

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

值 Description
GET
HEAD
NotSet

LoadBalancingSettingsParameters

Object

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

名稱 類型 Description
additionalLatencyInMilliseconds

integer (int32)

探查要落入最低延遲值區以毫秒為單位的額外延遲
sampleSize

integer (int32)

要考慮進行負載平衡決策的範例數目
successfulSamplesRequired

integer (int32)

必須成功之範例期間內的樣本數目

ProbeProtocol

列舉型別

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

值 Description
Http
Https
NotSet

systemData

Object

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

名稱 類型 Description
createdAt

string (date-time)

資源建立的時間戳（UTC）。
createdBy

string

建立資源的身分識別。
createdByType

createdByType

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

string (date-time)

上次修改的資源時間戳 （UTC）
lastModifiedBy

string

上次修改資源的身分識別。
lastModifiedByType

createdByType

上次修改資源的身分識別類型。