AFD Origin Groups - List By Profile

服务:

Front Door Service

API 版本:

2025-04-15

列出配置文件中的所有现有源组。

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

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	在资源组中唯一的 Azure Front Door 标准版或 Azure Front Door Premium 的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Azure 订阅中的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要用于客户端请求的 API 的版本。 当前版本为 2025-04-15。

响应

名称	类型	说明
200 OK	AFDOriginGroupListResult	还行
Other Status Codes	AfdErrorResponse	Azure Front Door 错误响应，描述操作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

AFDOriginGroups_ListByProfile

示例请求

HTTP

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

示例响应

状态代码:

200

{
  "value": [
    {
      "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"
      }
    }
  ]
}

定义

名称	说明
AfdErrorResponse	错误响应
AFDOriginGroup	如果无法从 Azure Front Door 提供内容，则使用由源组成的 AFDOrigin 组对源进行负载均衡。
AFDOriginGroupListResult	列出源组的请求的结果。 它包含源组对象列表和 URL 链接，用于获取下一组结果。
AfdProvisioningState	预配状态
DeploymentStatus
EnabledState	是否启用此规则的使用。 允许的值为“Enabled”或“Disabled”
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
HealthProbeParameters	包含将运行状况探测发送到源的属性的 JSON 对象。
HealthProbeRequestType	发出的运行状况探测请求的类型。
IdentityType	创建/修改资源的标识类型
LoadBalancingSettingsParameters	Round-Robin 后端池的负载均衡设置
ProbeProtocol	用于运行状况探测的协议。
SystemData	只读系统数据

AfdErrorResponse

Object

错误响应

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

AFDOriginGroup

Object

如果无法从 Azure Front Door 提供内容，则使用由源组成的 AFDOrigin 组对源进行负载均衡。

名称	类型	说明
id	string	资源 ID。
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	只读系统数据
type	string	资源类型。

AFDOriginGroupListResult

Object

列出源组的请求的结果。 它包含源组对象列表和 URL 链接，用于获取下一组结果。

名称	类型	说明
nextLink	string	用于获取下一组源对象的 URL（如果有）。
value	AFDOriginGroup[]	Azure Front Door 终结点中的 Azure Front Door 源组列表

AfdProvisioningState

枚举

预配状态

值	说明
Succeeded
Failed
Updating
Deleting
Creating

DeploymentStatus

枚举

值	说明
NotStarted
InProgress
Succeeded
Failed

EnabledState

枚举

是否启用此规则的使用。 允许的值为“Enabled”或“Disabled”

值	说明
Enabled
Disabled

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

HealthProbeParameters

Object

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

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

HealthProbeRequestType

枚举

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

值	说明
NotSet
GET
HEAD

IdentityType

枚举

创建/修改资源的标识类型

值	说明
user
application
managedIdentity
key

LoadBalancingSettingsParameters

Object

Round-Robin 后端池的负载均衡设置

名称	类型	说明
additionalLatencyInMilliseconds	integer (int32)	探测下降到最低延迟存储桶的额外延迟（以毫秒为单位）
sampleSize	integer (int32)	要考虑的负载均衡决策的示例数
successfulSamplesRequired	integer (int32)	样本周期内必须成功的示例数

ProbeProtocol

枚举

用于运行状况探测的协议。

值	说明
NotSet
Http
Https

SystemData

Object

只读系统数据

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）
createdBy	string	创建资源的标识的标识符
createdByType	IdentityType	创建资源的标识类型
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识的标识符
lastModifiedByType	IdentityType	上次修改资源的标识类型