AFD Profiles - Check Endpoint Name Availability

サービス:

Front Door Service

API バージョン:

2025-04-15

afdx エンドポイント名の可用性を確認し、グローバルに一意のエンドポイント ホスト名を返します。

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

URI パラメーター

名前	/	必須	型	説明
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	リソース グループ内で一意である Azure Front Door Standard または Azure Front Door Premium の名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
name	True	string	検証するリソース名。
type	True	ResourceType	名前が検証されるリソースの種類。
autoGeneratedDomainNameLabelScope		AutoGeneratedDomainNameLabelScope	エンドポイント名の再利用スコープを示します。 既定値は TenantReuse です。

応答

名前	型	説明
200 OK	CheckEndpointNameAvailabilityOutput	わかりました。 要求は成功しました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Azure Front Door エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

CheckEndpointNameAvailability

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Cdn/profiles/profile1/checkEndpointNameAvailability?api-version=2025-04-15

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/AFDProfiles_CheckEndpointNameAvailability.json
// this example is just showing the usage of "FrontDoorProfiles_CheckEndpointNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ProfileResource created on azure
// for more information of creating ProfileResource, please refer to the document of ProfileResource
string subscriptionId = "subid";
string resourceGroupName = "myResourceGroup";
string profileName = "profile1";
ResourceIdentifier profileResourceId = ProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
ProfileResource profile = client.GetProfileResource(profileResourceId);

// invoke the operation
EndpointNameAvailabilityContent content = new EndpointNameAvailabilityContent("sampleName", CdnResourceType.FrontDoorEndpoints)
{
    AutoGeneratedDomainNameLabelScope = DomainNameLabelScope.TenantReuse,
};
EndpointNameAvailabilityResult result = await profile.CheckEndpointNameAvailabilityFrontDoorProfileAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

応答のサンプル

状態コード:

200

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

定義

名前	説明
AutoGeneratedDomainNameLabelScope	エンドポイント名の再利用スコープを示します。 既定値は TenantReuse です。
CheckEndpointNameAvailabilityInput	CheckNameAvailability API の入力。
CheckEndpointNameAvailabilityOutput	チェック名可用性 API の出力。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ResourceType	CheckNameAvailability で使用される CDN リソースの種類。

AutoGeneratedDomainNameLabelScope

列挙

エンドポイント名の再利用スコープを示します。 既定値は TenantReuse です。

値	説明
NoReuse
ResourceGroupReuse
SubscriptionReuse
TenantReuse

CheckEndpointNameAvailabilityInput

Object

CheckNameAvailability API の入力。

名前	型	説明
autoGeneratedDomainNameLabelScope	AutoGeneratedDomainNameLabelScope	エンドポイント名の再利用スコープを示します。 既定値は TenantReuse です。
name	string	検証するリソース名。
type	ResourceType	名前が検証されるリソースの種類。

CheckEndpointNameAvailabilityOutput

Object

チェック名可用性 API の出力。

名前	型	説明
availableHostname	string	名前が使用可能な場合は AutoGeneratedDomainNameLabelScope に基づいて生成された使用可能なホスト名を返します。それ以外の場合は空の文字列を返します。
message	string	名前が使用できない理由を説明する詳細なエラー メッセージ。
nameAvailable	boolean	名前を使用できるかどうかを示します。
reason	string	名前が使用できない理由。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

ResourceType

列挙

CheckNameAvailability で使用される CDN リソースの種類。

値	説明
Microsoft.Cdn/Profiles/AfdEndpoints
Microsoft.Cdn/Profiles/Endpoints