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

AFD Profiles - Check Endpoint Name Availability

Service:

Front Door Service

API Version:

2023-05-01

检查 afdx 终结点名称的可用性，并返回全局唯一的终结点主机名。

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

URI 参数

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

请求正文

名称	必需	类型	说明
name	True	string	要验证的资源名称。
type	True	ResourceType	要验证其名称的资源的类型。
autoGeneratedDomainNameLabelScope		AutoGeneratedDomainNameLabelScope	指示终结点名称重用范围。 默认值为 TenantReuse。

响应

名称	类型	说明
200 OK	CheckEndpointNameAvailabilityOutput	没问题。 请求已成功。
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	模拟用户帐户

示例

CheckEndpointNameAvailability

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/myResourceGroup/providers/Microsoft.Cdn/profiles/profile1/checkEndpointNameAvailability?api-version=2023-05-01

{
  "name": "sampleName",
  "type": "Microsoft.Cdn/Profiles/AfdEndpoints",
  "autoGeneratedDomainNameLabelScope": "TenantReuse"
}

Java

import com.azure.resourcemanager.cdn.models.AutoGeneratedDomainNameLabelScope;
import com.azure.resourcemanager.cdn.models.CheckEndpointNameAvailabilityInput;
import com.azure.resourcemanager.cdn.models.ResourceType;

/** Samples for AfdProfiles CheckEndpointNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/
     * AFDProfiles_CheckEndpointNameAvailability.json
     */
    /**
     * Sample code: CheckEndpointNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void checkEndpointNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getAfdProfiles().checkEndpointNameAvailabilityWithResponse(
            "myResourceGroup", "profile1",
            new CheckEndpointNameAvailabilityInput().withName("sampleName")
                .withType(ResourceType.MICROSOFT_CDN_PROFILES_AFD_ENDPOINTS).withAutoGeneratedDomainNameLabelScope(
                    AutoGeneratedDomainNameLabelScope.TENANT_REUSE),
            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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python afd_profiles_check_endpoint_name_availability.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_profiles.check_endpoint_name_availability(
        resource_group_name="myResourceGroup",
        profile_name="profile1",
        check_endpoint_name_availability_input={
            "autoGeneratedDomainNameLabelScope": "TenantReuse",
            "name": "sampleName",
            "type": "Microsoft.Cdn/Profiles/AfdEndpoints",
        },
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_CheckEndpointNameAvailability.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

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/AFDProfiles_CheckEndpointNameAvailability.json
func ExampleAFDProfilesClient_CheckEndpointNameAvailability() {
	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.NewAFDProfilesClient().CheckEndpointNameAvailability(ctx, "myResourceGroup", "profile1", armcdn.CheckEndpointNameAvailabilityInput{
		Name:                              to.Ptr("sampleName"),
		Type:                              to.Ptr(armcdn.ResourceTypeMicrosoftCdnProfilesAfdEndpoints),
		AutoGeneratedDomainNameLabelScope: to.Ptr(armcdn.AutoGeneratedDomainNameLabelScopeTenantReuse),
	}, 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.CheckEndpointNameAvailabilityOutput = armcdn.CheckEndpointNameAvailabilityOutput{
	// 	AvailableHostname: to.Ptr(""),
	// 	Message: to.Ptr("Name not available"),
	// 	NameAvailable: to.Ptr(false),
	// 	Reason: to.Ptr("Name is already in use"),
	// }
}

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

JavaScript

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

/**
 * This sample demonstrates how to Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.
 *
 * @summary Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_CheckEndpointNameAvailability.json
 */
async function checkEndpointNameAvailability() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "myResourceGroup";
  const profileName = "profile1";
  const checkEndpointNameAvailabilityInput = {
    name: "sampleName",
    type: "Microsoft.Cdn/Profiles/AfdEndpoints",
    autoGeneratedDomainNameLabelScope: "TenantReuse",
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.afdProfiles.checkEndpointNameAvailability(
    resourceGroupName,
    profileName,
    checkEndpointNameAvailabilityInput
  );
  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

{
  "nameAvailable": false,
  "reason": "Name is already in use",
  "message": "Name not available",
  "availableHostname": ""
}

定义

名称	说明
AfdErrorResponse	错误响应
AutoGeneratedDomainNameLabelScope	指示终结点名称重用范围。 默认值为 TenantReuse。
CheckEndpointNameAvailabilityInput	CheckNameAvailability API 的输入。
CheckEndpointNameAvailabilityOutput	检查名称可用性 API 的输出。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ResourceType	CheckNameAvailability 中使用的 CDN 资源类型。

AfdErrorResponse

错误响应

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

AutoGeneratedDomainNameLabelScope

指示终结点名称重用范围。 默认值为 TenantReuse。

名称	类型	说明
NoReuse	string
ResourceGroupReuse	string
SubscriptionReuse	string
TenantReuse	string

CheckEndpointNameAvailabilityInput

CheckNameAvailability API 的输入。

名称	类型	说明
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	指示终结点名称重用范围。 默认值为 TenantReuse。
name	string	要验证的资源名称。
type	ResourceType	要验证其名称的资源的类型。

CheckEndpointNameAvailabilityOutput

检查名称可用性 API 的输出。

名称	类型	说明
availableHostname	string	当名称可用时，返回基于 AutoGeneratedDomainNameLabelScope 生成的可用主机名，否则返回空字符串
message	string	描述名称不可用的原因的详细错误消息。
nameAvailable	boolean	指示名称是否可用。
reason	string	名称不可用的原因。

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ResourceType

CheckNameAvailability 中使用的 CDN 资源类型。

名称	类型	说明
Microsoft.Cdn/Profiles/AfdEndpoints	string
Microsoft.Cdn/Profiles/Endpoints	string