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

AFD Origin Groups - Get

参考

Service:: Front Door Service

API Version:: 2023-05-01

获取配置文件中的现有源组。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}?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	AFDOriginGroup	确定
Other Status Codes	AfdErrorResponse	描述操作失败原因的 Azure Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

AFDOriginGroups_Get

Sample Request

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


/** Samples for AfdOriginGroups Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOriginGroups_Get.json
     */
    /**
     * Sample code: AFDOriginGroups_Get.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void aFDOriginGroupsGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getAfdOriginGroups().getWithResponse("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_origin_groups_get.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_origin_groups.get(
        resource_group_name="RG",
        profile_name="profile1",
        origin_group_name="origingroup1",
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOriginGroups_Get.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/AFDOriginGroups_Get.json
func ExampleAFDOriginGroupsClient_Get() {
	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)
	}
	res, err := clientFactory.NewAFDOriginGroupsClient().Get(ctx, "RG", "profile1", "origingroup1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AFDOriginGroup = armcdn.AFDOriginGroup{
	// 	Name: to.Ptr("origingroup1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/origingroups"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1"),
	// 	Properties: &armcdn.AFDOriginGroupProperties{
	// 		HealthProbeSettings: &armcdn.HealthProbeParameters{
	// 			ProbeIntervalInSeconds: to.Ptr[int32](10),
	// 			ProbePath: to.Ptr("/path1"),
	// 			ProbeProtocol: to.Ptr(armcdn.ProbeProtocolHTTP),
	// 			ProbeRequestType: to.Ptr(armcdn.HealthProbeRequestTypeHEAD),
	// 		},
	// 		LoadBalancingSettings: &armcdn.LoadBalancingSettingsParameters{
	// 			AdditionalLatencyInMilliseconds: to.Ptr[int32](1000),
	// 			SampleSize: to.Ptr[int32](3),
	// 			SuccessfulSamplesRequired: to.Ptr[int32](3),
	// 		},
	// 		TrafficRestorationTimeToHealedOrNewEndpointsInMinutes: to.Ptr[int32](5),
	// 		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 Gets an existing origin group within a profile.
 *
 * @summary Gets an existing origin group within a profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDOriginGroups_Get.json
 */
async function afdOriginGroupsGet() {
  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 result = await client.afdOriginGroups.get(resourceGroupName, profileName, originGroupName);
  console.log(result);
}

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

{
  "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 组用于对源进行负载均衡。
AfdProvisioningState	预配状态
DeploymentStatus
EnabledState	是否要启用此规则。允许的值为“Enabled”或“Disabled”
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
HealthProbeParameters	JSON 对象，该对象包含用于将运行状况探测发送到源的属性。
HealthProbeRequestType	发出的运行状况探测请求的类型。
IdentityType	创建/修改资源的标识类型
LoadBalancingSettingsParameters	Round-Robin 后端池的负载均衡设置
ProbeProtocol	用于运行状况探测的协议。
SystemData	只读系统数据

AfdErrorResponse

错误响应

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

AFDOriginGroup

如果无法从 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	是否允许此主机上的会话相关性。有效选项为“已启用”或“已禁用”
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	当运行不正常的终结点运行正常或添加新终结点时，逐渐将流量转移到终结点的时间（以分钟为单位）。默认值为 10 分钟。当前不支持此属性。
systemData	SystemData	只读系统数据
type	string	资源类型。

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	错误目标。

HealthProbeParameters

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

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

HealthProbeRequestType

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

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

IdentityType

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

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

LoadBalancingSettingsParameters

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

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

ProbeProtocol

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

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

SystemData

只读系统数据

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

AFD Origin Groups - Get

URI 参数

响应

安全性

azure_auth

Scopes

示例

AFDOriginGroups_Get

Sample Request

Sample Response

定义

AfdErrorResponse

AFDOriginGroup

AfdProvisioningState

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

HealthProbeParameters

HealthProbeRequestType

IdentityType

LoadBalancingSettingsParameters

ProbeProtocol

SystemData

其他资源