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

AFD Custom Domains - Get

参考

Service:: Front Door Service

API Version:: 2023-05-01

获取指定的订阅、资源组和配置文件下具有指定域名的现有 AzureFrontDoor 域。

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

URI 参数

名称	在	必需	类型	说明
customDomainName	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	AFDDomain	确定
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	模拟用户帐户

示例

AFDCustomDomains_Get

Sample Request

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


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


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDCustomDomains_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/AFDCustomDomains_Get.json
func ExampleAFDCustomDomainsClient_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.NewAFDCustomDomainsClient().Get(ctx, "RG", "profile1", "domain1", 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.AFDDomain = armcdn.AFDDomain{
	// 	Name: to.Ptr("domain1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/customdomains"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1"),
	// 	Properties: &armcdn.AFDDomainProperties{
	// 		AzureDNSZone: &armcdn.ResourceReference{
	// 			ID: to.Ptr(""),
	// 		},
	// 		PreValidatedCustomDomainResourceID: &armcdn.ResourceReference{
	// 			ID: to.Ptr(""),
	// 		},
	// 		ProfileName: to.Ptr("profile1"),
	// 		TLSSettings: &armcdn.AFDDomainHTTPSParameters{
	// 			CertificateType: to.Ptr(armcdn.AfdCertificateTypeManagedCertificate),
	// 			MinimumTLSVersion: to.Ptr(armcdn.AfdMinimumTLSVersionTLS12),
	// 			Secret: &armcdn.ResourceReference{
	// 				ID: to.Ptr(""),
	// 			},
	// 		},
	// 		DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
	// 		ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
	// 		DomainValidationState: to.Ptr(armcdn.DomainValidationStatePending),
	// 		HostName: to.Ptr("www.contoso.com"),
	// 		ValidationProperties: &armcdn.DomainValidationProperties{
	// 			ExpirationDate: to.Ptr("2009-06-15T13:45:43.0000000Z"),
	// 			ValidationToken: to.Ptr("8c9912db-c615-4eeb-8465"),
	// 		},
	// 	},
	// }
}

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 AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
 *
 * @summary Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDCustomDomains_Get.json
 */
async function afdCustomDomainsGet() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const customDomainName = "domain1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.afdCustomDomains.get(
    resourceGroupName,
    profileName,
    customDomainName
  );
  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/customdomains/domain1",
  "name": "domain1",
  "type": "Microsoft.Cdn/profiles/customdomains",
  "properties": {
    "profileName": "profile1",
    "hostName": "www.contoso.com",
    "tlsSettings": {
      "certificateType": "ManagedCertificate",
      "minimumTlsVersion": "TLS12",
      "secret": {
        "id": ""
      }
    },
    "azureDnsZone": {
      "id": ""
    },
    "preValidatedCustomDomainResourceId": {
      "id": ""
    },
    "validationProperties": {
      "validationToken": "8c9912db-c615-4eeb-8465",
      "expirationDate": "2009-06-15T13:45:43.0000000Z"
    },
    "domainValidationState": "Pending",
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted"
  }
}

定义

名称	说明
AfdCertificateType	定义 SSL 证书的源。
AFDDomain	友好的域名映射到客户出于品牌打造目的提供的终结点主机名，例如 www.contoso.com。
AFDDomainHttpsParameters	包含用于保护域的属性的 JSON 对象。
AfdErrorResponse	错误响应
AfdMinimumTlsVersion	将用于 Https 的 TLS 协议版本
AfdProvisioningState	预配状态
DeploymentStatus
DomainValidationProperties	包含用于验证域的属性的 JSON 对象。
DomainValidationState	预配子状态逐步显示自定义 HTTPS 启用/禁用过程的进度。 DCV 代表 DomainControlValidation。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
IdentityType	创建/修改资源的标识类型
ResourceReference	对另一个资源的引用。
SystemData	只读系统数据

AfdCertificateType

定义 SSL 证书的源。

名称	类型	说明
AzureFirstPartyManagedCertificate	string
CustomerCertificate	string
ManagedCertificate	string

AFDDomain

友好的域名映射到客户出于品牌打造目的提供的终结点主机名，例如 www.contoso.com。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.azureDnsZone	ResourceReference	Azure DNS 区域的资源引用
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	预配子状态逐步显示自定义 HTTPS 启用/禁用过程的进度。 DCV 代表 DomainControlValidation。
properties.extendedProperties	object	表示域迁移属性的 Key-Value 对。
properties.hostName	string	域的主机名。必须是域名。
properties.preValidatedCustomDomainResourceId	ResourceReference	对已预先验证自定义域所有权的 Azure 资源的资源引用
properties.profileName	string	保存域的配置文件的名称。
properties.provisioningState	AfdProvisioningState	预配状态
properties.tlsSettings	AFDDomainHttpsParameters	指定如何为域启用 HTTPS 的配置 - 使用 AzureFrontDoor 托管证书或用户自己的证书。如果未指定，则启用 ssl 默认使用 AzureFrontDoor 托管证书。
properties.validationProperties	DomainValidationProperties	客户验证域所有权所需的值
systemData	SystemData	只读系统数据
type	string	资源类型。

AFDDomainHttpsParameters

包含用于保护域的属性的 JSON 对象。

名称	类型	说明
certificateType	AfdCertificateType	定义 SSL 证书的源。
minimumTlsVersion	AfdMinimumTlsVersion	将用于 Https 的 TLS 协议版本
secret	ResourceReference	对机密的资源引用。即。subs/rg/profile/secret

AfdErrorResponse

错误响应

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

AfdMinimumTlsVersion

将用于 Https 的 TLS 协议版本

名称	类型	说明
TLS10	string
TLS12	string

AfdProvisioningState

预配状态

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

DeploymentStatus

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

DomainValidationProperties

包含用于验证域的属性的 JSON 对象。

名称	类型	说明
expirationDate	string	令牌过期的日期时间
validationToken	string	用于 DNS TXT 记录或基于文件的验证的质询

DomainValidationState

预配子状态逐步显示自定义 HTTPS 启用/禁用过程的进度。 DCV 代表 DomainControlValidation。

名称	类型	说明
Approved	string
InternalError	string
Pending	string
PendingRevalidation	string
RefreshingValidationToken	string
Rejected	string
Submitting	string
TimedOut	string
Unknown	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。

SystemData

只读系统数据

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

Share via

AFD Custom Domains - Get

URI 参数

响应

安全性

azure_auth

Scopes

示例

AFDCustomDomains_Get

Sample Request

Sample Response

定义

AfdCertificateType

AFDDomain

AFDDomainHttpsParameters

AfdErrorResponse

AfdMinimumTlsVersion

AfdProvisioningState

DeploymentStatus

DomainValidationProperties

DomainValidationState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SystemData

其他资源