你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Origin Groups - List By Endpoint

参考

Service:: CDN

API Version:: 2024-02-01

Lists终结点中的所有现有源组。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups?api-version=2024-02-01

URI 参数

名称	在	必需	类型	说明
endpointName	path	True	string	配置文件下全局唯一的终结点的名称。
profileName	path	True	string	资源组中唯一的 CDN 配置文件的名称。
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前版本为 2024-02-01。

响应

名称	类型	说明
200 OK	OriginGroupListResult	没问题。请求已成功。
Other Status Codes	ErrorResponse	描述操作失败原因的 CDN 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

OriginsGroups_ListByEndpoint

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups?api-version=2024-02-01


/**
 * Samples for OriginGroups ListByEndpoint.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/OriginGroups_ListByEndpoint.json
     */
    /**
     * Sample code: OriginsGroups_ListByEndpoint.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void originsGroupsListByEndpoint(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getOriginGroups().listByEndpoint("RG", "profile1", "endpoint1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcdn_test

import (
	"context"
	"log"

	"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/OriginGroups_ListByEndpoint.json
func ExampleOriginGroupsClient_NewListByEndpointPager() {
	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)
	}
	pager := clientFactory.NewOriginGroupsClient().NewListByEndpointPager("RG", "profile1", "endpoint1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OriginGroupListResult = armcdn.OriginGroupListResult{
		// 	Value: []*armcdn.OriginGroup{
		// 		{
		// 			Name: to.Ptr("origingroup1"),
		// 			Type: to.Ptr("Microsoft.Cdn/profiles/endpoints/origingroups"),
		// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1"),
		// 			Properties: &armcdn.OriginGroupProperties{
		// 				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/origin1"),
		// 				}},
		// 				ResponseBasedOriginErrorDetectionSettings: &armcdn.ResponseBasedOriginErrorDetectionParameters{
		// 					ResponseBasedDetectedErrorTypes: to.Ptr(armcdn.ResponseBasedDetectedErrorTypesTCPErrorsOnly),
		// 					ResponseBasedFailoverThresholdPercentage: to.Ptr[int32](10),
		// 				},
		// 				ProvisioningState: to.Ptr(armcdn.OriginGroupProvisioningStateSucceeded),
		// 				ResourceState: to.Ptr(armcdn.OriginGroupResourceStateActive),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all of the existing origin groups within an endpoint.
 *
 * @summary Lists all of the existing origin groups within an endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/OriginGroups_ListByEndpoint.json
 */
async function originsGroupsListByEndpoint() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.originGroups.listByEndpoint(
    resourceGroupName,
    profileName,
    endpointName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "origingroup1",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
      "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceState": "Active",
        "healthProbeSettings": {
          "probePath": "/health.aspx",
          "probeRequestType": "GET",
          "probeProtocol": "Http",
          "probeIntervalInSeconds": 120
        },
        "origins": [
          {
            "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
          }
        ],
        "responseBasedOriginErrorDetectionSettings": {
          "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
          "responseBasedFailoverThresholdPercentage": 10
        }
      }
    }
  ]
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HealthProbeParameters	JSON 对象，该对象包含用于将运行状况探测发送到源的属性。
HealthProbeRequestType	发出的运行状况探测请求的类型。
HttpErrorRangeParameters	表示 http 状态代码范围的 JSON 对象
IdentityType	创建/修改资源的标识类型
OriginGroup	如果无法从 CDN 提供内容，则由源组成的源组用于对源进行负载均衡。
OriginGroupListResult	列出源组的请求的结果。它包含源组对象的列表和用于获取下一组结果的 URL 链接。
OriginGroupProvisioningState	源组的预配状态。
OriginGroupResourceState	源组的资源状态。
ProbeProtocol	用于运行状况探测的协议。
ResourceReference	对另一个资源的引用。
ResponseBasedDetectedErrorTypes	源将被视为不正常的真实用户请求的响应错误类型
ResponseBasedOriginErrorDetectionParameters	JSON 对象，该对象包含用于使用实际请求/响应确定源运行状况的属性。
SystemData	只读系统数据

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

HealthProbeParameters

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

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

HealthProbeRequestType

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

名称	类型	说明
GET	string
HEAD	string
NotSet	string

HttpErrorRangeParameters

表示 http 状态代码范围的 JSON 对象

名称	类型	说明
begin	integer	http 状态代码范围的非独占开头。
end	integer	http 状态代码范围的非独占端。

IdentityType

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

名称	类型	说明
application	string
key	string
managedIdentity	string
user	string

OriginGroup

如果无法从 CDN 提供内容，则由源组成的源组用于对源进行负载均衡。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.healthProbeSettings	HealthProbeParameters	用于确定源运行状况的源的运行状况探测设置。
properties.origins	ResourceReference[]	通过给定源组中的 CDN 传递的内容的来源。
properties.provisioningState	OriginGroupProvisioningState	源组的预配状态。
properties.resourceState	OriginGroupResourceState	源组的资源状态。
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	JSON 对象，该对象包含用于使用实际请求/响应确定源运行状况的属性。当前不支持此属性。
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	当运行不正常的终结点运行正常或添加新终结点时，逐渐将流量转移到终结点的时间（以分钟为单位）。默认值为 10 分钟。当前不支持此属性。
systemData	SystemData	只读系统数据
type	string	资源类型。

OriginGroupListResult

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

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

OriginGroupProvisioningState

源组的预配状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

OriginGroupResourceState

源组的资源状态。

名称	类型	说明
Active	string
Creating	string
Deleting	string

ProbeProtocol

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

名称	类型	说明
Http	string
Https	string
NotSet	string

ResourceReference

对另一个资源的引用。

名称	类型	说明
id	string	资源 ID。

ResponseBasedDetectedErrorTypes

源将被视为不正常的真实用户请求的响应错误类型

名称	类型	说明
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

JSON 对象，该对象包含用于使用实际请求/响应确定源运行状况的属性。

名称	类型	说明
httpErrorRanges	HttpErrorRangeParameters[]	Http 状态代码范围的列表，这些范围被视为源服务器错误，并且标记为不正常。
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	源将被视为不正常的真实用户请求的响应错误类型
responseBasedFailoverThresholdPercentage	integer	应触发故障转移的示例中失败请求的百分比。

SystemData

只读系统数据

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

Origin Groups - List By Endpoint

URI 参数

响应

安全性

azure_auth

Scopes

示例

OriginsGroups_ListByEndpoint

Sample Request

Sample Response

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HealthProbeParameters

HealthProbeRequestType

HttpErrorRangeParameters

IdentityType

OriginGroup

OriginGroupListResult

OriginGroupProvisioningState

OriginGroupResourceState

ProbeProtocol

ResourceReference

ResponseBasedDetectedErrorTypes

ResponseBasedOriginErrorDetectionParameters

SystemData

其他资源