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

AFD Origins - List By Origin Group

参考

Service:: Front Door Service

API Version:: 2023-05-01

Lists源组中的所有现有源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins?api-version=2023-05-01

URI 参数

名称	在	必需	类型	说明
originGroupName	path	True	string	在配置文件中唯一的源组的名称。
profileName	path	True	string	Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称，该配置文件在资源组中是唯一的。
resourceGroupName	path	True	string	Azure 订阅中资源组的名称。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前版本为 2023-05-01。

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

AFDOrigins_ListByOriginGroup

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/origingroup1/origins?api-version=2023-05-01


/** Samples for AfdOrigins ListByOriginGroup. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOrigins_ListByOriginGroup.json
     */
    /**
     * Sample code: AFDOrigins_ListByOriginGroup.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void aFDOriginsListByOriginGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getAfdOrigins().listByOriginGroup("RG", "profile1",
            "origingroup1", 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

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python afd_origins_list_by_origin_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.afd_origins.list_by_origin_group(
        resource_group_name="RG",
        profile_name="profile1",
        origin_group_name="origingroup1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOrigins_ListByOriginGroup.json
if __name__ == "__main__":
    main()

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/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOrigins_ListByOriginGroup.json
func ExampleAFDOriginsClient_NewListByOriginGroupPager() {
	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.NewAFDOriginsClient().NewListByOriginGroupPager("RG", "profile1", "origingroup1", 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.AFDOriginListResult = armcdn.AFDOriginListResult{
		// 	Value: []*armcdn.AFDOrigin{
		// 		{
		// 			Name: to.Ptr("origin1"),
		// 			Type: to.Ptr("Microsoft.Cdn/profiles/origingroups/origins"),
		// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1"),
		// 			Properties: &armcdn.AFDOriginProperties{
		// 				EnabledState: to.Ptr(armcdn.EnabledStateEnabled),
		// 				EnforceCertificateNameCheck: to.Ptr(true),
		// 				HostName: to.Ptr("host1.blob.core.windows.net"),
		// 				HTTPPort: to.Ptr[int32](80),
		// 				HTTPSPort: to.Ptr[int32](443),
		// 				OriginGroupName: to.Ptr("origingroup1"),
		// 				OriginHostHeader: to.Ptr("host1.foo.com"),
		// 				DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
		// 				ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
		// 			},
		// 	}},
		// }
	}
}

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 origins within an origin group.
 *
 * @summary Lists all of the existing origins within an origin group.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOrigins_ListByOriginGroup.json
 */
async function afdOriginsListByOriginGroup() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const originGroupName = "origingroup1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.afdOrigins.listByOriginGroup(
    resourceGroupName,
    profileName,
    originGroupName
  )) {
    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": [
    {
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1",
      "type": "Microsoft.Cdn/profiles/origingroups/origins",
      "name": "origin1",
      "properties": {
        "hostName": "host1.blob.core.windows.net",
        "httpPort": 80,
        "httpsPort": 443,
        "originHostHeader": "host1.foo.com",
        "priority": null,
        "weight": null,
        "enabledState": "Enabled",
        "provisioningState": "Succeeded",
        "deploymentStatus": "NotStarted",
        "originGroupName": "origingroup1",
        "sharedPrivateLinkResource": null,
        "enforceCertificateNameCheck": true
      }
    }
  ]
}

定义

名称	说明
AfdErrorResponse	错误响应
AFDOrigin	Azure Front Door 源是通过 Azure Front Door 传递的内容的源。当终结点表示的边缘节点未缓存请求的内容时，它们会尝试从一个或多个已配置的来源中提取该内容。
AFDOriginListResult	列出源的请求的结果。它包含源对象的列表和用于获取下一组结果的 URL 链接。
AfdProvisioningState	预配状态
DeploymentStatus
EnabledState	是否要启用此规则。允许的值为“Enabled”或“Disabled”
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
IdentityType	创建/修改资源的标识类型
ResourceReference	对另一个资源的引用。
SharedPrivateLinkResourceProperties	描述连接到专用源时要使用的现有共享专用链接资源的属性。
SharedPrivateLinkResourceStatus	共享专用链接资源的状态。可以是“挂起”、“已批准”、“已拒绝”、“已断开连接”或“超时”。
SystemData	只读系统数据

AfdErrorResponse

错误响应

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

AFDOrigin

Azure Front Door 源是通过 Azure Front Door 传递的内容的源。当终结点表示的边缘节点未缓存请求的内容时，它们会尝试从一个或多个已配置的来源中提取该内容。

名称	类型	默认值	说明
id	string		资源 ID。
name	string		资源名称。
properties.azureOrigin	ResourceReference		对 Azure 源资源的资源引用。
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		是否对 backendPools 下定义的后端启用运行状况探测。仅当单个已启用的后端池中有一个已启用的后端时，才能禁用运行状况探测。
properties.enforceCertificateNameCheck	boolean	True	是否在源级别启用证书名称检查
properties.hostName	string		源的地址。支持域名、IPv4 地址和 IPv6 地址。这在终结点中的所有源中应是唯一的。
properties.httpPort	integer	80	HTTP 端口的值。必须介于 1 和 65535 之间。
properties.httpsPort	integer	443	HTTPS 端口的值。必须介于 1 和 65535 之间。
properties.originGroupName	string		包含此源的源组的名称。
properties.originHostHeader	string		随每个请求一起发送到源的主机标头值。如果将此项留空，则请求主机名将确定此值。 Azure Front Door 源（例如 Web 应用、Blob 存储和云服务）默认要求此主机标头值与源主机名匹配。这会替代终结点上定义的主机标头
properties.priority	integer		给定源组中用于负载均衡的源优先级。如果任何优先级较低的源正常运行，则不会使用较高优先级进行负载均衡。必须介于 1 和 5 之间
properties.provisioningState	AfdProvisioningState		预配状态
properties.sharedPrivateLinkResource	SharedPrivateLinkResourceProperties		专用源的专用链接资源的属性。
properties.weight	integer		给定源组中的源的权重，用于负载均衡。必须介于 1 和 1000 之间
systemData	SystemData		只读系统数据
type	string		资源类型。

AFDOriginListResult

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

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

AfdProvisioningState

预配状态

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

DeploymentStatus

名称	类型	说明
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

EnabledState

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

名称	类型	说明
Disabled	string
Enabled	string

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

IdentityType

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

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

ResourceReference

对另一个资源的引用。

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

SharedPrivateLinkResourceProperties

描述连接到专用源时要使用的现有共享专用链接资源的属性。

名称	类型	说明
groupId	string	共享专用链接资源所针对的资源提供程序的组 ID。
privateLink	ResourceReference	共享专用链接资源所针对的资源的资源 ID。
privateLinkLocation	string	共享专用链接资源的位置
requestMessage	string	请求批准共享专用链接资源的请求消息。
status	SharedPrivateLinkResourceStatus	共享专用链接资源的状态。可以是“挂起”、“已批准”、“已拒绝”、“已断开连接”或“超时”。

SharedPrivateLinkResourceStatus

共享专用链接资源的状态。可以是“挂起”、“已批准”、“已拒绝”、“已断开连接”或“超时”。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

SystemData

只读系统数据

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

AFD Origins - List By Origin Group

URI 参数

响应

安全性

azure_auth

Scopes

示例

AFDOrigins_ListByOriginGroup

Sample Request

Sample Response

定义

AfdErrorResponse

AFDOrigin

AFDOriginListResult

AfdProvisioningState

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceStatus

SystemData

其他资源